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: https://developers.criteo.com/
This PHP package is automatically generated by the OpenAPI Generator project:
- Package version: 0.0.240808
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
This project is tested with PHP 8.0. However it should work fine with PHP 7.4 too.
To install the bindings via Composer:
either run the following command: composer require criteo/criteo-api-retailmedia-sdk:0.0.240808
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
Download the files and include autoload.php
:
require_once('/path/to/criteo-api-retailmedia-sdk/vendor/autoload.php');
To run the unit tests:
composer run-script test
Please see test/ExampleApplication.php for an example on how to perform a simple call.
All URIs are relative to https://api.criteo.com
Class | Method | HTTP request | Description |
---|---|---|---|
AccountsApi | createPrivateMarketDemandSellerAccount | POST /preview/retail-media/account-management/accounts/{accountId}/create-seller-account | |
AccountsApi | getApiV1ExternalAccounts | GET /preview/retail-media/accounts | |
AccountsApi | grantConsent | POST /preview/retail-media/accounts/{accountId}/grant-consent | |
AccountsApi | updateSellers | PUT /preview/retail-media/account-management/accounts/{accountId}/sellers | |
AnalyticsApi | generateAsyncAccountsReport | POST /preview/retail-media/reports/accounts | |
AnalyticsApi | generateAsyncCampaignsReport | POST /preview/retail-media/reports/campaigns | |
AnalyticsApi | generateAsyncLineItemsReport | POST /preview/retail-media/reports/line-items | |
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 | bulkCreateV1 | POST /preview/retail-media/accounts/{account-id}/audience-segments/create | |
AudienceApi | bulkDeleteV1 | POST /preview/retail-media/accounts/{account-id}/audience-segments/delete | |
AudienceApi | bulkUpdateV1 | PATCH /preview/retail-media/accounts/{account-id}/audience-segments | |
AudienceApi | deleteContactListIdentifiers | POST /preview/retail-media/audience-segments/{audience-segment-id}/contact-list/clear | |
AudienceApi | getContactListStatisticsV1 | GET /preview/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list | |
AudienceApi | legacyGetAudienceV1 | GET /preview/retail-media/accounts/{accountId}/audiences | |
AudienceApi | legacyGetAudienceV2 | GET /preview/retail-media/v2/accounts/{accountId}/audiences | |
AudienceApi | searchV1 | POST /preview/retail-media/accounts/{account-id}/audience-segments/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 | postApiV2ExternalAccountAddFundsByAccountIdBalancesbalanceId | POST /preview/retail-media/accounts/{account-id}/balances/{balance-id}/add-funds | |
BalanceApi | postApiV2ExternalAccountBalancesByAccountId | POST /preview/retail-media/accounts/{account-id}/balances | |
BalanceApi | postApiV2ExternalAccountChangeDatesByAccountIdBalancesbalanceId | POST /preview/retail-media/accounts/{account-id}/balances/{balance-id}/change-dates | |
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 | fetchProposal | GET /preview/retail-media/preferred-deal-line-items/{id}/proposal | |
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 | getApiV1ExternalAccountBrandsByAccountId | GET /preview/retail-media/accounts/{accountId}/brands | |
CampaignApi | getApiV1ExternalAccountRetailersByAccountId | GET /preview/retail-media/accounts/{accountId}/retailers | |
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 | getApiV2ExternalLineItemBidMultipliersByLineItemId | GET /preview/retail-media/line-items/{line-item-id}/bid-multipliers | |
CampaignApi | getApiV2ExternalPreferredLineItemByLineItemId | GET /preview/retail-media/preferred-line-items/{line-item-id} | |
CampaignApi | getCampaignBudgetOverrides | GET /preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides | |
CampaignApi | getInsertionOrderHistoryChangeDataCaptureV2 | GET /preview/retail-media/insertion-order-history/{insertionOrderId}/change-data-capture | |
CampaignApi | getLineItemBudgetOverrides | GET /preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides | |
CampaignApi | getRecommendedKeywords | GET /preview/retail-media/line-items/{externalLineItemId}/keywords/recommended | |
CampaignApi | getSkuByProductId | POST /preview/retail-media/catalogs/sku/search/accounts/{accountId}/retailers/{retailerId}/by-id | |
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 | postApiV1ExternalAccountCatalogsSellersByAccountId | POST /preview/retail-media/accounts/{accountId}/catalogs/sellers | |
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 | putApiV2ExternalLineItemBidMultipliersByLineItemId | PUT /preview/retail-media/line-items/{line-item-id}/bid-multipliers | |
CampaignApi | setKeywordBids | POST /preview/retail-media/line-items/{id}/keywords/set-bid | |
CampaignApi | submitProposal | POST /preview/retail-media/preferred-deal-line-items/{id}/proposal/submit | |
CampaignApi | unpausePromotedProducts | POST /preview/retail-media/line-items/{line-item-id}/products/unpause | |
CampaignApi | updateCampaignBudgetOverrides | PUT /preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides | |
CampaignApi | updateLineItemBudgetOverrides | PUT /preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides | |
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 |
- AddFundsToBalanceV2
- AddFundsToBalanceV2Request
- AddRemoveKeywordModel
- AddRemoveKeywordsModel
- AddRemoveKeywordsModelRequest
- AddRemoveKeywordsModelResource
- ApplicationSummaryModel
- ApplicationSummaryModelResource
- ApplicationSummaryModelResponse
- ApprovalStatusModel
- AsyncAccountsReport
- AsyncAccountsReportRequest
- AsyncAccountsReportResource
- AsyncCampaignsReport
- AsyncCampaignsReportRequest
- AsyncCampaignsReportResource
- AsyncLineItemsReport
- AsyncLineItemsReportRequest
- AsyncLineItemsReportResource
- AsyncReportResponse
- AudienceError
- AudienceWarning
- BalanceHistoryChangeDataCaptureV1
- BalanceResponseV2
- BalanceResponseV2Response
- BatchAcceptedResponse
- Brand
- BrandPreview
- BrandPreviewListResponse
- CampaignBudgetOverrides
- CampaignDailyBudgetOverride
- CampaignMonthlyBudgetOverride
- Category
- Category202204
- ChangeDatesOfBalanceV2
- ChangeDatesOfBalanceV2Request
- ChangeDetailsV1
- ChangeDetailsV2
- CommonError
- CommonProblem
- CommonWarning
- CpcRateCardPreview
- CpcRateCardPreviewResponse
- CreateBalanceV2
- CreateBalanceV2Request
- CreativeV2ListResponse
- CreativeV2Response
- CustomAttribute
- DailyLineItemBudgetOverride
- ErrorCodeResponse
- ExportReportColumn
- ExportReportMetaData
- ExternalAccount
- ExternalBrand
- ExternalCatalogStatus
- ExternalChoiceVariableValue
- ExternalColorVariableValue
- ExternalCreativeCreateModelV2
- ExternalCreativeUpdateModelV2
- ExternalCreativeV2
- ExternalFilesVariableValue
- ExternalHyperlinkVariableValue
- ExternalLineItemBidMultipliersV2
- ExternalLineItemCappingV2
- ExternalLineItemPageCategoryV2
- ExternalLineItemPageV2
- ExternalPageTypeEnvironment
- ExternalPreferredLineItemCreateModelV2
- ExternalPreferredLineItemUpdateModelV2
- ExternalPreferredLineItemV2
- ExternalProductButtonRequest
- ExternalProductButtonResponse
- ExternalRetailer
- ExternalTemplateVariableValue
- ExternalTextVariableValue
- ExternalVideoVariableValue
- FailResponse
- GrantConsentInput
- GrantConsentModel
- GrantConsentModelValueResource
- InputKeywords
- InputKeywordsModel
- InputResourceOfPreferredLineItemCreateModelV2
- InsertionOrderHistoryChangeDataCaptureV2
- Installment
- JsonApiBodyWithIdOfInt64AndAccountAndAccount
- JsonApiBodyWithIdOfInt64AndBrandAndBrand
- JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus
- JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2
- JsonApiBodyWithIdOfInt64AndRetailerAndRetailer
- JsonApiBodyWithoutIdOfSellerCatalogRequestAndSellerCatalogRequest
- JsonApiPageResponseOfAccount
- JsonApiPageResponseOfBrand
- JsonApiPageResponseOfRetailer
- JsonApiRequestOfSellerCatalogRequest
- JsonApiSingleResponseOfCatalogStatus
- JsonApiSingleResponseOfLineItemBidMultipliersV2
- KeywordDataModel
- Keywords
- KeywordsModel
- KeywordsModelResource
- KeywordsModelResponse
- LineItemBidMultipliersV2Request
- LineItemBidMultipliersV2Response
- LineItemBudgetOverrides
- LineItemProductStatus
- LoyaltyPoints
- MatchTypeModel
- Metadata
- MonthlyLineItemBudegetOverride
- NegotiationStateModel
- NillableString
- PageMetadata
- PageOfBalanceHistoryChangeDataCaptureV1
- PageOfInsertionOrderHistoryChangeDataCaptureV2
- PagedResourceCollectionOutcomeOfBalanceResponseV2
- PlacementPreview
- PlacementPreviewListResponse
- PreferredLineItemCreateModelV2Request
- PreferredLineItemUpdateModelV2Request
- PreferredLineItemV2PagedListResponse
- PreferredLineItemV2Response
- Price
- ProblemDetails
- Product
- ProductButtonListRequest
- ProductButtonListResponse
- ProductButtonRequest
- ProductImporterError
- ProductImporterWarning
- ProductMetadata
- ProductResourceOutcome
- ProductShipping
- ProductShippingDimension
- ProductShippingWeight
- ProductTax
- ProductUnitPricingBaseMeasure
- ProductUnitPricingMeasure
- ProductsCustomBatchRequest
- ProductsCustomBatchRequestEntry
- PromotedProduct
- PromotedProductResource
- PromotedProductResourceCollectionInput
- PromotedProductResourceCollectionOutcome
- ProposalStatusModel
- ProposalStatusModelResource
- ProposalStatusModelResponse
- RecommendedKeywordsResult
- ReportDataResponseResource
- ReportDetailError
- ReportDetailErrors
- ReportOkResponse
- ReportOutcome
- ReportResponse
- ResourceCollectionOutcomeOfSkuSearchResult
- ResourceOfAddFundsToBalanceV2
- ResourceOfBalanceResponseV2
- ResourceOfBrandPreview
- ResourceOfChangeDatesOfBalanceV2
- ResourceOfCpcRateCardPreview
- ResourceOfCreateBalanceV2
- ResourceOfCreativeV2
- ResourceOfLineItemBidMultipliersV2
- ResourceOfPlacementPreview
- ResourceOfPreferredLineItemUpdateModelV2
- ResourceOfPreferredLineItemV2
- ResourceOfProductButtonRequest
- ResourceOfProductButtonResponse
- ResourceOfRetailMediaAccount
- ResourceOfSellerPreview
- ResourceOfSkuDataPreview
- ResourceOfSkuSearchRequestPreview
- ResourceOfSkuSearchRequestSlimPreview
- ResourceOfSkuSearchRequestSlimV2Preview
- ResourceOfSkuSearchResult
- ResourceOfSkuSlimDataPreview
- ResourceOfSkuSlimDataV2
- ResourceOfUpdateBalanceModelV2
- ResourceOutcome
- ResourceOutcomeOfRetailMediaAccount
- RetailMediaAccount
- RetailMediaContactlistAmendment
- RetailMediaContactlistAmendmentAttributes
- RetailMediaContactlistAmendmentRequest
- RetailMediaContactlistOperation
- RetailMediaContactlistOperationResponseAttributes
- RetailMediaContactlistOperationResponseAttributesAttributes
- RetailMediaSeller
- RetailMediaSellerAccountCreation
- ReviewStateModel
- RmAudienceSegmentBulkCreateInputV1
- RmAudienceSegmentBulkDeleteInputV1
- RmAudienceSegmentBulkUpdateInputV1
- RmAudienceSegmentCreateEntityV1
- RmAudienceSegmentCreateEntityV1Resource
- RmAudienceSegmentDeleteEntityV1Resource
- RmAudienceSegmentEntityV1
- RmAudienceSegmentEntityV1ListResponse
- RmAudienceSegmentEntityV1Resource
- RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse
- RmAudienceSegmentIdEntityV1ListResponse
- RmAudienceSegmentIdEntityV1Resource
- RmAudienceSegmentSearchEntityV1
- RmAudienceSegmentSearchEntityV1Resource
- RmAudienceSegmentSearchInputV1
- RmAudienceSegmentSearchMetadataV1
- RmAudienceSegmentUpdateEntityV1
- RmAudienceSegmentUpdateEntityV1Resource
- RmContactListCreateV1
- RmContactListStatisticsEntityV1
- RmContactListStatisticsEntityV1Resource
- RmContactListStatisticsEntityV1Response
- RmContactListV1
- RmLegacyAudienceGetEntityV1
- RmLegacyAudienceGetEntityV1ListResponse
- RmLegacyAudienceGetEntityV1Resource
- RmLegacyAudienceGetEntityV2
- RmLegacyAudienceGetEntityV2ListResponse
- RmLegacyAudienceGetEntityV2Resource
- RmLegacyAudienceUserBehaviorDetailsV2
- RmLegacySegmentCustomerList
- RmLegacySegmentUserBehaviorV1
- RmLegacySegmentUserBehaviorV2
- RmUserBehaviorV1
- RmcaCommonProblem
- SellerCatalogRequest
- SellerIdentifier
- SellerPreview
- SellerPreviewResponse
- SetBidModel
- SetBidsModel
- SetBidsModelRequest
- SetBidsModelResource
- SkuDataPreview
- SkuDataPreviewListResponse
- SkuSearchRequest
- SkuSearchRequestBody
- SkuSearchRequestPreview
- SkuSearchRequestPreviewRequest
- SkuSearchRequestSlimPreview
- SkuSearchRequestSlimPreviewRequest
- SkuSearchRequestSlimV2Preview
- SkuSearchRequestSlimV2PreviewRequest
- SkuSearchResult
- SkuSlimDataPreview
- SkuSlimDataPreviewListResponse
- SkuSlimDataV2
- SkuSlimDataV2ListResponse
- StatusResponse
- StatusResponseResource
- SyncAttributedTransactionsReport
- SyncAttributedTransactionsReportRequest
- SyncAttributedTransactionsReportResource
- SyncCampaignsReport
- SyncCampaignsReportRequest
- SyncCampaignsReportResource
- SyncLineItemsReport
- SyncLineItemsReportRequest
- SyncLineItemsReportResource
- UpdateBalanceModelV2
- UpdateBalanceModelV2Request
- ValueResourceCollectionInputOfRetailMediaSeller
- ValueResourceCollectionOutcomeOfRetailMediaSeller
- ValueResourceInputOfCampaignBudgetOverrides
- ValueResourceInputOfLineItemBudgetOverrides
- ValueResourceInputOfRetailMediaSellerAccountCreation
- ValueResourceOfCampaignBudgetOverrides
- ValueResourceOfLineItemBudgetOverrides
- ValueResourceOfRecommendedKeywordsResult
- ValueResourceOfRetailMediaSeller
- ValueResourceOfRetailMediaSellerAccountCreation
- ValueResourceOutcomeOfCampaignBudgetOverrides
- ValueResourceOutcomeOfLineItemBudgetOverrides
- ValueResourceOutcomeOfRecommendedKeywordsResult
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://api.criteo.com/oauth2
- Scopes: N/A
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.