Search by

criteo / criteo-api-retailmedia-sdk

Criteo

PHP SDK for Criteo API 0.0.260921 version

Package info

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

Homepage

pkg:composer/criteo/criteo-api-retailmedia-sdk

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 182

Dependents: 0

Suggesters: 0

Stars: 2

Open Issues: 0

2027.01.0.260921 2026-09-21 20:19 UTC

Requires

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

Apache-2.0 52d7a7dc242beec5613b275f1e62e9f3a1bbb9e3

phprestapisdkcriteoopenapi generator

Published on Packagist.org on 2026-09-21 20:20 UTC

This package is auto-updated.

Last update: 2026-09-21 20:24:58 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.260921
  • 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.260921

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 searchBrands POST /experimental/retail-media/brands/search /experimental/retail-media/brands/search
AnalyticsApi generateAsyncAccountsReportV2 POST /experimental/retail-media/reports/accounts /experimental/retail-media/reports/accounts
AnalyticsApi generateAsyncCampaignsReportV2 POST /experimental/retail-media/reports/campaigns /experimental/retail-media/reports/campaigns
AnalyticsApi generateAsyncLineItemsReportV2 POST /experimental/retail-media/reports/line-items /experimental/retail-media/reports/line-items
AnalyticsApi generateAsyncOffsiteReport POST /experimental/retail-media/reports/offsite /experimental/retail-media/reports/offsite
AnalyticsApi generateDigitalShelfIntelligenceInsight POST /experimental/retail-media/insights/digital-shelf-intelligence /experimental/retail-media/insights/digital-shelf-intelligence
AnalyticsApi generateShareOfVoiceInsight POST /experimental/retail-media/insights/share-of-voice /experimental/retail-media/insights/share-of-voice
AnalyticsApi generateSyncRealTimePerformanceReport POST /experimental/retail-media/reports/sync/real-time-performance /experimental/retail-media/reports/sync/real-time-performance
AnalyticsApi getInsightReportOutput GET /experimental/retail-media/insights/{insight-id}/output /experimental/retail-media/insights/{insight-id}/output
AnalyticsApi getInsightReportStatus GET /experimental/retail-media/insights/{insight-id}/status /experimental/retail-media/insights/{insight-id}/status
AudienceApi bulkCreateAudience POST /experimental/retail-media/accounts/{account-id}/audiences/create /experimental/retail-media/accounts/{account-id}/audiences/create
AudienceApi bulkDeleteAudiences POST /experimental/retail-media/accounts/{account-id}/audiences/delete /experimental/retail-media/accounts/{account-id}/audiences/delete
AudienceApi bulkUpdateAudience PATCH /experimental/retail-media/accounts/{account-id}/audiences /experimental/retail-media/accounts/{account-id}/audiences
AudienceApi computeAudienceSegmentsSizes POST /experimental/retail-media/accounts/{account-id}/audience-segments/compute-sizes /experimental/retail-media/accounts/{account-id}/audience-segments/compute-sizes
AudienceApi computeAudiencesSizes POST /experimental/retail-media/accounts/{account-id}/audiences/compute-sizes /experimental/retail-media/accounts/{account-id}/audiences/compute-sizes
AudienceApi estimateAudienceSegmentSize POST /experimental/retail-media/accounts/{account-id}/audience-segments/estimate-size /experimental/retail-media/accounts/{account-id}/audience-segments/estimate-size
AudienceApi estimateAudienceSize POST /experimental/retail-media/accounts/{account-id}/audiences/estimate-size /experimental/retail-media/accounts/{account-id}/audiences/estimate-size
BalanceApi getPageOfBalancesV1 GET /experimental/retail-media/accounts/{accountId}/balances /experimental/retail-media/accounts/{accountId}/balances
CampaignApi addProducts POST /experimental/retail-media/line-items/{line-item-id}/products/add /experimental/retail-media/line-items/{line-item-id}/products/add
CampaignApi appendProductButtonByLineItemId POST /experimental/retail-media/line-items/{line-item-id}/product-buttons/create /experimental/retail-media/line-items/{line-item-id}/product-buttons/create
CampaignApi createAuctionLineItem POST /experimental/retail-media/campaigns/{campaignId}/auction-line-items /experimental/retail-media/campaigns/{campaignId}/auction-line-items
CampaignApi createCampaign POST /experimental/retail-media/accounts/{account-id}/campaigns /experimental/retail-media/accounts/{account-id}/campaigns
CampaignApi createCreative POST /experimental/retail-media/accounts/{account-id}/creatives /experimental/retail-media/accounts/{account-id}/creatives
CampaignApi createLineItem POST /experimental/retail-media/line-items /experimental/retail-media/line-items
CampaignApi createPreferredLineItemByCampaignId POST /experimental/retail-media/campaigns/{campaign-id}/preferred-line-items /experimental/retail-media/campaigns/{campaign-id}/preferred-line-items
CampaignApi createTargetsByLineItemId POST /experimental/retail-media/line-items/{line-item-id}/targets/create /experimental/retail-media/line-items/{line-item-id}/targets/create
CampaignApi deleteCreatives POST /experimental/retail-media/line-items/{line-item-id}/creatives/delete /experimental/retail-media/line-items/{line-item-id}/creatives/delete
CampaignApi deleteProductButtonByLineItemAndProductButtonId DELETE /experimental/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id} /experimental/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
CampaignApi deleteProducts POST /experimental/retail-media/line-items/{line-item-id}/products/delete /experimental/retail-media/line-items/{line-item-id}/products/delete
CampaignApi fetchCreatives GET /experimental/retail-media/line-items/{line-item-id}/creatives /experimental/retail-media/line-items/{line-item-id}/creatives
CampaignApi getBiddingStrategyByLineItemId GET /experimental/retail-media/line-items/{line-item-id}/bidding-strategy /experimental/retail-media/line-items/{line-item-id}/bidding-strategy
CampaignApi getCampaign GET /experimental/retail-media/accounts/{account-id}/campaigns/{campaign-id} /experimental/retail-media/accounts/{account-id}/campaigns/{campaign-id}
CampaignApi getCapoutHistory POST /experimental/retail-media/accounts/{account-id}/line-items/cap-out-history /experimental/retail-media/accounts/{account-id}/line-items/cap-out-history
CampaignApi getCatalogStatus GET /experimental/retail-media/catalogs/{catalogId}/status /experimental/retail-media/catalogs/{catalogId}/status
CampaignApi getCreative GET /experimental/retail-media/accounts/{account-id}/creatives/{creative-id} /experimental/retail-media/accounts/{account-id}/creatives/{creative-id}
CampaignApi getProductButtonByLineItemAndProductButtonId GET /experimental/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id} /experimental/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
CampaignApi getProductButtonsByLineItemId GET /experimental/retail-media/line-items/{line-item-id}/product-buttons /experimental/retail-media/line-items/{line-item-id}/product-buttons
CampaignApi getTargetsByLineItemId GET /experimental/retail-media/line-items/{line-item-id}/targets /experimental/retail-media/line-items/{line-item-id}/targets
CampaignApi lineItemsDemandSearch POST /experimental/retail-media/line-items/demand-search /experimental/retail-media/line-items/demand-search
CampaignApi lineItemsSupplySearch POST /experimental/retail-media/line-items/supply-search /experimental/retail-media/line-items/supply-search
CampaignApi searchAccountCreatives POST /experimental/retail-media/accounts/{account-id}/creatives/search /experimental/retail-media/accounts/{account-id}/creatives/search
CampaignApi searchCampaigns POST /experimental/retail-media/accounts/{account-id}/campaigns/search /experimental/retail-media/accounts/{account-id}/campaigns/search
CampaignApi setBiddingStrategyByLineItemId POST /experimental/retail-media/line-items/{line-item-id}/set-bidding-strategy /experimental/retail-media/line-items/{line-item-id}/set-bidding-strategy
CampaignApi submitLineItem POST /experimental/retail-media/line-items/{line-item-id}/submit /experimental/retail-media/line-items/{line-item-id}/submit
CampaignApi updateAuctionLineItem PUT /experimental/retail-media/auction-line-items/{lineItemId} /experimental/retail-media/auction-line-items/{lineItemId}
CampaignApi updateCampaign PATCH /experimental/retail-media/accounts/{account-id}/campaigns/{campaign-id} /experimental/retail-media/accounts/{account-id}/campaigns/{campaign-id}
CampaignApi updateCreative PUT /experimental/retail-media/accounts/{account-id}/creatives/{creative-id} /experimental/retail-media/accounts/{account-id}/creatives/{creative-id}
CampaignApi updateLineItem PATCH /experimental/retail-media/line-items/{line-item-id} /experimental/retail-media/line-items/{line-item-id}
CampaignApi updatePreferredLineItemByLineItemId PUT /experimental/retail-media/preferred-line-items/{line-item-id} /experimental/retail-media/preferred-line-items/{line-item-id}
CampaignApi updateProductButtonByLineItemAndProductButtonId PUT /experimental/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id} /experimental/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
CampaignApi updateTargetsByLineItemId POST /experimental/retail-media/line-items/{line-item-id}/targets/update /experimental/retail-media/line-items/{line-item-id}/targets/update
CampaignApi upsertCreatives POST /experimental/retail-media/line-items/{line-item-id}/creatives/upsert /experimental/retail-media/line-items/{line-item-id}/creatives/upsert
CatalogApi getCatalogIngestionReportSummary GET /experimental/retail-media/catalog/ingestion/{ingestion-id}/reports/summary /experimental/retail-media/catalog/ingestion/{ingestion-id}/reports/summary
CatalogApi getCatalogIngestionReports GET /experimental/retail-media/catalog/merchants/{merchant-id}/ingestion/reports /experimental/retail-media/catalog/merchants/{merchant-id}/ingestion/reports
CatalogApi getCatalogProductsBatchReport GET /experimental/retail-media/catalog/products/batch/report/{operation-token} /experimental/retail-media/catalog/products/batch/report/{operation-token}
CatalogApi offerSetBbwV1 POST /experimental/retail-media/retailers/{retailer-id}/products/set-buy-box-winners /experimental/retail-media/retailers/{retailer-id}/products/set-buy-box-winners
CatalogApi offerUpdateV1 POST /experimental/retail-media/retailers/{retailer-id}/offers/update /experimental/retail-media/retailers/{retailer-id}/offers/update
CatalogApi submitCatalogProductsBatch POST /experimental/retail-media/catalog/products/batch /experimental/retail-media/catalog/products/batch
GatewayApi getCurrentApplication GET /experimental/retail-media/me /experimental/retail-media/me
OnSiteRecommendationApi chatbotProductRecommendations POST /experimental/retail-media/chatbot-catalogs/{catalogid}/product-recommendations /experimental/retail-media/chatbot-catalogs/{catalogid}/product-recommendations
ThirdPartyAccountsApi addThirdPartyAccountBrands POST /experimental/retail-media/third-party-accounts/{accountId}/brands/add /experimental/retail-media/third-party-accounts/{accountId}/brands/add
ThirdPartyAccountsApi createThirdPartyBrandAccount POST /experimental/retail-media/third-party-accounts/{accountId}/create-brand-account /experimental/retail-media/third-party-accounts/{accountId}/create-brand-account
ThirdPartyAccountsApi createThirdPartySellerAccount POST /experimental/retail-media/third-party-accounts/{accountId}/create-seller-account /experimental/retail-media/third-party-accounts/{accountId}/create-seller-account
ThirdPartyAccountsApi grantThirdPartyConsent POST /experimental/retail-media/accounts/{accountId}/grant-third-party-consent /experimental/retail-media/accounts/{accountId}/grant-third-party-consent
ThirdPartyAccountsApi removeThirdPartyAccountBrand POST /experimental/retail-media/third-party-accounts/{accountId}/brands/{brandId}/remove /experimental/retail-media/third-party-accounts/{accountId}/brands/{brandId}/remove
ThirdPartyAccountsApi updateThirdPartyAccountSellers PUT /experimental/retail-media/third-party-accounts/{accountId}/sellers /experimental/retail-media/third-party-accounts/{accountId}/sellers

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.