criteo/criteo-api-retailmedia-sdk

PHP SDK for Criteo API 0.0.230601 version

Maintainers

Details

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

Homepage

Source

Issues

Installs: 67

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 9

Forks: 2

Open Issues: 0

2023.04.0.230601 2023-06-01 15:59 UTC

Requires

Requires (Dev)

Apache-2.0 ff1cd052ed8e16b580e1dfbb5c414aefff367195

phprestapisdkcriteoopenapi generator

This package is auto-updated.

Last update: 2023-06-01 16:00:13 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.230601
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

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

Installation & Usage

Composer

To install the bindings via Composer:

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

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
AnalyticsApi getCampaignReports POST /preview/retail-media/reports/sync/campaigns
AnalyticsApi getLineItemsReports POST /preview/retail-media/reports/sync/line-items
AnalyticsApi getReportOutput GET /preview/retail-media/reports/{reportId}/output
AnalyticsApi getReportStatus GET /preview/retail-media/reports/{reportId}/status
AnalyticsApi requestCampaignReport POST /preview/retail-media/reports/campaigns
AnalyticsApi requestLineItemReport POST /preview/retail-media/reports/line-items
AudienceApi createAudience POST /preview/retail-media/accounts/{accountId}/audiences
AudienceApi createRetailMediaAudienceV2 POST /preview/retail-media/v2/accounts/{accountId}/audiences
AudienceApi getAudiencesByAccountId GET /preview/retail-media/accounts/{accountId}/audiences
AudienceApi getRetailMediaAudienceV2ListByAccountId 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 getApi202207ExternalRetailerByRetailerIdTemplatestemplateId GET /preview/retail-media/retailers/{retailer-id}/templates/{template-id}
CampaignApi getApi202207ExternalRetailerTemplatesByRetailerId GET /preview/retail-media/retailers/{retailer-id}/templates
CampaignApi getApi202210ExternalAccountByAccountIdCreativescreativeId GET /preview/retail-media/accounts/{account-id}/creatives/{creative-id}
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 getApiV0ExternalCatalogOutputByCatalogId GET /preview/retail-media/catalogs/{catalogId}/output
CampaignApi getApiV0ExternalCatalogStatusByCatalogId GET /preview/retail-media/catalogs/{catalogId}/status
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 postApi202210ExternalAccountCreativesByAccountId POST /preview/retail-media/accounts/{account-id}/creatives
CampaignApi postApi202210ExternalAccountCreativesSearchByAccountId POST /preview/retail-media/accounts/{account-id}/creatives/search
CampaignApi postApi202210ExternalLineItemProductButtonsCreateByLineItemId POST /preview/retail-media/line-items/{line-item-id}/product-buttons/create
CampaignApi postApiV0ExternalAccountCatalogsByAccountId POST /preview/retail-media/accounts/{accountId}/catalogs
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 putApi202210ExternalAccountByAccountIdCreativescreativeId PUT /preview/retail-media/accounts/{account-id}/creatives/{creative-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
GatewayApi getCurrentApplication GET /preview/retail-media/me

Documentation For Models

Documentation For Authorization

In order to ease usage of this client library, you might want to use the TokenAutoRefreshClient as explained in the example.

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.