Skip to content

Latest commit

 

History

History
2608 lines (1747 loc) · 99.6 KB

CampaignApi.md

File metadata and controls

2608 lines (1747 loc) · 99.6 KB
Raw

criteo\api\retailmedia\preview\CampaignApi

All URIs are relative to https://api.criteo.com, except if the operation defines another base path.

Method HTTP request Description
addRemoveKeywords() POST /preview/retail-media/line-items/{id}/keywords/add-remove
appendPromotedProducts() POST /preview/retail-media/line-items/{line-item-id}/products/append
deleteApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId() DELETE /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
deletePromotedProducts() POST /preview/retail-media/line-items/{line-item-id}/products/delete
fetchKeywords() GET /preview/retail-media/line-items/{id}/keywords
fetchPromotedProducts() GET /preview/retail-media/line-items/{line-item-id}/products
fetchProposal() GET /preview/retail-media/preferred-deal-line-items/{id}/proposal
getApi202210ExternalLineItemProductButtonsByLineItemId() GET /preview/retail-media/line-items/{line-item-id}/product-buttons
getApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId() GET /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
getApiV1ExternalAccountBrandsByAccountId() GET /preview/retail-media/accounts/{accountId}/brands
getApiV1ExternalAccountRetailersByAccountId() GET /preview/retail-media/accounts/{accountId}/retailers
getApiV1ExternalRetailerBrandsByRetailerId() GET /preview/retail-media/retailers/{retailerId}/brands
getApiV1ExternalRetailerByRetailerIdSellerBySeller() GET /preview/retail-media/retailers/{retailerId}/sellers/{seller}
getApiV1ExternalRetailerCategoryCpcRatesByRetailerId() GET /preview/retail-media/retailers/{retailer-id}/cpc-rates
getApiV1ExternalRetailerPlacementsByRetailerId() GET /preview/retail-media/retailers/{retailer-id}/placements
getApiV2ExternalAccountByAccountIdCreativescreativeId() GET /preview/retail-media/accounts/{account-id}/creatives/{creative-id}
getApiV2ExternalCampaignPreferredLineItemsByCampaignId() GET /preview/retail-media/campaigns/{campaign-id}/preferred-line-items
getApiV2ExternalLineItemBidMultipliersByLineItemId() GET /preview/retail-media/line-items/{line-item-id}/bid-multipliers
getApiV2ExternalPreferredLineItemByLineItemId() GET /preview/retail-media/preferred-line-items/{line-item-id}
getInsertionOrderHistoryChangeDataCaptureV2() GET /preview/retail-media/insertion-order-history/{insertionOrderId}/change-data-capture
getRecommendedKeywords() GET /preview/retail-media/line-items/{externalLineItemId}/keywords/recommended
getSkuByProductId() POST /preview/retail-media/catalogs/sku/search/accounts/{accountId}/retailers/{retailerId}/by-id
pausePromotedProducts() POST /preview/retail-media/line-items/{line-item-id}/products/pause
postApi202110ExternalCampaignPreferredLineItemsByCampaignId() POST /preview/retail-media/campaigns/{campaign-id}/preferred-line-items
postApi202210ExternalLineItemProductButtonsCreateByLineItemId() POST /preview/retail-media/line-items/{line-item-id}/product-buttons/create
postApiV1ExternalAccountCatalogsSellersByAccountId() POST /preview/retail-media/accounts/{accountId}/catalogs/sellers
postApiV1ExternalCatalogsSkuRetrieval() POST /preview/retail-media/catalogs/sku-retrieval
postApiV1ExternalCatalogsSkuSearch() POST /preview/retail-media/catalogs/sku-search
postApiV1ExternalCatalogsSkuSearchAccountIdAndRetailerId() POST /preview/retail-media/catalogs/sku-search/accounts/{account-id}/retailers/{retailer-id}
postApiV1ExternalCatalogsSkuSearchRetailerByRetailerId() POST /preview/retail-media/catalogs/sku/search/retailers/{retailer-id}
postApiV2ExternalAccountCreativesByAccountId() POST /preview/retail-media/accounts/{account-id}/creatives
postApiV2ExternalAccountCreativesSearchByAccountId() POST /preview/retail-media/accounts/{account-id}/creatives/search
putApi202110ExternalPreferredLineItemByLineItemId() PUT /preview/retail-media/preferred-line-items/{line-item-id}
putApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId() PUT /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}
putApiV2ExternalAccountByAccountIdCreativescreativeId() PUT /preview/retail-media/accounts/{account-id}/creatives/{creative-id}
putApiV2ExternalLineItemBidMultipliersByLineItemId() PUT /preview/retail-media/line-items/{line-item-id}/bid-multipliers
setKeywordBids() POST /preview/retail-media/line-items/{id}/keywords/set-bid
submitProposal() POST /preview/retail-media/preferred-deal-line-items/{id}/proposal/submit
unpausePromotedProducts() POST /preview/retail-media/line-items/{line-item-id}/products/unpause

