criteo\api\marketingsolutions\preview\CreativeApi

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

Method	HTTP request	Description
createAdvertiserAd()	POST /preview/advertisers/{advertiser-id}/ads
createAdvertiserCoupon()	POST /preview/advertisers/{advertiser-id}/coupons
createAdvertiserCreative()	POST /preview/advertisers/{advertiser-id}/creatives
deleteAd()	DELETE /preview/ads/{id}
deleteAdvertiserCoupon()	DELETE /preview/advertisers/{advertiser-id}/coupons/{id}
deleteCreative()	DELETE /preview/creatives/{id}
editAdvertiserCoupon()	PUT /preview/advertisers/{advertiser-id}/coupons/{id}
editCreative()	PUT /preview/creatives/{id}
generateCreativePreview()	POST /preview/creatives/{id}/preview
getAd()	GET /preview/ads/{id}
getAdvertiserAds()	GET /preview/advertisers/{advertiser-id}/ads
getAdvertiserCoupon()	GET /preview/advertisers/{advertiser-id}/coupons/{id}
getAdvertiserCouponPreview()	GET /preview/advertisers/{advertiser-id}/coupons/{id}/preview
getAdvertiserCouponSupportedSizes()	GET /preview/advertisers/{advertiser-id}/coupons-supported-sizes
getAdvertiserCoupons()	GET /preview/advertisers/{advertiser-id}/coupons
getAdvertiserCreatives()	GET /preview/advertisers/{advertiser-id}/creatives
getCreative()	GET /preview/creatives/{id}

`createAdvertiserAd()`

createAdvertiserAd($advertiser_id, $ad_write_request): \criteo\api\marketingsolutions\preview\Model\AdResponse

Create an Ad

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\CreativeApi(
    // 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 identifier.
$ad_write_request = new \criteo\api\marketingsolutions\preview\Model\AdWriteRequest(); // \criteo\api\marketingsolutions\preview\Model\AdWriteRequest

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
ad_write_request	\criteo\api\marketingsolutions\preview\Model\AdWriteRequest

Return type

\criteo\api\marketingsolutions\preview\Model\AdResponse

Authorization

oauth, oauth

HTTP request headers

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]

`createAdvertiserCoupon()`

createAdvertiserCoupon($advertiser_id, $create_coupon_request): \criteo\api\marketingsolutions\preview\Model\CouponResponse

Create a Coupon

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\CreativeApi(
    // 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 identifier.
$create_coupon_request = new \criteo\api\marketingsolutions\preview\Model\CreateCouponRequest(); // \criteo\api\marketingsolutions\preview\Model\CreateCouponRequest

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
create_coupon_request	\criteo\api\marketingsolutions\preview\Model\CreateCouponRequest

Return type

\criteo\api\marketingsolutions\preview\Model\CouponResponse

Authorization

oauth, oauth

HTTP request headers

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]

`createAdvertiserCreative()`

createAdvertiserCreative($advertiser_id, $creative_write_request): \criteo\api\marketingsolutions\preview\Model\CreativeResponse

Create a Creative

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\CreativeApi(
    // 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 identifier.
$creative_write_request = new \criteo\api\marketingsolutions\preview\Model\CreativeWriteRequest(); // \criteo\api\marketingsolutions\preview\Model\CreativeWriteRequest

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
creative_write_request	\criteo\api\marketingsolutions\preview\Model\CreativeWriteRequest

Return type

\criteo\api\marketingsolutions\preview\Model\CreativeResponse

Authorization

oauth, oauth

HTTP request headers

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]

`deleteAd()`

deleteAd($id)

Delete an Ad

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\CreativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | The ad identifier to delete.

