criteo\api\retailmedia\preview\AccountsApi

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

Method	HTTP request	Description
createPrivateMarketDemandSellerAccount()	POST /preview/retail-media/account-management/accounts/{accountId}/create-seller-account
getApiExternalV1AccountPrivateMarketChildAccountsByAccountId()	GET /preview/retail-media/account-management/accounts/{accountId}/private-market-child-accounts
getApiV1ExternalAccounts()	GET /preview/retail-media/accounts
grantConsent()	POST /preview/retail-media/accounts/{accountId}/grant-consent
updateSellers()	PUT /preview/retail-media/account-management/accounts/{accountId}/sellers

`createPrivateMarketDemandSellerAccount()`

createPrivateMarketDemandSellerAccount($account_id, $value_resource_input_of_retail_media_seller_account_creation): \criteo\api\retailmedia\preview\Model\ResourceOutcomeOfRetailMediaAccount

Creates a new child Demand Seller Account for the provided parent private market 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\AccountsApi(
    // 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 for the parent private market account
$value_resource_input_of_retail_media_seller_account_creation = new \criteo\api\retailmedia\preview\Model\ValueResourceInputOfRetailMediaSellerAccountCreation(); // \criteo\api\retailmedia\preview\Model\ValueResourceInputOfRetailMediaSellerAccountCreation | Initial creation and configuration options for the new account

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

Parameters

Name	Type	Description	Notes
account_id	string	Account Id for the parent private market account
value_resource_input_of_retail_media_seller_account_creation	\criteo\api\retailmedia\preview\Model\ValueResourceInputOfRetailMediaSellerAccountCreation	Initial creation and configuration options for the new account	[optional]

Return type

\criteo\api\retailmedia\preview\Model\ResourceOutcomeOfRetailMediaAccount

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]

`getApiExternalV1AccountPrivateMarketChildAccountsByAccountId()`

getApiExternalV1AccountPrivateMarketChildAccountsByAccountId($account_id, $offset, $limit): \criteo\api\retailmedia\preview\Model\EntityResourceCollectionOutcomeOfRetailMediaAccount

Gets page of private market child accounts 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\AccountsApi(
    // 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
$offset = 0; // int | The (zero-based) offset into the collection of accounts. The default is 0.
$limit = 25; // int | The number of accounts to be returned. The default is 25.

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

Parameters

Name	Type	Description	Notes
account_id	string	Account Id
offset	int	The (zero-based) offset into the collection of accounts. The default is 0.	[optional] [default to 0]
limit	int	The number of accounts to be returned. The default is 25.	[optional] [default to 25]

Return type

\criteo\api\retailmedia\preview\Model\EntityResourceCollectionOutcomeOfRetailMediaAccount

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]

`getApiV1ExternalAccounts()`

getApiV1ExternalAccounts($limit_to_id, $page_index, $page_size): \criteo\api\retailmedia\preview\Model\JsonApiPageResponseOfAccount

Gets page of account objects that the current user can access

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\AccountsApi(
    // 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
);
$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->getApiV1ExternalAccounts($limit_to_id, $page_index, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getApiV1ExternalAccounts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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\JsonApiPageResponseOfAccount

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]

`grantConsent()`

grantConsent($account_id, $grant_consent_input)

Grant consent to a business application on behalf of a Private Market demand 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\AccountsApi(
    // 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 demand account ID on which to grant consent
$grant_consent_input = new \criteo\api\retailmedia\preview\Model\GrantConsentInput(); // \criteo\api\retailmedia\preview\Model\GrantConsentInput

try {
    $apiInstance->grantConsent($account_id, $grant_consent_input);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->grantConsent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
account_id	string	The demand account ID on which to grant consent
grant_consent_input	\criteo\api\retailmedia\preview\Model\GrantConsentInput		[optional]

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

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

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

`updateSellers()`

updateSellers($account_id, $value_resource_collection_input_of_retail_media_seller): \criteo\api\retailmedia\preview\Model\ValueResourceCollectionOutcomeOfRetailMediaSeller

replace the sellers assoiated with 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\AccountsApi(
    // 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 id to update
$value_resource_collection_input_of_retail_media_seller = new \criteo\api\retailmedia\preview\Model\ValueResourceCollectionInputOfRetailMediaSeller(); // \criteo\api\retailmedia\preview\Model\ValueResourceCollectionInputOfRetailMediaSeller | sellers to associate

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

Parameters

Name	Type	Description	Notes
account_id	string	the account id to update
value_resource_collection_input_of_retail_media_seller	\criteo\api\retailmedia\preview\Model\ValueResourceCollectionInputOfRetailMediaSeller	sellers to associate	[optional]

Return type

\criteo\api\retailmedia\preview\Model\ValueResourceCollectionOutcomeOfRetailMediaSeller

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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AccountsApi.md

AccountsApi.md

criteo\api\retailmedia\preview\AccountsApi

`createPrivateMarketDemandSellerAccount()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getApiExternalV1AccountPrivateMarketChildAccountsByAccountId()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getApiV1ExternalAccounts()`

Example

Parameters

Return type

Authorization

HTTP request headers

`grantConsent()`

Example

Parameters

Return type

Authorization

HTTP request headers

`updateSellers()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

AccountsApi.md

Latest commit

History

AccountsApi.md

File metadata and controls

criteo\api\retailmedia\preview\AccountsApi

createPrivateMarketDemandSellerAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

getApiExternalV1AccountPrivateMarketChildAccountsByAccountId()

Example

Parameters

Return type

Authorization

HTTP request headers

getApiV1ExternalAccounts()

Example

Parameters

Return type

Authorization

HTTP request headers

grantConsent()

Example

Parameters

Return type

Authorization

HTTP request headers

updateSellers()

Example

Parameters

Return type

Authorization

HTTP request headers

`createPrivateMarketDemandSellerAccount()`

`getApiExternalV1AccountPrivateMarketChildAccountsByAccountId()`

`getApiV1ExternalAccounts()`

`grantConsent()`

`updateSellers()`