criteo\api\marketingsolutions\preview\CampaignApi

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

Method	HTTP request	Description
createAdSet()	POST /preview/marketing-solutions/ad-sets
createCampaign()	POST /preview/marketing-solutions/campaigns
deleteAdvertiserBundleRules()	DELETE /preview/advertisers/{advertiserId}/targeting/bundle-rules
deleteAdvertiserDomainRules()	DELETE /preview/advertisers/{advertiserId}/targeting/domain-rules
deleteCampaignBundleRules()	DELETE /preview/campaigns/{campaignId}/targeting/bundle-rules
deleteCampaignDomainRules()	DELETE /preview/campaigns/{campaignId}/targeting/domain-rules
disableAdSetTargetingDealIds()	POST /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids/disable
disableAdSetTargetingVideoPositioning()	POST /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positionings/disable
getAdSet()	GET /preview/marketing-solutions/ad-sets/{ad-set-id}
getAdSetCategoryBids()	GET /preview/marketing-solutions/ad-sets/{ad-set-id}/category-bids
getAdSetTargetingDealIds()	GET /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids
getAdSetTargetingVideoPositioning()	GET /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positioning
getAdvertiserBundleRules()	GET /preview/advertisers/{advertiserId}/targeting/bundle-rules
getAdvertiserDomainRules()	GET /preview/advertisers/{advertiserId}/targeting/domain-rules
getCampaign()	GET /preview/marketing-solutions/campaigns/{campaign-id}
getCampaignBundleRules()	GET /preview/campaigns/{campaignId}/targeting/bundle-rules
getCampaignDomainRules()	GET /preview/campaigns/{campaignId}/targeting/domain-rules
getDisplayMultipliers()	GET /preview/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers
getSupplyVendorList()	GET /preview/marketing-solutions/ad-sets/targeting/supply-vendors
patchAdSetCategoryBids()	PATCH /preview/marketing-solutions/ad-sets/{ad-set-id}/category-bids
patchAdSets()	PATCH /preview/marketing-solutions/ad-sets
patchCampaigns()	PATCH /preview/marketing-solutions/campaigns
patchDisplayMultipliers()	PATCH /preview/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers
postAdvertiserBundleRules()	POST /preview/advertisers/{advertiserId}/targeting/bundle-rules
postAdvertiserDomainRules()	POST /preview/advertisers/{advertiserId}/targeting/domain-rules
postCampaignBundleRules()	POST /preview/campaigns/{campaignId}/targeting/bundle-rules
postCampaignDomainRules()	POST /preview/campaigns/{campaignId}/targeting/domain-rules
putAdvertiserBundleRules()	PUT /preview/advertisers/{advertiserId}/targeting/bundle-rules
putAdvertiserDomainRules()	PUT /preview/advertisers/{advertiserId}/targeting/domain-rules
putCampaignBundleRules()	PUT /preview/campaigns/{campaignId}/targeting/bundle-rules
putCampaignDomainRules()	PUT /preview/campaigns/{campaignId}/targeting/domain-rules
searchAdSets()	POST /preview/marketing-solutions/ad-sets/search
searchCampaigns()	POST /preview/marketing-solutions/campaigns/search
setAdSetTargetingDealIds()	PUT /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids
setAdSetTargetingVideoPositioning()	PUT /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positioning
startAdSets()	POST /preview/marketing-solutions/ad-sets/start
stopAdSets()	POST /preview/marketing-solutions/ad-sets/stop
updateAdSetAudience()	PUT /preview/marketing-solutions/ad-sets/{ad-set-id}/audience

`createAdSet()`

createAdSet($create_ad_set_v26_q1_request): \criteo\api\marketingsolutions\preview\Model\ResponseReadAdSetV26Q1

Create an ad set with the provided parameters

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$create_ad_set_v26_q1_request = new \criteo\api\marketingsolutions\preview\Model\CreateAdSetV26Q1Request(); // \criteo\api\marketingsolutions\preview\Model\CreateAdSetV26Q1Request | the ad sets to create

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

Parameters

Name	Type	Description	Notes
create_ad_set_v26_q1_request	\criteo\api\marketingsolutions\preview\Model\CreateAdSetV26Q1Request	the ad sets to create

Return type

\criteo\api\marketingsolutions\preview\Model\ResponseReadAdSetV26Q1

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]

`createCampaign()`

createCampaign($create_campaign_request): \criteo\api\marketingsolutions\preview\Model\CampaignV23Q1Response