try {
    $apiInstance->deleteAd($id);
} catch (Exception $e) {
    echo 'Exception when calling CreativeApi->deleteAd: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	The ad identifier to delete.

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`deleteAdvertiserCoupon()`

deleteAdvertiserCoupon($advertiser_id, $id)

Delete a Coupon

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\CreativeApi(
    // 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 identifier.
$id = 'id_example'; // string | The Coupon identifier to delete.

try {
    $apiInstance->deleteAdvertiserCoupon($advertiser_id, $id);
} catch (Exception $e) {
    echo 'Exception when calling CreativeApi->deleteAdvertiserCoupon: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
id	string	The Coupon identifier to delete.

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`deleteCreative()`

deleteCreative($id)

Delete a Creative if there are no ads binded to it

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\CreativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | The creative identifier to delete.

try {
    $apiInstance->deleteCreative($id);
} catch (Exception $e) {
    echo 'Exception when calling CreativeApi->deleteCreative: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The creative identifier to delete.

Return type

void (empty response body)

Authorization

oauth, oauth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`editAdvertiserCoupon()`

editAdvertiserCoupon($advertiser_id, $id, $update_coupon_request): \criteo\api\marketingsolutions\preview\Model\CouponResponse

Edit a specific Coupon

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\CreativeApi(
    // 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 identifier.
$id = 'id_example'; // string | The Coupon identifier to edit.
$update_coupon_request = new \criteo\api\marketingsolutions\preview\Model\UpdateCouponRequest(); // \criteo\api\marketingsolutions\preview\Model\UpdateCouponRequest

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

Parameters

Name	Type	Description
advertiser_id	string	The advertiser identifier.
id	string	The Coupon identifier to edit.
update_coupon_request	\criteo\api\marketingsolutions\preview\Model\UpdateCouponRequest

Return type

\criteo\api\marketingsolutions\preview\Model\CouponResponse

Authorization

oauth, oauth

HTTP request headers

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]

`editCreative()`

editCreative($id, $creative_write_request): \criteo\api\marketingsolutions\preview\Model\CreativeResponse

Edit a specific Creative

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\CreativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | The creative identifier to edit.
$creative_write_request = new \criteo\api\marketingsolutions\preview\Model\CreativeWriteRequest(); // \criteo\api\marketingsolutions\preview\Model\CreativeWriteRequest

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

Parameters

Name	Type	Description	Notes
id	string	The creative identifier to edit.
creative_write_request	\criteo\api\marketingsolutions\preview\Model\CreativeWriteRequest

Return type

\criteo\api\marketingsolutions\preview\Model\CreativeResponse

Authorization

oauth, oauth

HTTP request headers

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]

`generateCreativePreview()`

generateCreativePreview($id, $width, $height): string

Generate a preview of a specific Creative

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\CreativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | The Creative identifier to preview.
$width = 56; // int | The width of the Creative to preview.
$height = 56; // int | The height of the Creative to preview.

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

Parameters

Name	Type	Description	Notes
id	string	The Creative identifier to preview.
width	int	The width of the Creative to preview.	[optional]
height	int	The height of the Creative to preview.	[optional]

Return type

string

Authorization

oauth, oauth

HTTP request headers

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

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

`getAd()`

getAd($id): \criteo\api\marketingsolutions\preview\Model\AdResponse

Get an Ad from its id

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\CreativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | The ad identifier to retrieve.

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

Parameters

Name	Type	Description	Notes
id	int	The ad identifier to retrieve.

Return type

\criteo\api\marketingsolutions\preview\Model\AdResponse

Authorization

oauth, oauth

HTTP request headers

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

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

`getAdvertiserAds()`

getAdvertiserAds($advertiser_id, $limit, $offset): \criteo\api\marketingsolutions\preview\Model\AdListResponse

Get the list of self-services Ads for a given 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\CreativeApi(
    // 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 identifier.
$limit = 56; // int | The number of ads to be returned. The default is 50.
$offset = 56; // int | The (zero-based) offset into the collection of ads. The default is 0.

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
limit	int	The number of ads to be returned. The default is 50.	[optional]
offset	int	The (zero-based) offset into the collection of ads. The default is 0.	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\AdListResponse

Authorization

oauth, oauth

HTTP request headers

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

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

`getAdvertiserCoupon()`

getAdvertiserCoupon($advertiser_id, $id): \criteo\api\marketingsolutions\preview\Model\CouponResponse

Get a Coupon from its id

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\CreativeApi(
    // 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 identifier.
$id = 'id_example'; // string | The Coupon identifier to retrieve.

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
id	string	The Coupon identifier to retrieve.

Return type

\criteo\api\marketingsolutions\preview\Model\CouponResponse

Authorization

oauth, oauth

HTTP request headers

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

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

`getAdvertiserCouponPreview()`

getAdvertiserCouponPreview($advertiser_id, $id, $width, $height): string

Get the preview of a specific Coupon

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\CreativeApi(
    // 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 identifier.
$id = 'id_example'; // string | The Coupon identifier to preview.
$width = 56; // int | The width of the coupon to preview.
$height = 56; // int | The height of the coupon to preview.

try {
    $result = $apiInstance->getAdvertiserCouponPreview($advertiser_id, $id, $width, $height);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreativeApi->getAdvertiserCouponPreview: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
id	string	The Coupon identifier to preview.
width	int	The width of the coupon to preview.	[optional]
height	int	The height of the coupon to preview.	[optional]

Return type

string

Authorization

oauth, oauth

HTTP request headers

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

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

`getAdvertiserCouponSupportedSizes()`

getAdvertiserCouponSupportedSizes($advertiser_id, $ad_set_id): \criteo\api\marketingsolutions\preview\Model\CouponSupportedSizesResponse

Get the list of Coupon supported sizes

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\CreativeApi(
    // 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 identifier.
$ad_set_id = 'ad_set_id_example'; // string | The ad set id on which you want to check the Coupon supported sizes.

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
ad_set_id	string	The ad set id on which you want to check the Coupon supported sizes.	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\CouponSupportedSizesResponse

Authorization

oauth, oauth

HTTP request headers

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

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

`getAdvertiserCoupons()`

getAdvertiserCoupons($advertiser_id, $limit, $offset): \criteo\api\marketingsolutions\preview\Model\CouponListResponse

Get the list of self-services Coupons for a given 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\CreativeApi(
    // 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 identifier.
$limit = 56; // int | The number of coupons to be returned. The default is 50.
$offset = 56; // int | The (zero-based) offset into the collection of coupons. The default is 0.

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
limit	int	The number of coupons to be returned. The default is 50.	[optional]
offset	int	The (zero-based) offset into the collection of coupons. The default is 0.	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\CouponListResponse

Authorization

oauth, oauth

HTTP request headers

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

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

`getAdvertiserCreatives()`

getAdvertiserCreatives($advertiser_id, $limit, $offset): \criteo\api\marketingsolutions\preview\Model\CreativeListResponse

Get the list of self-services Creatives for a given 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\CreativeApi(
    // 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 identifier.
$limit = 56; // int | The number of creatives to be returned. The default is 50.
$offset = 56; // int | The (zero-based) offset into the collection of creatives. The default is 0.

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser identifier.
limit	int	The number of creatives to be returned. The default is 50.	[optional]
offset	int	The (zero-based) offset into the collection of creatives. The default is 0.	[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\CreativeListResponse

Authorization

oauth, oauth

HTTP request headers

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

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

`getCreative()`

getCreative($id): \criteo\api\marketingsolutions\preview\Model\CreativeResponse

Get a Creative from its id

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\CreativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | The creative identifier to retrieve.

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

Parameters

Name	Type	Description	Notes
id	string	The creative identifier to retrieve.

Return type

\criteo\api\marketingsolutions\preview\Model\CreativeResponse

Authorization

oauth, oauth

HTTP request headers

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

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

Files

CreativeApi.md

Latest commit

History

CreativeApi.md

File metadata and controls

criteo\api\marketingsolutions\preview\CreativeApi

createAdvertiserAd()

Example

Parameters

Return type

Authorization

HTTP request headers

createAdvertiserCoupon()

Example

Parameters

Return type

Authorization

HTTP request headers

createAdvertiserCreative()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAd()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAdvertiserCoupon()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCreative()

Example

Parameters

Return type

Authorization

HTTP request headers

editAdvertiserCoupon()

Example

Parameters

Return type

Authorization

HTTP request headers

editCreative()

Example

Parameters

Return type

Authorization

HTTP request headers

generateCreativePreview()

Example

Parameters

Return type

Authorization

HTTP request headers

getAd()

Example

Parameters

Return type

Authorization

HTTP request headers

getAdvertiserAds()

Example

Parameters

Return type

Authorization

HTTP request headers

getAdvertiserCoupon()

Example

Parameters

Return type

Authorization

HTTP request headers

getAdvertiserCouponPreview()

`createAdvertiserAd()`

`createAdvertiserCoupon()`

`createAdvertiserCreative()`

`deleteAd()`

`deleteAdvertiserCoupon()`

`deleteCreative()`

`editAdvertiserCoupon()`

`editCreative()`

`generateCreativePreview()`

`getAd()`

`getAdvertiserAds()`

`getAdvertiserCoupon()`

`getAdvertiserCouponPreview()`

`getAdvertiserCouponSupportedSizes()`

`getAdvertiserCoupons()`

`getAdvertiserCreatives()`

`getCreative()`