addRemoveKeywords()

addRemoveKeywords($id, $add_remove_keywords_model_request): \criteo\api\retailmedia\preview\Model\ResourceOutcome

Add or Remove keywords from the line item in bulk

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | ID of the line item
$add_remove_keywords_model_request = new \criteo\api\retailmedia\preview\Model\AddRemoveKeywordsModelRequest(); // \criteo\api\retailmedia\preview\Model\AddRemoveKeywordsModelRequest

try {
    $result = $apiInstance->addRemoveKeywords($id, $add_remove_keywords_model_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->addRemoveKeywords: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string ID of the line item
add_remove_keywords_model_request \criteo\api\retailmedia\preview\Model\AddRemoveKeywordsModelRequest [optional]

Return type

\criteo\api\retailmedia\preview\Model\ResourceOutcome

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

appendPromotedProducts()

appendPromotedProducts($line_item_id, $promoted_product_resource_collection_input)

Append a collection of promoted products to a line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | ID of the line item
$promoted_product_resource_collection_input = new \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput(); // \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput | Request body whose {data} contains an array of promoted products.

try {
    $apiInstance->appendPromotedProducts($line_item_id, $promoted_product_resource_collection_input);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->appendPromotedProducts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string ID of the line item
promoted_product_resource_collection_input \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput Request body whose {data} contains an array of promoted products. [optional]

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId()

deleteApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId($line_item_id, $product_button_id)

Delete a product button

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | Long external id of the associated line item
$product_button_id = 'product_button_id_example'; // string | Sequential id of the product button

try {
    $apiInstance->deleteApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId($line_item_id, $product_button_id);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->deleteApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string Long external id of the associated line item
product_button_id string Sequential id of the product button

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePromotedProducts()

deletePromotedProducts($line_item_id, $promoted_product_resource_collection_input)

Remove a collection of promoted products from a line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | ID of the line item
$promoted_product_resource_collection_input = new \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput(); // \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput | Request body whose {data} contains an array of promoted products.

try {
    $apiInstance->deletePromotedProducts($line_item_id, $promoted_product_resource_collection_input);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->deletePromotedProducts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string ID of the line item
promoted_product_resource_collection_input \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput Request body whose {data} contains an array of promoted products. [optional]

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchKeywords()

fetchKeywords($id): \criteo\api\retailmedia\preview\Model\KeywordsModelResponse

Fetch keywords associated with the specified line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | ID of the line item

try {
    $result = $apiInstance->fetchKeywords($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->fetchKeywords: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string ID of the line item

Return type

\criteo\api\retailmedia\preview\Model\KeywordsModelResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchPromotedProducts()

fetchPromotedProducts($line_item_id, $offset, $limit, $fields): \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionOutcome

Retrieve a page of promoted products for a line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | ID of the line item.
$offset = 56; // int | Offset of the first item to fetch. Defaults to zero.
$limit = 56; // int | Maximum page size to fetch. Defaults to 500.
$fields = 'fields_example'; // string | A comma separated list of attribute names from the response model to compute and return.              Valid values are `status` and `bidOverride` in any order. Defaults to `status`.

try {
    $result = $apiInstance->fetchPromotedProducts($line_item_id, $offset, $limit, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->fetchPromotedProducts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string ID of the line item.
offset int Offset of the first item to fetch. Defaults to zero. [optional]
limit int Maximum page size to fetch. Defaults to 500. [optional]
fields string A comma separated list of attribute names from the response model to compute and return. Valid values are `status` and `bidOverride` in any order. Defaults to `status`. [optional]

Return type

\criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionOutcome

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchProposal()

fetchProposal($id): \criteo\api\retailmedia\preview\Model\ProposalStatusModelResponse

Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | ID of the line item

try {
    $result = $apiInstance->fetchProposal($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->fetchProposal: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string ID of the line item

Return type

\criteo\api\retailmedia\preview\Model\ProposalStatusModelResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApi202210ExternalLineItemProductButtonsByLineItemId()

getApi202210ExternalLineItemProductButtonsByLineItemId($line_item_id): \criteo\api\retailmedia\preview\Model\ProductButtonListResponse

Get all the product buttons associated with a line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | Long external id of the associated line item

try {
    $result = $apiInstance->getApi202210ExternalLineItemProductButtonsByLineItemId($line_item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApi202210ExternalLineItemProductButtonsByLineItemId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string Long external id of the associated line item

Return type

\criteo\api\retailmedia\preview\Model\ProductButtonListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId()

getApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId($line_item_id, $product_button_id): \criteo\api\retailmedia\preview\Model\ProductButtonListResponse

Get a single product button

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | Long external id of the associated line item
$product_button_id = 'product_button_id_example'; // string | Sequential id of the product button

try {
    $result = $apiInstance->getApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId($line_item_id, $product_button_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string Long external id of the associated line item
product_button_id string Sequential id of the product button

Return type

\criteo\api\retailmedia\preview\Model\ProductButtonListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV1ExternalAccountBrandsByAccountId()

getApiV1ExternalAccountBrandsByAccountId($account_id, $limit_to_id, $page_index, $page_size): \criteo\api\retailmedia\preview\Model\JsonApiPageResponseOfBrand

Gets page of retailer objects that are associated with the given account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | The given account id
$limit_to_id = array('limit_to_id_example'); // string[] | The ids that you would like to limit your result set to
$page_index = 0; // int | The 0 indexed page index you would like to receive given the page size
$page_size = 25; // int | The maximum number of items you would like to receive in this request

try {
    $result = $apiInstance->getApiV1ExternalAccountBrandsByAccountId($account_id, $limit_to_id, $page_index, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV1ExternalAccountBrandsByAccountId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string The given account id
limit_to_id string[] The ids that you would like to limit your result set to [optional]
page_index int The 0 indexed page index you would like to receive given the page size [optional] [default to 0]
page_size int The maximum number of items you would like to receive in this request [optional] [default to 25]

Return type

\criteo\api\retailmedia\preview\Model\JsonApiPageResponseOfBrand

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV1ExternalAccountRetailersByAccountId()

getApiV1ExternalAccountRetailersByAccountId($account_id, $limit_to_id, $page_index, $page_size): \criteo\api\retailmedia\preview\Model\JsonApiPageResponseOfRetailer

Gets page of retailer objects that are associated with the given account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | The given account id
$limit_to_id = array('limit_to_id_example'); // string[] | The ids that you would like to limit your result set to
$page_index = 0; // int | The 0 indexed page index you would like to receive given the page size
$page_size = 25; // int | The maximum number of items you would like to receive in this request

try {
    $result = $apiInstance->getApiV1ExternalAccountRetailersByAccountId($account_id, $limit_to_id, $page_index, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV1ExternalAccountRetailersByAccountId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string The given account id
limit_to_id string[] The ids that you would like to limit your result set to [optional]
page_index int The 0 indexed page index you would like to receive given the page size [optional] [default to 0]
page_size int The maximum number of items you would like to receive in this request [optional] [default to 25]

Return type

\criteo\api\retailmedia\preview\Model\JsonApiPageResponseOfRetailer

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV1ExternalRetailerBrandsByRetailerId()

getApiV1ExternalRetailerBrandsByRetailerId($retailer_id, $sku_stock_type_filter, $brand_type): \criteo\api\retailmedia\preview\Model\BrandPreviewListResponse

Gets the brands for the given retailer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$retailer_id = 56; // int | The retailer id for which brands should be fetched.
$sku_stock_type_filter = 'sku_stock_type_filter_example'; // string | Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party
$brand_type = 'brand_type_example'; // string | Filter to narrow down brands [all|uc|retailer]. Defaults to uc

try {
    $result = $apiInstance->getApiV1ExternalRetailerBrandsByRetailerId($retailer_id, $sku_stock_type_filter, $brand_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV1ExternalRetailerBrandsByRetailerId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
retailer_id int The retailer id for which brands should be fetched.
sku_stock_type_filter string Filter to narrow down brands [first-party third-party
brand_type string Filter to narrow down brands [all uc

Return type

\criteo\api\retailmedia\preview\Model\BrandPreviewListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV1ExternalRetailerByRetailerIdSellerBySeller()

getApiV1ExternalRetailerByRetailerIdSellerBySeller($retailer_id, $seller): \criteo\api\retailmedia\preview\Model\SellerPreviewResponse

Endpoint to get market place seller id and name

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$retailer_id = 56; // int | The retailer id for which seller should be fetched.
$seller = 'seller_example'; // string | The seller id or seller name which should be validated.

try {
    $result = $apiInstance->getApiV1ExternalRetailerByRetailerIdSellerBySeller($retailer_id, $seller);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV1ExternalRetailerByRetailerIdSellerBySeller: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
retailer_id int The retailer id for which seller should be fetched.
seller string The seller id or seller name which should be validated.

Return type

\criteo\api\retailmedia\preview\Model\SellerPreviewResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV1ExternalRetailerCategoryCpcRatesByRetailerId()

getApiV1ExternalRetailerCategoryCpcRatesByRetailerId($retailer_id, $fields): \criteo\api\retailmedia\preview\Model\CpcRateCardPreviewResponse

Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$retailer_id = 'retailer_id_example'; // string | The retailer id
$fields = array('fields_example'); // string[] | The fields in the response that is to be included

try {
    $result = $apiInstance->getApiV1ExternalRetailerCategoryCpcRatesByRetailerId($retailer_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV1ExternalRetailerCategoryCpcRatesByRetailerId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
retailer_id string The retailer id
fields string[] The fields in the response that is to be included [optional]

Return type

\criteo\api\retailmedia\preview\Model\CpcRateCardPreviewResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV1ExternalRetailerPlacementsByRetailerId()

getApiV1ExternalRetailerPlacementsByRetailerId($retailer_id): \criteo\api\retailmedia\preview\Model\PlacementPreviewListResponse

Gets all placement information for the given retailer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$retailer_id = 'retailer_id_example'; // string | The retailer id for which placements should be fetched.

try {
    $result = $apiInstance->getApiV1ExternalRetailerPlacementsByRetailerId($retailer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV1ExternalRetailerPlacementsByRetailerId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
retailer_id string The retailer id for which placements should be fetched.

Return type

\criteo\api\retailmedia\preview\Model\PlacementPreviewListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV2ExternalAccountByAccountIdCreativescreativeId()

getApiV2ExternalAccountByAccountIdCreativescreativeId($account_id, $creative_id): \criteo\api\retailmedia\preview\Model\CreativeV2Response

Get the specified creative

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | External account id to retrieve creatives for
$creative_id = 'creative_id_example'; // string | Creative to get

try {
    $result = $apiInstance->getApiV2ExternalAccountByAccountIdCreativescreativeId($account_id, $creative_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV2ExternalAccountByAccountIdCreativescreativeId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string External account id to retrieve creatives for
creative_id string Creative to get

Return type

\criteo\api\retailmedia\preview\Model\CreativeV2Response

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV2ExternalCampaignPreferredLineItemsByCampaignId()

getApiV2ExternalCampaignPreferredLineItemsByCampaignId($campaign_id, $limit_to_id, $page_index, $page_size): \criteo\api\retailmedia\preview\Model\PreferredLineItemV2PagedListResponse

Gets page of preferred line item objects for the given campaign id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 'campaign_id_example'; // string | The given campaign id
$limit_to_id = array('limit_to_id_example'); // string[] | The ids that you would like to limit your result set to
$page_index = 56; // int | The 0 indexed page index you would like to receive given the page size
$page_size = 56; // int | The maximum number of items you would like to receive in this request

try {
    $result = $apiInstance->getApiV2ExternalCampaignPreferredLineItemsByCampaignId($campaign_id, $limit_to_id, $page_index, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV2ExternalCampaignPreferredLineItemsByCampaignId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
campaign_id string The given campaign id
limit_to_id string[] The ids that you would like to limit your result set to [optional]
page_index int The 0 indexed page index you would like to receive given the page size [optional]
page_size int The maximum number of items you would like to receive in this request [optional]

Return type

\criteo\api\retailmedia\preview\Model\PreferredLineItemV2PagedListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV2ExternalLineItemBidMultipliersByLineItemId()

getApiV2ExternalLineItemBidMultipliersByLineItemId($line_item_id): \criteo\api\retailmedia\preview\Model\JsonApiSingleResponseOfLineItemBidMultipliersV2

Fetch all bid multipliers for a given line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | External LineItemId for bid multiplier retrieval

try {
    $result = $apiInstance->getApiV2ExternalLineItemBidMultipliersByLineItemId($line_item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV2ExternalLineItemBidMultipliersByLineItemId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string External LineItemId for bid multiplier retrieval

Return type

\criteo\api\retailmedia\preview\Model\JsonApiSingleResponseOfLineItemBidMultipliersV2

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiV2ExternalPreferredLineItemByLineItemId()

getApiV2ExternalPreferredLineItemByLineItemId($line_item_id): \criteo\api\retailmedia\preview\Model\PreferredLineItemV2Response

Gets the preferred line item for the given line item id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | The given line item id

try {
    $result = $apiInstance->getApiV2ExternalPreferredLineItemByLineItemId($line_item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getApiV2ExternalPreferredLineItemByLineItemId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string The given line item id

Return type

\criteo\api\retailmedia\preview\Model\PreferredLineItemV2Response

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInsertionOrderHistoryChangeDataCaptureV2()

getInsertionOrderHistoryChangeDataCaptureV2($insertion_order_id, $offset, $limit, $limit_to_change_types): \criteo\api\retailmedia\preview\Model\PageOfInsertionOrderHistoryChangeDataCaptureV2

Gets the balance's historical data change capture.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$insertion_order_id = 'insertion_order_id_example'; // string | External insertion order id.
$offset = 0; // int | The (zero-based) starting offset in the collection.
$limit = 25; // int | The number of elements to be returned.
$limit_to_change_types = 'limit_to_change_types_example'; // string | Comma separated change types string that will be queried.

try {
    $result = $apiInstance->getInsertionOrderHistoryChangeDataCaptureV2($insertion_order_id, $offset, $limit, $limit_to_change_types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getInsertionOrderHistoryChangeDataCaptureV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
insertion_order_id string External insertion order id.
offset int The (zero-based) starting offset in the collection. [optional] [default to 0]
limit int The number of elements to be returned. [optional] [default to 25]
limit_to_change_types string Comma separated change types string that will be queried. [optional]

Return type

\criteo\api\retailmedia\preview\Model\PageOfInsertionOrderHistoryChangeDataCaptureV2

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRecommendedKeywords()

getRecommendedKeywords($external_line_item_id): \criteo\api\retailmedia\preview\Model\ValueResourceOutcomeOfRecommendedKeywordsResult

Retrieves a collection of recommended keywords for a line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$external_line_item_id = 'external_line_item_id_example'; // string | The external line item identifier

try {
    $result = $apiInstance->getRecommendedKeywords($external_line_item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getRecommendedKeywords: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
external_line_item_id string The external line item identifier

Return type

\criteo\api\retailmedia\preview\Model\ValueResourceOutcomeOfRecommendedKeywordsResult

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSkuByProductId()

getSkuByProductId($account_id, $retailer_id, $offset, $limit, $sku_search_request): \criteo\api\retailmedia\preview\Model\ResourceCollectionOutcomeOfSkuSearchResult

Gets a list of SKUs based on a privided list of Product Ids

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | account id
$retailer_id = 56; // int | retailer id
$offset = 0; // int | skip a number of matches before retrning results, used with limit
$limit = 100; // int | max number of results to return
$sku_search_request = new \criteo\api\retailmedia\preview\Model\SkuSearchRequest(); // \criteo\api\retailmedia\preview\Model\SkuSearchRequest | 

try {
    $result = $apiInstance->getSkuByProductId($account_id, $retailer_id, $offset, $limit, $sku_search_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->getSkuByProductId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string account id
retailer_id int retailer id
offset int skip a number of matches before retrning results, used with limit [optional] [default to 0]
limit int max number of results to return [optional] [default to 100]
sku_search_request \criteo\api\retailmedia\preview\Model\SkuSearchRequest [optional]

Return type

\criteo\api\retailmedia\preview\Model\ResourceCollectionOutcomeOfSkuSearchResult

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pausePromotedProducts()

pausePromotedProducts($line_item_id, $promoted_product_resource_collection_input)

Pause a collection of promoted products associated with a line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | ID of the line item
$promoted_product_resource_collection_input = new \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput(); // \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput | Request body whose {data} contains an array of promoted products.

try {
    $apiInstance->pausePromotedProducts($line_item_id, $promoted_product_resource_collection_input);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->pausePromotedProducts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string ID of the line item
promoted_product_resource_collection_input \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput Request body whose {data} contains an array of promoted products. [optional]

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApi202110ExternalCampaignPreferredLineItemsByCampaignId()

postApi202110ExternalCampaignPreferredLineItemsByCampaignId($campaign_id, $preferred_line_item_create_model_v2_request): \criteo\api\retailmedia\preview\Model\PreferredLineItemV2Response

Creates a new preferred line item with the specified settings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 'campaign_id_example'; // string | The given campaign id
$preferred_line_item_create_model_v2_request = new \criteo\api\retailmedia\preview\Model\PreferredLineItemCreateModelV2Request(); // \criteo\api\retailmedia\preview\Model\PreferredLineItemCreateModelV2Request | The line item settings to create a line item with

try {
    $result = $apiInstance->postApi202110ExternalCampaignPreferredLineItemsByCampaignId($campaign_id, $preferred_line_item_create_model_v2_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApi202110ExternalCampaignPreferredLineItemsByCampaignId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
campaign_id string The given campaign id
preferred_line_item_create_model_v2_request \criteo\api\retailmedia\preview\Model\PreferredLineItemCreateModelV2Request The line item settings to create a line item with

Return type

\criteo\api\retailmedia\preview\Model\PreferredLineItemV2Response

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApi202210ExternalLineItemProductButtonsCreateByLineItemId()

postApi202210ExternalLineItemProductButtonsCreateByLineItemId($line_item_id, $product_button_list_request): \criteo\api\retailmedia\preview\Model\ProductButtonListResponse

Append new product buttons to a line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | Long external id of the associated line item
$product_button_list_request = new \criteo\api\retailmedia\preview\Model\ProductButtonListRequest(); // \criteo\api\retailmedia\preview\Model\ProductButtonListRequest | List of product buttons to append to the specified line item

try {
    $result = $apiInstance->postApi202210ExternalLineItemProductButtonsCreateByLineItemId($line_item_id, $product_button_list_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApi202210ExternalLineItemProductButtonsCreateByLineItemId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string Long external id of the associated line item
product_button_list_request \criteo\api\retailmedia\preview\Model\ProductButtonListRequest List of product buttons to append to the specified line item [optional]

Return type

\criteo\api\retailmedia\preview\Model\ProductButtonListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApiV1ExternalAccountCatalogsSellersByAccountId()

postApiV1ExternalAccountCatalogsSellersByAccountId($account_id, $json_api_request_of_seller_catalog_request): \criteo\api\retailmedia\preview\Model\JsonApiSingleResponseOfCatalogStatus

Create a request for a Catalog available to the indicated account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | The account to request the catalog for.
$json_api_request_of_seller_catalog_request = new \criteo\api\retailmedia\preview\Model\JsonApiRequestOfSellerCatalogRequest(); // \criteo\api\retailmedia\preview\Model\JsonApiRequestOfSellerCatalogRequest

try {
    $result = $apiInstance->postApiV1ExternalAccountCatalogsSellersByAccountId($account_id, $json_api_request_of_seller_catalog_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApiV1ExternalAccountCatalogsSellersByAccountId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string The account to request the catalog for.
json_api_request_of_seller_catalog_request \criteo\api\retailmedia\preview\Model\JsonApiRequestOfSellerCatalogRequest [optional]

Return type

\criteo\api\retailmedia\preview\Model\JsonApiSingleResponseOfCatalogStatus

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApiV1ExternalCatalogsSkuRetrieval()

postApiV1ExternalCatalogsSkuRetrieval($page_index, $page_size, $request_body): \criteo\api\retailmedia\preview\Model\SkuDataPreviewListResponse

Endpoint to search skus by text, retailer and sellers/brands.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page_index = 0; // int | The start position in the overall list of matches. Must be zero or greater.
$page_size = 100; // int | The maximum number of results to return with each call. Must be greater than zero.
$request_body = array('request_body_example'); // string[] | The list of SKU keys to retrieve sku information

try {
    $result = $apiInstance->postApiV1ExternalCatalogsSkuRetrieval($page_index, $page_size, $request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApiV1ExternalCatalogsSkuRetrieval: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
page_index int The start position in the overall list of matches. Must be zero or greater. [optional] [default to 0]
page_size int The maximum number of results to return with each call. Must be greater than zero. [optional] [default to 100]
request_body string[] The list of SKU keys to retrieve sku information [optional]

Return type

\criteo\api\retailmedia\preview\Model\SkuDataPreviewListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApiV1ExternalCatalogsSkuSearch()

postApiV1ExternalCatalogsSkuSearch($page_index, $page_size, $sku_search_request_preview_request): \criteo\api\retailmedia\preview\Model\SkuDataPreviewListResponse

Endpoint to search skus by text, retailer and sellers/brands.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page_index = 0; // int | The start position in the overall list of matches. Must be zero or greater.
$page_size = 100; // int | The maximum number of results to return with each call. Must be greater than zero.
$sku_search_request_preview_request = new \criteo\api\retailmedia\preview\Model\SkuSearchRequestPreviewRequest(); // \criteo\api\retailmedia\preview\Model\SkuSearchRequestPreviewRequest | 

try {
    $result = $apiInstance->postApiV1ExternalCatalogsSkuSearch($page_index, $page_size, $sku_search_request_preview_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApiV1ExternalCatalogsSkuSearch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
page_index int The start position in the overall list of matches. Must be zero or greater. [optional] [default to 0]
page_size int The maximum number of results to return with each call. Must be greater than zero. [optional] [default to 100]
sku_search_request_preview_request \criteo\api\retailmedia\preview\Model\SkuSearchRequestPreviewRequest [optional]

Return type

\criteo\api\retailmedia\preview\Model\SkuDataPreviewListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApiV1ExternalCatalogsSkuSearchAccountIdAndRetailerId()

postApiV1ExternalCatalogsSkuSearchAccountIdAndRetailerId($account_id, $retailer_id, $offset, $limit, $sku_search_request_slim_preview_request): \criteo\api\retailmedia\preview\Model\SkuSlimDataPreviewListResponse

Endpoint to search skus by text, account and retailer with an option to filter by brands id's.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | The account for which skus should be searched for.
$retailer_id = 'retailer_id_example'; // string | The client id/retailer id for which skus should be searched for.
$offset = 0; // int | The start position in the overall list of matches. Must be zero or greater.
$limit = 100; // int | The maximum number of results to return with each call. Must be greater than zero.
$sku_search_request_slim_preview_request = new \criteo\api\retailmedia\preview\Model\SkuSearchRequestSlimPreviewRequest(); // \criteo\api\retailmedia\preview\Model\SkuSearchRequestSlimPreviewRequest | 

try {
    $result = $apiInstance->postApiV1ExternalCatalogsSkuSearchAccountIdAndRetailerId($account_id, $retailer_id, $offset, $limit, $sku_search_request_slim_preview_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApiV1ExternalCatalogsSkuSearchAccountIdAndRetailerId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string The account for which skus should be searched for.
retailer_id string The client id/retailer id for which skus should be searched for.
offset int The start position in the overall list of matches. Must be zero or greater. [optional] [default to 0]
limit int The maximum number of results to return with each call. Must be greater than zero. [optional] [default to 100]
sku_search_request_slim_preview_request \criteo\api\retailmedia\preview\Model\SkuSearchRequestSlimPreviewRequest [optional]

Return type

\criteo\api\retailmedia\preview\Model\SkuSlimDataPreviewListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApiV1ExternalCatalogsSkuSearchRetailerByRetailerId()

postApiV1ExternalCatalogsSkuSearchRetailerByRetailerId($retailer_id, $x_origin_account, $offset, $limit, $sku_search_request_slim_v2_preview_request): \criteo\api\retailmedia\preview\Model\SkuSlimDataV2ListResponse

Endpoint to search skus by text for a retailer with an option to filter by brands id's.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$retailer_id = 'retailer_id_example'; // string | The client id/retailer id for which skus should be searched for.
$x_origin_account = 'x_origin_account_example'; // string | The account id of the initiator of the call.
$offset = 0; // int | The start position in the overall list of matches. Must be zero or greater.
$limit = 100; // int | The maximum number of results to return with each call. Must be greater than zero and less than 1500. 10,000 records deep is the max limit.
$sku_search_request_slim_v2_preview_request = new \criteo\api\retailmedia\preview\Model\SkuSearchRequestSlimV2PreviewRequest(); // \criteo\api\retailmedia\preview\Model\SkuSearchRequestSlimV2PreviewRequest | 

try {
    $result = $apiInstance->postApiV1ExternalCatalogsSkuSearchRetailerByRetailerId($retailer_id, $x_origin_account, $offset, $limit, $sku_search_request_slim_v2_preview_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApiV1ExternalCatalogsSkuSearchRetailerByRetailerId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
retailer_id string The client id/retailer id for which skus should be searched for.
x_origin_account string The account id of the initiator of the call. [optional]
offset int The start position in the overall list of matches. Must be zero or greater. [optional] [default to 0]
limit int The maximum number of results to return with each call. Must be greater than zero and less than 1500. 10,000 records deep is the max limit. [optional] [default to 100]
sku_search_request_slim_v2_preview_request \criteo\api\retailmedia\preview\Model\SkuSearchRequestSlimV2PreviewRequest [optional]

Return type

\criteo\api\retailmedia\preview\Model\SkuSlimDataV2ListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApiV2ExternalAccountCreativesByAccountId()

postApiV2ExternalAccountCreativesByAccountId($account_id, $external_creative_create_model_v2): \criteo\api\retailmedia\preview\Model\CreativeV2Response

Create a creative for an account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | External account id to create a creative for
$external_creative_create_model_v2 = new \criteo\api\retailmedia\preview\Model\ExternalCreativeCreateModelV2(); // \criteo\api\retailmedia\preview\Model\ExternalCreativeCreateModelV2 | The creative to create

try {
    $result = $apiInstance->postApiV2ExternalAccountCreativesByAccountId($account_id, $external_creative_create_model_v2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApiV2ExternalAccountCreativesByAccountId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string External account id to create a creative for
external_creative_create_model_v2 \criteo\api\retailmedia\preview\Model\ExternalCreativeCreateModelV2 The creative to create [optional]

Return type

\criteo\api\retailmedia\preview\Model\CreativeV2Response

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postApiV2ExternalAccountCreativesSearchByAccountId()

postApiV2ExternalAccountCreativesSearchByAccountId($account_id, $creative_ids): \criteo\api\retailmedia\preview\Model\CreativeV2ListResponse

Get account creatives

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | External account id to retrieve creatives for
$creative_ids = array('creative_ids_example'); // string[] | Creatives to filter by

try {
    $result = $apiInstance->postApiV2ExternalAccountCreativesSearchByAccountId($account_id, $creative_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->postApiV2ExternalAccountCreativesSearchByAccountId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string External account id to retrieve creatives for
creative_ids string[] Creatives to filter by [optional]

Return type

\criteo\api\retailmedia\preview\Model\CreativeV2ListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putApi202110ExternalPreferredLineItemByLineItemId()

putApi202110ExternalPreferredLineItemByLineItemId($line_item_id, $preferred_line_item_update_model_v2_request): \criteo\api\retailmedia\preview\Model\PreferredLineItemV2Response

Updates the preferred line item for the given line item id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | The given line item id
$preferred_line_item_update_model_v2_request = new \criteo\api\retailmedia\preview\Model\PreferredLineItemUpdateModelV2Request(); // \criteo\api\retailmedia\preview\Model\PreferredLineItemUpdateModelV2Request | The line item settings to create a line item with

try {
    $result = $apiInstance->putApi202110ExternalPreferredLineItemByLineItemId($line_item_id, $preferred_line_item_update_model_v2_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->putApi202110ExternalPreferredLineItemByLineItemId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string The given line item id
preferred_line_item_update_model_v2_request \criteo\api\retailmedia\preview\Model\PreferredLineItemUpdateModelV2Request The line item settings to create a line item with

Return type

\criteo\api\retailmedia\preview\Model\PreferredLineItemV2Response

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId()

putApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId($line_item_id, $product_button_id, $product_button_request): \criteo\api\retailmedia\preview\Model\ProductButtonListResponse

Update a product button

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | Long external id of the associated line item
$product_button_id = 'product_button_id_example'; // string | Sequential id of the product button
$product_button_request = new \criteo\api\retailmedia\preview\Model\ProductButtonRequest(); // \criteo\api\retailmedia\preview\Model\ProductButtonRequest | Details of the updated product button

try {
    $result = $apiInstance->putApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId($line_item_id, $product_button_id, $product_button_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->putApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string Long external id of the associated line item
product_button_id string Sequential id of the product button
product_button_request \criteo\api\retailmedia\preview\Model\ProductButtonRequest Details of the updated product button [optional]

Return type

\criteo\api\retailmedia\preview\Model\ProductButtonListResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putApiV2ExternalAccountByAccountIdCreativescreativeId()

putApiV2ExternalAccountByAccountIdCreativescreativeId($account_id, $creative_id, $external_creative_update_model_v2): \criteo\api\retailmedia\preview\Model\CreativeV2Response

Update a creative

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 'account_id_example'; // string | External account id containing the creative
$creative_id = 'creative_id_example'; // string | Creative to update
$external_creative_update_model_v2 = new \criteo\api\retailmedia\preview\Model\ExternalCreativeUpdateModelV2(); // \criteo\api\retailmedia\preview\Model\ExternalCreativeUpdateModelV2 | The creative to create

try {
    $result = $apiInstance->putApiV2ExternalAccountByAccountIdCreativescreativeId($account_id, $creative_id, $external_creative_update_model_v2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->putApiV2ExternalAccountByAccountIdCreativescreativeId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string External account id containing the creative
creative_id string Creative to update
external_creative_update_model_v2 \criteo\api\retailmedia\preview\Model\ExternalCreativeUpdateModelV2 The creative to create [optional]

Return type

\criteo\api\retailmedia\preview\Model\CreativeV2Response

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putApiV2ExternalLineItemBidMultipliersByLineItemId()

putApiV2ExternalLineItemBidMultipliersByLineItemId($line_item_id, $line_item_bid_multipliers_v2_request): \criteo\api\retailmedia\preview\Model\LineItemBidMultipliersV2Response

Updates the bid multipliers for a given line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | External LineItemId for bid multiplier retrieval
$line_item_bid_multipliers_v2_request = new \criteo\api\retailmedia\preview\Model\LineItemBidMultipliersV2Request(); // \criteo\api\retailmedia\preview\Model\LineItemBidMultipliersV2Request | New Bid Multipliers to be set

try {
    $result = $apiInstance->putApiV2ExternalLineItemBidMultipliersByLineItemId($line_item_id, $line_item_bid_multipliers_v2_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->putApiV2ExternalLineItemBidMultipliersByLineItemId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string External LineItemId for bid multiplier retrieval
line_item_bid_multipliers_v2_request \criteo\api\retailmedia\preview\Model\LineItemBidMultipliersV2Request New Bid Multipliers to be set [optional]

Return type

\criteo\api\retailmedia\preview\Model\LineItemBidMultipliersV2Response

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setKeywordBids()

setKeywordBids($id, $set_bids_model_request): \criteo\api\retailmedia\preview\Model\ResourceOutcome

Set bid overrides for associated keywords to the given line item in bulk

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | ID of the line item
$set_bids_model_request = new \criteo\api\retailmedia\preview\Model\SetBidsModelRequest(); // \criteo\api\retailmedia\preview\Model\SetBidsModelRequest

try {
    $result = $apiInstance->setKeywordBids($id, $set_bids_model_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->setKeywordBids: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string ID of the line item
set_bids_model_request \criteo\api\retailmedia\preview\Model\SetBidsModelRequest [optional]

Return type

\criteo\api\retailmedia\preview\Model\ResourceOutcome

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submitProposal()

submitProposal($id): \criteo\api\retailmedia\preview\Model\ProposalStatusModelResponse

Only the components of the Line Item that are in a valid state will be reviewed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | ID of the line item

try {
    $result = $apiInstance->submitProposal($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->submitProposal: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string ID of the line item

Return type

\criteo\api\retailmedia\preview\Model\ProposalStatusModelResponse

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unpausePromotedProducts()

unpausePromotedProducts($line_item_id, $promoted_product_resource_collection_input)

Un-pause a collection of promoted products associated with a line item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new criteo\api\retailmedia\preview\Api\CampaignApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$line_item_id = 'line_item_id_example'; // string | ID of the line item
$promoted_product_resource_collection_input = new \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput(); // \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput | Request body whose {data} contains an array of promoted products.

try {
    $apiInstance->unpausePromotedProducts($line_item_id, $promoted_product_resource_collection_input);
} catch (Exception $e) {
    echo 'Exception when calling CampaignApi->unpausePromotedProducts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
line_item_id string ID of the line item
promoted_product_resource_collection_input \criteo\api\retailmedia\preview\Model\PromotedProductResourceCollectionInput Request body whose {data} contains an array of promoted products. [optional]

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]