Create the specified campaign A campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$create_campaign_request = new \criteo\api\marketingsolutions\preview\Model\CreateCampaignRequest(); // \criteo\api\marketingsolutions\preview\Model\CreateCampaignRequest | the campaigns to create

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

Parameters

Name	Type	Description	Notes
create_campaign_request	\criteo\api\marketingsolutions\preview\Model\CreateCampaignRequest	the campaigns to create

Return type

\criteo\api\marketingsolutions\preview\Model\CampaignV23Q1Response

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]

`deleteAdvertiserBundleRules()`

deleteAdvertiserBundleRules($advertiser_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Removes some bundles from the current list of targeted bundles for a given advertiser.
The mode of targeting (allowlist/blocklist) cannot be updated through this method.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Contains the list of items to delete from the list

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Contains the list of items to delete from the list	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`deleteAdvertiserDomainRules()`

deleteAdvertiserDomainRules($advertiser_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Removes some domains from the current list of targeted domains for a given advertiser.
The mode of targeting (allowlist/blocklist) cannot be updated through this method.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Contains the list of items to delete from the list

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Contains the list of items to delete from the list	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`deleteCampaignBundleRules()`

deleteCampaignBundleRules($campaign_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Removes some bundles from the current list of targeted bundles for a given campaign.
The mode of targeting (allowlist/blocklist) cannot be updated through this method.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 campaign id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Contains the list of items to delete from the list

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Contains the list of items to delete from the list	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`deleteCampaignDomainRules()`

deleteCampaignDomainRules($campaign_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Removes some domains from the current list of targeted domains for a given campaign.
The mode of targeting (allowlist/blocklist) cannot be updated through this method.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 campaign id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Contains the list of items to delete from the list

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Contains the list of items to delete from the list	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`disableAdSetTargetingDealIds()`

disableAdSetTargetingDealIds($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsDisableResultResponse

Disable the Deal Id Targeting configuration for the ad set whose id is specified

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsDisableResultResponse

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]

`disableAdSetTargetingVideoPositioning()`

disableAdSetTargetingVideoPositioning($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningDisableResultResponse

Disable the Video Positioning Targeting configuration for the ad set whose id is specified

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningDisableResultResponse

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]

`getAdSet()`

getAdSet($ad_set_id): \criteo\api\marketingsolutions\preview\Model\ResponseReadAdSetV26Q1

Get the data for the specified ad set

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the ad set

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the ad set

Return type

\criteo\api\marketingsolutions\preview\Model\ResponseReadAdSetV26Q1

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]

`getAdSetCategoryBids()`

getAdSetCategoryBids($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetCategoryBidListResponse

Get the Category Bids for all valid Categories associated to an Ad Set

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetCategoryBidListResponse

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]

`getAdSetTargetingDealIds()`

getAdSetTargetingDealIds($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsResponse

Get the Deal Id Targeting configuration for the ad set whose id is specified

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsResponse

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]

`getAdSetTargetingVideoPositioning()`

getAdSetTargetingVideoPositioning($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningResponse

Get the Video Positioning Targeting configuration for the ad set whose id is specified

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningResponse

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]

`getAdvertiserBundleRules()`

getAdvertiserBundleRules($advertiser_id): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Returns a list of all targeted bundles for an advertiser.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser id

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser id

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`getAdvertiserDomainRules()`

getAdvertiserDomainRules($advertiser_id): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Returns a list of all targeted domains for an advertiser.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser id

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser id

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`getCampaign()`

getCampaign($campaign_id): \criteo\api\marketingsolutions\preview\Model\CampaignV23Q1Response

Get the data for the specified campaign. A campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 | ID of the marketing campaign; This field is required.

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

Parameters

Name	Type	Description	Notes
campaign_id	string	ID of the marketing campaign; This field is required.

Return type

\criteo\api\marketingsolutions\preview\Model\CampaignV23Q1Response

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]

`getCampaignBundleRules()`

getCampaignBundleRules($campaign_id): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Returns a list of all targeted bundles for a campaign.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 campaign id

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign id

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`getCampaignDomainRules()`

getCampaignDomainRules($campaign_id): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Returns a list of all targeted domains for a campaign.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 campaign id

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign id

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`getDisplayMultipliers()`

getDisplayMultipliers($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetDisplayMultiplierListResponse

Get the Display Multipliers for all valid Categories associated to an Ad Set

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetDisplayMultiplierListResponse

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]

`getSupplyVendorList()`

getSupplyVendorList(): \criteo\api\marketingsolutions\preview\Model\SupplyVendorListResponse

Fetch the list of available supply vendors for any Ad Set targetings

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\criteo\api\marketingsolutions\preview\Model\SupplyVendorListResponse

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]

`patchAdSetCategoryBids()`

patchAdSetCategoryBids($ad_set_id, $patch_ad_set_category_bid_list_request): \criteo\api\marketingsolutions\preview\Model\PatchAdSetCategoryBidResultListResponse

Update the Category Bids for given Categories associated to an Ad Set Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set
$patch_ad_set_category_bid_list_request = new \criteo\api\marketingsolutions\preview\Model\PatchAdSetCategoryBidListRequest(); // \criteo\api\marketingsolutions\preview\Model\PatchAdSetCategoryBidListRequest | Collection of category bids to update

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set
patch_ad_set_category_bid_list_request	\criteo\api\marketingsolutions\preview\Model\PatchAdSetCategoryBidListRequest	Collection of category bids to update

Return type

\criteo\api\marketingsolutions\preview\Model\PatchAdSetCategoryBidResultListResponse

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]

