All URIs are relative to https://api.criteo.com, except if the operation defines another base path.
Method | HTTP request | Description |
---|---|---|
createAdSetV24Q1() | 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 | |
deleteOCIbrandSafetyRule() | DELETE /preview/brand-safety/oci | |
deleteOCItargetingRule() | DELETE /preview/targeting/oci | |
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 | |
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 | |
getAdSetV24Q1() | GET /preview/marketing-solutions/ad-sets/{ad-set-id} | |
getAdvertiserBundleRules() | GET /preview/advertisers/{advertiserId}/targeting/bundle-rules | |
getAdvertiserDomainRules() | GET /preview/advertisers/{advertiserId}/targeting/domain-rules | |
getCampaignBundleRules() | GET /preview/campaigns/{campaignId}/targeting/bundle-rules | |
getCampaignDomainRules() | GET /preview/campaigns/{campaignId}/targeting/domain-rules | |
getCampaignV23Q1() | GET /preview/marketing-solutions/campaigns/{campaign-id} | |
getCategoryBidList() | GET /preview/marketing-solutions/ad-sets/{ad-set-id}/category-bids | |
getDisplayMultipliers() | GET /preview/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers | |
getOCIbrandSafetyRule() | GET /preview/brand-safety/oci | |
getOCItargetingRule() | GET /preview/targeting/oci | |
getSupplyVendorList() | GET /preview/marketing-solutions/ad-sets/targeting/supply-vendors | |
patchAdSetsV24Q1() | PATCH /preview/marketing-solutions/ad-sets | |
patchCampaigns() | PATCH /preview/marketing-solutions/campaigns | |
patchCategoryBidList() | PATCH /preview/marketing-solutions/ad-sets/{ad-set-id}/category-bids | |
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 | |
searchAdSetsV24Q1() | POST /preview/marketing-solutions/ad-sets/search | |
searchCampaignsV23Q1() | 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 | |
upsertOCIbrandSafetyRule() | POST /preview/brand-safety/oci | |
upsertOCItargetingRule() | POST /preview/targeting/oci |
createAdSetV24Q1($create_ad_set_v24_q1_request): \criteo\api\marketingsolutions\preview\Model\ResponseReadAdSetV24Q1
Create the specified ad set
<?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_v24_q1_request = new \criteo\api\marketingsolutions\preview\Model\CreateAdSetV24Q1Request(); // \criteo\api\marketingsolutions\preview\Model\CreateAdSetV24Q1Request | the ad sets to create
try {
$result = $apiInstance->createAdSetV24Q1($create_ad_set_v24_q1_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->createAdSetV24Q1: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
create_ad_set_v24_q1_request | \criteo\api\marketingsolutions\preview\Model\CreateAdSetV24Q1Request | the ad sets to create |
\criteo\api\marketingsolutions\preview\Model\ResponseReadAdSetV24Q1
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
createCampaign($create_campaign_request): \criteo\api\marketingsolutions\preview\Model\CampaignV23Q1Response
Create the specified campaign
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
create_campaign_request | \criteo\api\marketingsolutions\preview\Model\CreateCampaignRequest | the campaigns to create |
\criteo\api\marketingsolutions\preview\Model\CampaignV23Q1Response
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
advertiser_id | int | 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] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
advertiser_id | int | 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] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | int | 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] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | int | 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] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteOCIbrandSafetyRule($target_type, $target_id)
Delete OCI brand-safety rule.
<?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
);
$target_type = new \criteo\api\marketingsolutions\preview\Model\TargetType(); // TargetType | Defines a target for a rule.
$target_id = 56; // int | Unique target identifier.
try {
$apiInstance->deleteOCIbrandSafetyRule($target_type, $target_id);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->deleteOCIbrandSafetyRule: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
target_type | TargetType | Defines a target for a rule. | |
target_id | int | Unique target identifier. |
void (empty response body)
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteOCItargetingRule($target_type, $target_id)
Delete OCI targeting rule.
<?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
);
$target_type = new \criteo\api\marketingsolutions\preview\Model\TargetType(); // TargetType | Defines a target for a rule.
$target_id = 56; // int | Unique target identifier.
try {
$apiInstance->deleteOCItargetingRule($target_type, $target_id);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->deleteOCItargetingRule: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
target_type | TargetType | Defines a target for a rule. | |
target_id | int | Unique target identifier. |
void (empty response body)
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
disableAdSetTargetingDealIds($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsDisableResultResponse
Disable the Deal Id Targeting configuration for the ad set whose id is specified
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
ad_set_id | string | Id of the Ad Set |
\criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsDisableResultResponse
- 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]
disableAdSetTargetingVideoPositioning($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningDisableResultResponse
Disable the Video Positioning Targeting configuration for the ad set whose id is specified
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
ad_set_id | string | Id of the Ad Set |
\criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningDisableResultResponse
- 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]
getAdSetTargetingDealIds($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsResponse
Get the Deal Id Targeting configuration for the ad set whose id is specified
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
ad_set_id | string | Id of the Ad Set |
\criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsResponse
- 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]
getAdSetTargetingVideoPositioning($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningResponse
Get the Video Positioning Targeting configuration for the ad set whose id is specified
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
ad_set_id | string | Id of the Ad Set |
\criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningResponse
- 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]
getAdSetV24Q1($ad_set_id): \criteo\api\marketingsolutions\preview\Model\ResponseReadAdSetV24Q1
Get the data for the specified ad set
<?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->getAdSetV24Q1($ad_set_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->getAdSetV24Q1: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
ad_set_id | string | Id of the ad set |
\criteo\api\marketingsolutions\preview\Model\ResponseReadAdSetV24Q1
- 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]
getAdvertiserBundleRules($advertiser_id): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
Returns a list of all targeted bundles for an advertiser.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
advertiser_id | int | The advertiser id |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- 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]
getAdvertiserDomainRules($advertiser_id): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
Returns a list of all targeted domains for an advertiser.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
advertiser_id | int | The advertiser id |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- 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]
getCampaignBundleRules($campaign_id): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
Returns a list of all targeted bundles for a campaign.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | int | The campaign id |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- 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]
getCampaignDomainRules($campaign_id): \criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
Returns a list of all targeted domains for a campaign.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | int | The campaign id |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- 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]
getCampaignV23Q1($campaign_id): \criteo\api\marketingsolutions\preview\Model\CampaignV23Q1Response
Get the data for the specified campaign
<?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 campaign
try {
$result = $apiInstance->getCampaignV23Q1($campaign_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->getCampaignV23Q1: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | string | Id of the campaign |
\criteo\api\marketingsolutions\preview\Model\CampaignV23Q1Response
- 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]
getCategoryBidList($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetCategoryBidListResponse
Get the Category Bids for all valid Categories associated to an Ad Set
<?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->getCategoryBidList($ad_set_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->getCategoryBidList: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
ad_set_id | string | Id of the Ad Set |
\criteo\api\marketingsolutions\preview\Model\AdSetCategoryBidListResponse
- 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]
getDisplayMultipliers($ad_set_id): \criteo\api\marketingsolutions\preview\Model\AdSetDisplayMultiplierListResponse
Get the Display Multipliers for all valid Categories associated to an Ad Set
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
ad_set_id | string | Id of the Ad Set |
\criteo\api\marketingsolutions\preview\Model\AdSetDisplayMultiplierListResponse
- 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]
getOCIbrandSafetyRule($target_type, $target_id): \criteo\api\marketingsolutions\preview\Model\OciBrandSafetyResponse
Get OCI brand-safety rule for the specified target
<?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
);
$target_type = new \criteo\api\marketingsolutions\preview\Model\TargetType(); // TargetType | Defines a target for a rule.
$target_id = 56; // int | Unique target identifier.
try {
$result = $apiInstance->getOCIbrandSafetyRule($target_type, $target_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->getOCIbrandSafetyRule: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
target_type | TargetType | Defines a target for a rule. | |
target_id | int | Unique target identifier. |
\criteo\api\marketingsolutions\preview\Model\OciBrandSafetyResponse
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getOCItargetingRule($target_type, $target_id): \criteo\api\marketingsolutions\preview\Model\OciTargetingResponse
Get OCI targeting rule for specified target.
<?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
);
$target_type = new \criteo\api\marketingsolutions\preview\Model\TargetType(); // TargetType | Defines a target for a rule.
$target_id = 56; // int | Unique target identifier.
try {
$result = $apiInstance->getOCItargetingRule($target_type, $target_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->getOCItargetingRule: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
target_type | TargetType | Defines a target for a rule. | |
target_id | int | Unique target identifier. |
\criteo\api\marketingsolutions\preview\Model\OciTargetingResponse
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getSupplyVendorList(): \criteo\api\marketingsolutions\preview\Model\SupplyVendorListResponse
Fetch the list of available supply vendors for any Ad Set targetings
<?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;
}
This endpoint does not need any parameter.
\criteo\api\marketingsolutions\preview\Model\SupplyVendorListResponse
- 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]
patchAdSetsV24Q1($requests_patch_ad_set_v24_q1): \criteo\api\marketingsolutions\preview\Model\ResponsesAdSetIdV24Q1
Patch a list of AdSets.
<?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_v24_q1 = new \criteo\api\marketingsolutions\preview\Model\RequestsPatchAdSetV24Q1(); // \criteo\api\marketingsolutions\preview\Model\RequestsPatchAdSetV24Q1 | List of adsets to patch.
try {
$result = $apiInstance->patchAdSetsV24Q1($requests_patch_ad_set_v24_q1);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->patchAdSetsV24Q1: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
requests_patch_ad_set_v24_q1 | \criteo\api\marketingsolutions\preview\Model\RequestsPatchAdSetV24Q1 | List of adsets to patch. | [optional] |
\criteo\api\marketingsolutions\preview\Model\ResponsesAdSetIdV24Q1
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
patchCampaigns($patch_campaign_list_request): \criteo\api\marketingsolutions\preview\Model\PatchResultCampaignListResponse
Patch a list of Campaigns.
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
patch_campaign_list_request | \criteo\api\marketingsolutions\preview\Model\PatchCampaignListRequest | List of campaigns to patch. | [optional] |
\criteo\api\marketingsolutions\preview\Model\PatchResultCampaignListResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
patchCategoryBidList($ad_set_id, $patch_ad_set_category_bid_list_request): \criteo\api\marketingsolutions\preview\Model\PatchAdSetCategoryBidResultListResponse
Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.
<?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
try {
$result = $apiInstance->patchCategoryBidList($ad_set_id, $patch_ad_set_category_bid_list_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->patchCategoryBidList: ', $e->getMessage(), PHP_EOL;
}
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 | [optional] |
\criteo\api\marketingsolutions\preview\Model\PatchAdSetCategoryBidResultListResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
patchDisplayMultipliers($ad_set_id, $patch_ad_set_display_multiplier_list_request): \criteo\api\marketingsolutions\preview\Model\PatchAdSetDisplayMultiplierResultListResponse
Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.
<?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
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;
}
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 | [optional] |
\criteo\api\marketingsolutions\preview\Model\PatchAdSetDisplayMultiplierResultListResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
advertiser_id | int | The advertiser id | |
api_request_of_targeting_entity | \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Description of the targeting rule to setup | [optional] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
advertiser_id | int | The advertiser id | |
api_request_of_targeting_entity | \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Description of the targeting rule to setup | [optional] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | int | The campaign id | |
api_request_of_targeting_entity | \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Description of the targeting rule to setup | [optional] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | int | The campaign id | |
api_request_of_targeting_entity | \criteo\api\marketingsolutions\preview\Model\ApiRequestOfTargetingEntity | Description of the targeting rule to setup | [optional] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
advertiser_id | int | 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 | [optional] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
advertiser_id | int | 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 | [optional] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | int | 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 | [optional] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
<?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 = 56; // int | 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;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_id | int | 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 | [optional] |
\criteo\api\marketingsolutions\preview\Model\ApiResponseOfTargetingEntity
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
searchAdSetsV24Q1($ad_set_search_request_v24_q1): \criteo\api\marketingsolutions\preview\Model\ResponsesReadAdSetV24Q1
Search for ad sets
<?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_v24_q1 = new \criteo\api\marketingsolutions\preview\Model\AdSetSearchRequestV24Q1(); // \criteo\api\marketingsolutions\preview\Model\AdSetSearchRequestV24Q1
try {
$result = $apiInstance->searchAdSetsV24Q1($ad_set_search_request_v24_q1);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->searchAdSetsV24Q1: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
ad_set_search_request_v24_q1 | \criteo\api\marketingsolutions\preview\Model\AdSetSearchRequestV24Q1 | [optional] |
\criteo\api\marketingsolutions\preview\Model\ResponsesReadAdSetV24Q1
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
searchCampaignsV23Q1($campaign_search_request_v23_q1): \criteo\api\marketingsolutions\preview\Model\CampaignV23Q1ListResponse
Search for campaigns
<?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 on campaigns
try {
$result = $apiInstance->searchCampaignsV23Q1($campaign_search_request_v23_q1);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->searchCampaignsV23Q1: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
campaign_search_request_v23_q1 | \criteo\api\marketingsolutions\preview\Model\CampaignSearchRequestV23Q1 | filters on campaigns | [optional] |
\criteo\api\marketingsolutions\preview\Model\CampaignV23Q1ListResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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
<?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;
}
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 | [optional] |
\criteo\api\marketingsolutions\preview\Model\AdSetTargetingDealIdsSetResultResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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
<?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;
}
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 | [optional] |
\criteo\api\marketingsolutions\preview\Model\AdSetTargetingVideoPositioningSetResultResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
startAdSets($requests_ad_set_id): \criteo\api\marketingsolutions\preview\Model\ResponsesAdSetId
Start the specified list of ad sets
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
requests_ad_set_id | \criteo\api\marketingsolutions\preview\Model\RequestsAdSetId | All the ad sets to start | [optional] |
\criteo\api\marketingsolutions\preview\Model\ResponsesAdSetId
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
stopAdSets($requests_ad_set_id): \criteo\api\marketingsolutions\preview\Model\ResponsesAdSetId
Stop the specified list of ad sets
<?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;
}
Name | Type | Description | Notes |
---|---|---|---|
requests_ad_set_id | \criteo\api\marketingsolutions\preview\Model\RequestsAdSetId | All the ad sets to stop | [optional] |
\criteo\api\marketingsolutions\preview\Model\ResponsesAdSetId
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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
<?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;
}
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. |
\criteo\api\marketingsolutions\preview\Model\AdSetAudienceLinkEntityV1Response
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
upsertOCIbrandSafetyRule($oci_brand_safety_rule): \criteo\api\marketingsolutions\preview\Model\OciBrandSafetyResponse
Create or update a new or replace existing OCI brand-safety rule.
<?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
);
$oci_brand_safety_rule = new \criteo\api\marketingsolutions\preview\Model\OciBrandSafetyRule(); // \criteo\api\marketingsolutions\preview\Model\OciBrandSafetyRule | OCI brand-safety rule input
try {
$result = $apiInstance->upsertOCIbrandSafetyRule($oci_brand_safety_rule);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->upsertOCIbrandSafetyRule: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
oci_brand_safety_rule | \criteo\api\marketingsolutions\preview\Model\OciBrandSafetyRule | OCI brand-safety rule input |
\criteo\api\marketingsolutions\preview\Model\OciBrandSafetyResponse
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
upsertOCItargetingRule($oci_targeting_rule): \criteo\api\marketingsolutions\preview\Model\OciTargetingResponse
Create or update new or update existing OCI targeting rule.
<?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
);
$oci_targeting_rule = new \criteo\api\marketingsolutions\preview\Model\OciTargetingRule(); // \criteo\api\marketingsolutions\preview\Model\OciTargetingRule | OCI targeting rule input
try {
$result = $apiInstance->upsertOCItargetingRule($oci_targeting_rule);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignApi->upsertOCItargetingRule: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
oci_targeting_rule | \criteo\api\marketingsolutions\preview\Model\OciTargetingRule | OCI targeting rule input |
\criteo\api\marketingsolutions\preview\Model\OciTargetingResponse
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]