criteo/criteo-api-retailmedia-sdk

PHP SDK for Criteo API 0.0.250425 version

Maintainers

Details

github.com/criteo/criteo-api-retailmedia-php-sdk

Homepage

Source

Issues

Installs: 79

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 9

Forks: 2

Open Issues: 0

2025.04.0.250425 2025-04-25 09:29 UTC

Requires

Requires (Dev)

Apache-2.0 41f2d0a7545ef7a305cb704a2a2baf9523257878

phprestapisdkcriteoopenapi generator

This package is auto-updated.

Last update: 2025-04-25 09:30:31 UTC

README

Introduction

API Client Libraries can facilitate your use of the Criteo API allowing you to build unique and customized solutions to serve your businesses and clients. These libraries can reduce the amount of code you need to write in order to start accessing Criteo programmatically. They also can help expedite troubleshooting, should you encounter any issues.

More information on how to use Criteo API and these SDKs can be found at: https://developers.criteo.com/.

This PHP package is automatically generated by the OpenAPI Generator project:

  • Package version: 0.0.250425
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

This project is tested with PHP 8.0. However it should work fine with PHP 7.4 too.

Installation & Usage

Composer

To install the bindings via Composer:

either run the following command: composer require criteo/criteo-api-retailmedia-sdk:0.0.250425