`patchAdSets()`

patchAdSets($requests_patch_ad_set_v26_q1): \criteo\api\marketingsolutions\preview\Model\ResponsesAdSetIdV26Q1

Patch a list of AdSets.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$requests_patch_ad_set_v26_q1 = new \criteo\api\marketingsolutions\preview\Model\RequestsPatchAdSetV26Q1(); // \criteo\api\marketingsolutions\preview\Model\RequestsPatchAdSetV26Q1 | List of adsets to patch.

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

Parameters

Name	Type	Description	Notes
requests_patch_ad_set_v26_q1	\criteo\api\marketingsolutions\preview\Model\RequestsPatchAdSetV26Q1	List of adsets to patch.

Return type

\criteo\api\marketingsolutions\preview\Model\ResponsesAdSetIdV26Q1

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]

`patchCampaigns()`

patchCampaigns($patch_campaign_list_request): \criteo\api\marketingsolutions\preview\Model\PatchResultCampaignListResponse

Patch a list of Campaigns. A campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$patch_campaign_list_request = new \criteo\api\marketingsolutions\preview\Model\PatchCampaignListRequest(); // \criteo\api\marketingsolutions\preview\Model\PatchCampaignListRequest | List of campaigns to patch.

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

Parameters

Name	Type	Description	Notes
patch_campaign_list_request	\criteo\api\marketingsolutions\preview\Model\PatchCampaignListRequest	List of campaigns to patch.

Return type

\criteo\api\marketingsolutions\preview\Model\PatchResultCampaignListResponse

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]

`patchDisplayMultipliers()`

patchDisplayMultipliers($ad_set_id, $patch_ad_set_display_multiplier_list_request): \criteo\api\marketingsolutions\preview\Model\PatchAdSetDisplayMultiplierResultListResponse

Update the Display Multipliers for given Categories associated to an Ad Set Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set
$patch_ad_set_display_multiplier_list_request = new \criteo\api\marketingsolutions\preview\Model\PatchAdSetDisplayMultiplierListRequest(); // \criteo\api\marketingsolutions\preview\Model\PatchAdSetDisplayMultiplierListRequest | List of display multiplier values to change

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set
patch_ad_set_display_multiplier_list_request	\criteo\api\marketingsolutions\preview\Model\PatchAdSetDisplayMultiplierListRequest	List of display multiplier values to change

Return type

\criteo\api\marketingsolutions\preview\Model\PatchAdSetDisplayMultiplierResultListResponse

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]

`postAdvertiserBundleRules()`

