criteo/criteo-api-retailmedia-sdk

PHP SDK for Criteo API 0.0.240404 version

Maintainers

Details

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

Homepage

Source

Issues

Installs: 75

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 9

Forks: 2

Open Issues: 0

2024.01.0.240404 2024-04-04 10:03 UTC

Requires

Requires (Dev)

Apache-2.0 7dc9d3f4aff28508dea2f9512d63434a6ab7d3a5

phprestapisdkcriteoopenapi generator

This package is auto-updated.

Last update: 2024-04-04 10:06:40 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: https://developers.criteo.com/

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

  • Package version: 0.0.240404
  • 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.240404

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 addBrands POST /preview/retail-media/account-management/accounts/{accountId}/brands/add
AccountsApi createPrivateMarketDemandBrandAccount POST /preview/retail-media/account-management/accounts/{accountId}/create-brand-account
AccountsApi createPrivateMarketDemandSellerAccount POST /preview/retail-media/account-management/accounts/{accountId}/create-seller-account
AccountsApi grantConsent POST /preview/retail-media/accounts/{accountId}/grant-consent
AccountsApi removeBrands POST /preview/retail-media/account-management/accounts/{accountId}/brands/remove
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 legacyGetAudienceV1 GET /preview/retail-media/accounts/{accountId}/audiences
AudienceApi legacyGetAudienceV2 GET /preview/retail-media/v2/accounts/{accountId}/audiences
CampaignApi addRemoveKeywords POST /preview/retail-media/line-items/{id}/keywords/add-remove
CampaignApi deleteApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId DELETE /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
CampaignApi fetchKeywords GET /preview/retail-media/line-items/{id}/keywords
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 getApi202301ExternalLineItemBidMultipliersByLineItemId GET /preview/retail-media/line-items/{line-item-id}/bid-multipliers
CampaignApi getApiV1ExternalAccountBrandsByAccountId GET /preview/retail-media/accounts/{accountId}/brands
CampaignApi getApiV1ExternalAccountRetailersByAccountId GET /preview/retail-media/accounts/{accountId}/retailers
CampaignApi getApiV1ExternalAccounts GET /preview/retail-media/accounts
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 getApiV2ExternalCampaignPreferredLineItemsByCampaignId GET /preview/retail-media/campaigns/{campaign-id}/preferred-line-items
CampaignApi getApiV2ExternalPreferredLineItemByLineItemId GET /preview/retail-media/preferred-line-items/{line-item-id}
CampaignApi getCampaignBudgetOverrides GET /preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides
CampaignApi getInsertionOrderHistoryChangeDataCapture 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 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 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 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 putApi202301ExternalLineItemBidMultipliersByLineItemId 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 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

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.