or add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/criteo/criteo-api-retailmedia-php-sdk.git"
    }
  ],
  "require": {
    "criteo/criteo-api-retailmedia-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/criteo-api-retailmedia-sdk/vendor/autoload.php');

Tests

To run the unit tests:

composer run-script test

Example

Please see test/ExampleApplication.php for an example on how to perform a simple call.

Documentation for API Endpoints

All URIs are relative to https://api.criteo.com

Class Method HTTP request Description
AccountsApi getApiExternalV1AccountPrivateMarketChildAccountsByAccountId GET /preview/retail-media/account-management/accounts/{accountId}/private-market-child-accounts
AccountsApi previewRetailMediaAccountsFeesSearchPost POST /preview/retail-media/accounts/fees/search
AccountsApi previewRetailMediaAccountsFeesUpdatePost POST /preview/retail-media/accounts/fees/update
AccountsApi searchSellers POST /preview/retail-media/accounts/sellers/search
AnalyticsApi generateAsyncAccountsReport POST /preview/retail-media/reports/accounts
AnalyticsApi generateAsyncCampaignsReport POST /preview/retail-media/reports/campaigns
AnalyticsApi generateAsyncFillRateReport POST /preview/retail-media/reports/fillrate
AnalyticsApi generateAsyncLineItemsReport POST /preview/retail-media/reports/line-items
AnalyticsApi generateAsyncOffsiteReport POST /preview/retail-media/reports/offsite
AnalyticsApi generateSyncAttributedTransactionsReport POST /preview/retail-media/reports/sync/attributed-transactions
AnalyticsApi generateSyncCampaignsReport POST /preview/retail-media/reports/sync/campaigns
AnalyticsApi generateSyncLineItemsReport POST /preview/retail-media/reports/sync/line-items
AnalyticsApi getAsyncExportOutput GET /preview/retail-media/reports/{reportId}/output
AnalyticsApi getAsyncExportStatus GET /preview/retail-media/reports/{reportId}/status
AudienceApi bulkCreateAudienceSegments POST /preview/retail-media/accounts/{account-id}/audience-segments/create
AudienceApi bulkDeleteAudienceSegments POST /preview/retail-media/accounts/{account-id}/audience-segments/delete
AudienceApi bulkUpdateAudienceSegments PATCH /preview/retail-media/accounts/{account-id}/audience-segments
AudienceApi deleteContactListIdentifiers POST /preview/retail-media/audience-segments/{audience-segment-id}/contact-list/clear
AudienceApi getAudienceSegmentContactListStatistics GET /preview/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list
AudienceApi searchAudienceSegments POST /preview/retail-media/accounts/{account-id}/audience-segments/search
AudienceApi searchAudiences POST /preview/retail-media/accounts/{account-id}/audiences/search
AudienceApi updateContactListIdentifiers POST /preview/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove
BalanceApi getApiV2ExternalAccountBalancesByAccountId GET /preview/retail-media/accounts/{account-id}/balances
BalanceApi getApiV2ExternalAccountByAccountIdBalancesbalanceId GET /preview/retail-media/accounts/{account-id}/balances/{balance-id}
BalanceApi getBalanceHistory GET /preview/retail-media/balances/{balanceId}/history
BalanceApi patchApiV2ExternalAccountByAccountIdBalancesbalanceId PATCH /preview/retail-media/accounts/{account-id}/balances/{balance-id}
BalanceApi postApiV2ExternalAccountBalancesByAccountId POST /preview/retail-media/accounts/{account-id}/balances
BalanceApi postApiV2ExternalAccountChangeDatesByAccountIdBalancesbalanceId POST /preview/retail-media/accounts/{account-id}/balances/{balance-id}/change-dates
BillingApi previewRetailMediaBillingPartnerReportPost POST /preview/retail-media/billing/partner-report
BillingApi previewRetailMediaBillingPartnerReportRequestIdOutputGet GET /preview/retail-media/billing/partner-report/{requestId}/output
BillingApi previewRetailMediaBillingPartnerReportRequestIdStatusGet GET /preview/retail-media/billing/partner-report/{requestId}/status
CampaignApi addRemoveKeywords POST /preview/retail-media/line-items/{id}/keywords/add-remove
CampaignApi appendPromotedProducts POST /preview/retail-media/line-items/{line-item-id}/products/append
CampaignApi deleteApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId DELETE /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
CampaignApi deletePromotedProducts POST /preview/retail-media/line-items/{line-item-id}/products/delete
CampaignApi fetchKeywords GET /preview/retail-media/line-items/{id}/keywords
CampaignApi fetchPromotedProducts GET /preview/retail-media/line-items/{line-item-id}/products
CampaignApi getApi202210ExternalLineItemProductButtonsByLineItemId GET /preview/retail-media/line-items/{line-item-id}/product-buttons
CampaignApi getApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId GET /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
CampaignApi getApiExternalV2CatalogStatusByCatalogId GET /preview/retail-media/catalogs/{catalogId}/status
CampaignApi getApiV1ExternalRetailerBrandsByRetailerId GET /preview/retail-media/retailers/{retailerId}/brands
CampaignApi getApiV1ExternalRetailerByRetailerIdSellerBySeller GET /preview/retail-media/retailers/{retailerId}/sellers/{seller}
CampaignApi getApiV1ExternalRetailerCategoryCpcRatesByRetailerId GET /preview/retail-media/retailers/{retailer-id}/cpc-rates
CampaignApi getApiV1ExternalRetailerPlacementsByRetailerId GET /preview/retail-media/retailers/{retailer-id}/placements
CampaignApi getApiV2ExternalAccountByAccountIdCreativescreativeId GET /preview/retail-media/accounts/{account-id}/creatives/{creative-id}
CampaignApi getApiV2ExternalCampaignPreferredLineItemsByCampaignId GET /preview/retail-media/campaigns/{campaign-id}/preferred-line-items
CampaignApi getApiV2ExternalPreferredLineItemByLineItemId GET /preview/retail-media/preferred-line-items/{line-item-id}
CampaignApi getCpcMinBidsBySkuIdsV1 POST /preview/retail-media/retailers/{retailerId}/cpc-min-bids
CampaignApi inReviewReportV1 GET /preview/retail-media/accounts/{account-id}/keywords/in-review-report
CampaignApi pausePromotedProducts POST /preview/retail-media/line-items/{line-item-id}/products/pause
CampaignApi postApi202110ExternalCampaignPreferredLineItemsByCampaignId POST /preview/retail-media/campaigns/{campaign-id}/preferred-line-items
CampaignApi postApi202210ExternalLineItemProductButtonsCreateByLineItemId POST /preview/retail-media/line-items/{line-item-id}/product-buttons/create
CampaignApi postApiExternalV2AccountBrandCatalogExportByAccountId POST /preview/retail-media/accounts/{accountId}/brand-catalog-export
CampaignApi postApiExternalV2AccountSellerCatalogExportByAccountId POST /preview/retail-media/accounts/{accountId}/seller-catalog-export
CampaignApi postApiV1ExternalCatalogsSkuRetrieval POST /preview/retail-media/catalogs/sku-retrieval
CampaignApi postApiV1ExternalCatalogsSkuSearch POST /preview/retail-media/catalogs/sku-search
CampaignApi postApiV1ExternalCatalogsSkuSearchAccountIdAndRetailerId POST /preview/retail-media/catalogs/sku-search/accounts/{account-id}/retailers/{retailer-id}
CampaignApi postApiV1ExternalCatalogsSkuSearchRetailerByRetailerId POST /preview/retail-media/catalogs/sku/search/retailers/{retailer-id}
CampaignApi postApiV2ExternalAccountCreativesByAccountId POST /preview/retail-media/accounts/{account-id}/creatives
CampaignApi postApiV2ExternalAccountCreativesSearchByAccountId POST /preview/retail-media/accounts/{account-id}/creatives/search
CampaignApi putApi202110ExternalPreferredLineItemByLineItemId PUT /preview/retail-media/preferred-line-items/{line-item-id}
CampaignApi putApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId PUT /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
CampaignApi putApiV2ExternalAccountByAccountIdCreativescreativeId PUT /preview/retail-media/accounts/{account-id}/creatives/{creative-id}
CampaignApi searchBrandsByNameAsyncV1 POST /preview/retail-media/brands/search
CampaignApi setKeywordBids POST /preview/retail-media/line-items/{id}/keywords/set-bid
CampaignApi unpausePromotedProducts POST /preview/retail-media/line-items/{line-item-id}/products/unpause
CampaignApi updateKeywordReviewsV1 POST /preview/retail-media/line-items/{line-item-id}/keywords/review
CatalogApi previewRetailMediaCatalogProductsBatchPost POST /preview/retail-media/catalog/products/batch
CatalogApi previewRetailMediaCatalogProductsBatchReportOperationTokenGet GET /preview/retail-media/catalog/products/batch/report/{operation-token}
GatewayApi getCurrentApplication GET /preview/retail-media/me
OnSiteRecommendationApi chatbotProductRecommendations POST /preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations

Documentation For Models

Documentation For Authorization

oauth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

oauth

Author

Criteo

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.