postAdvertiserBundleRules($advertiser_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Inserts a list of targeted bundles for an advertiser and sets the targeting mode : blocklisting or allowlisting.
It will replace the current list if any.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Description of the targeting rule to setup

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Description of the targeting rule to setup

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`postAdvertiserDomainRules()`

postAdvertiserDomainRules($advertiser_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Inserts a list of targeted domains for an advertiser and sets the targeting mode : blocklisting or allowlisting.
It will replace the current list if any.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Description of the targeting rule to setup

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Description of the targeting rule to setup

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`postCampaignBundleRules()`

postCampaignBundleRules($campaign_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Inserts a list of targeted bundles for a campaign and sets the targeting mode : blocklisting or allowlisting.
It will replace the current list if any.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 campaign id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Description of the targeting rule to setup

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Description of the targeting rule to setup

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`postCampaignDomainRules()`

postCampaignDomainRules($campaign_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Inserts a list of targeted domains for a campaign and sets the targeting mode : blocklisting or allowlisting.
It will replace the current list if any.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 campaign id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Description of the targeting rule to setup

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Description of the targeting rule to setup

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`putAdvertiserBundleRules()`

putAdvertiserBundleRules($advertiser_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Updates the targeted bundles for an advertiser by adding a list of bundles to the current list.
The mode of targeting (allowlist/blocklist) cannot be updated through this method.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Contains the list of items to add to the existing list

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Contains the list of items to add to the existing list

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`putAdvertiserDomainRules()`

putAdvertiserDomainRules($advertiser_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Updates the targeted domains for an advertiser by adding a list of domains to the current list.
The mode of targeting (allowlist/blocklist) cannot be updated through this method.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Contains the list of items to add to the existing list

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Contains the list of items to add to the existing list

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`putCampaignBundleRules()`

putCampaignBundleRules($campaign_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Updates the targeted bundles for a campaign by adding a list of bundles to the current list.
The mode of targeting (allowlist/blocklist) cannot be updated through this method.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 campaign id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Contains the list of items to add to the existing list

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Contains the list of items to add to the existing list

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`putCampaignDomainRules()`

putCampaignDomainRules($campaign_id, $api_request_of_targeting_entity): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

Updates the targeted domains for a campaign by adding a list of domains to the current list.
The mode of targeting (allowlist/blocklist) cannot be updated through this method.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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 campaign id
$api_request_of_targeting_entity = new \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity(); // \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Contains the list of items to add to the existing list

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign id
api_request_of_targeting_entity	\criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity	Contains the list of items to add to the existing list

Return type

\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity

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]

`searchAdSets()`

searchAdSets($ad_set_search_request_v26_q1): \criteo\api\marketingsolutions\preview\Model\ResponsesReadAdSetV26Q1

Search for ad sets based on provided criteria. This returns the full configuration of ad sets matching those criteria. Field projection can be used if only a subset of fields is required, instead of the full configuration. If specific fields are precised in the user prompt, use meta.fields field projection in order to query only the value of these fields, else, provide every field.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_search_request_v26_q1 = new \criteo\api\marketingsolutions\preview\Model\AdSetSearchRequestV26Q1(); // \criteo\api\marketingsolutions\preview\Model\AdSetSearchRequestV26Q1

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

Parameters

Name	Type	Description	Notes
ad_set_search_request_v26_q1	\criteo\api\marketingsolutions\preview\Model\AdSetSearchRequestV26Q1		[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ResponsesReadAdSetV26Q1

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]

`searchCampaigns()`

searchCampaigns($campaign_search_request_v23_q1): \criteo\api\marketingsolutions\preview\Model\CampaignV23Q1ListResponse

Search endpoint for campaigns A campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria.

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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_search_request_v23_q1 = new \criteo\api\marketingsolutions\preview\Model\CampaignSearchRequestV23Q1(); // \criteo\api\marketingsolutions\preview\Model\CampaignSearchRequestV23Q1 | Filters for searching for campaigns

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

Parameters

Name	Type	Description	Notes
campaign_search_request_v23_q1	\criteo\api\marketingsolutions\preview\Model\CampaignSearchRequestV23Q1	Filters for searching for campaigns	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\CampaignV23Q1ListResponse

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]

`setAdSetTargetingDealIds()`

setAdSetTargetingDealIds($ad_set_id, $set_ad_set_targeting_deal_ids_request): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsSetResultResponse

Set the Deal Id Targeting configuration for the ad set whose id is specified

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set
$set_ad_set_targeting_deal_ids_request = new \criteo\api\marketingsolutions\preview\Model\SetAdSetTargetingDealIdsRequest(); // \criteo\api\marketingsolutions\preview\Model\SetAdSetTargetingDealIdsRequest | the new Deal Id Targeting configuration

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set
set_ad_set_targeting_deal_ids_request	\criteo\api\marketingsolutions\preview\Model\SetAdSetTargetingDealIdsRequest	the new Deal Id Targeting configuration

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsSetResultResponse

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]

`setAdSetTargetingVideoPositioning()`

setAdSetTargetingVideoPositioning($ad_set_id, $set_ad_set_targeting_video_positioning_request): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningSetResultResponse

Set the Video Positioning Targeting configuration for the ad set whose id is specified

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | Id of the Ad Set
$set_ad_set_targeting_video_positioning_request = new \criteo\api\marketingsolutions\preview\Model\SetAdSetTargetingVideoPositioningRequest(); // \criteo\api\marketingsolutions\preview\Model\SetAdSetTargetingVideoPositioningRequest | the new Video Positioning Targeting configuration

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	Id of the Ad Set
set_ad_set_targeting_video_positioning_request	\criteo\api\marketingsolutions\preview\Model\SetAdSetTargetingVideoPositioningRequest	the new Video Positioning Targeting configuration

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningSetResultResponse

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]

`startAdSets()`

startAdSets($requests_ad_set_id): \criteo\api\marketingsolutions\preview\Model\ResponsesAdSetId

Start the specified list of ad sets

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$requests_ad_set_id = new \criteo\api\marketingsolutions\preview\Model\RequestsAdSetId(); // \criteo\api\marketingsolutions\preview\Model\RequestsAdSetId | All the ad sets to start

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

Parameters

Name	Type	Description	Notes
requests_ad_set_id	\criteo\api\marketingsolutions\preview\Model\RequestsAdSetId	All the ad sets to start	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ResponsesAdSetId

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]

`stopAdSets()`

stopAdSets($requests_ad_set_id): \criteo\api\marketingsolutions\preview\Model\ResponsesAdSetId

Stop the specified list of ad sets

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$requests_ad_set_id = new \criteo\api\marketingsolutions\preview\Model\RequestsAdSetId(); // \criteo\api\marketingsolutions\preview\Model\RequestsAdSetId | All the ad sets to stop

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

Parameters

Name	Type	Description	Notes
requests_ad_set_id	\criteo\api\marketingsolutions\preview\Model\RequestsAdSetId	All the ad sets to stop	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ResponsesAdSetId

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]

`updateAdSetAudience()`

updateAdSetAudience($ad_set_id, $ad_set_audience_link_input_entity_v1): \criteo\api\marketingsolutions\preview\Model\AdSetAudienceLinkEntityV1Response

Link or unlink an audience with an ad set

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\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
);
$ad_set_id = 'ad_set_id_example'; // string | The ad set ID.
$ad_set_audience_link_input_entity_v1 = new \criteo\api\marketingsolutions\preview\Model\AdSetAudienceLinkInputEntityV1(); // \criteo\api\marketingsolutions\preview\Model\AdSetAudienceLinkInputEntityV1 | Ad set-Audience update request.

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

Parameters

Name	Type	Description	Notes
ad_set_id	string	The ad set ID.
ad_set_audience_link_input_entity_v1	\criteo\api\marketingsolutions\preview\Model\AdSetAudienceLinkInputEntityV1	Ad set-Audience update request.

Return type

\criteo\api\marketingsolutions\preview\Model\AdSetAudienceLinkEntityV1Response

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]

FilesExpand file tree

CampaignApi.md

Latest commit

History

CampaignApi.md

File metadata and controls

criteo\api\marketingsolutions\preview\CampaignApi

createAdSet()

Example

Parameters

Return type

Authorization

HTTP request headers

createCampaign()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAdvertiserBundleRules()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAdvertiserDomainRules()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCampaignBundleRules()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCampaignDomainRules()

Example

Parameters

Return type

Authorization

HTTP request headers

disableAdSetTargetingDealIds()

Example

Parameters

Return type

Authorization

HTTP request headers

disableAdSetTargetingVideoPositioning()

Example

Parameters

Return type

Authorization

HTTP request headers

getAdSet()

Example

Parameters

Return type

Authorization

HTTP request headers

getAdSetCategoryBids()

Example

Parameters

Return type

Authorization

HTTP request headers

getAdSetTargetingDealIds()

Example

Parameters

Return type

Authorization

HTTP request headers

getAdSetTargetingVideoPositioning()

Example

Parameters

Return type

Authorization

HTTP request headers

getAdvertiserBundleRules()

`createAdSet()`

`createCampaign()`

`deleteAdvertiserBundleRules()`

`deleteAdvertiserDomainRules()`

`deleteCampaignBundleRules()`

`deleteCampaignDomainRules()`

`disableAdSetTargetingDealIds()`

`disableAdSetTargetingVideoPositioning()`

`getAdSet()`

`getAdSetCategoryBids()`

`getAdSetTargetingDealIds()`

`getAdSetTargetingVideoPositioning()`

`getAdvertiserBundleRules()`

`getAdvertiserDomainRules()`

`getCampaign()`

`getCampaignBundleRules()`

`getCampaignDomainRules()`

`getDisplayMultipliers()`

`getSupplyVendorList()`

`patchAdSetCategoryBids()`

`patchAdSets()`

`patchCampaigns()`

`patchDisplayMultipliers()`