criteo\api\marketingsolutions\preview\AudienceApi

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

Method	HTTP request	Description
bulkCreateAudienceSegments()	POST /preview/marketing-solutions/audience-segments/create
bulkCreateAudiences()	POST /preview/marketing-solutions/audiences/create
bulkDeleteAudienceSegments()	POST /preview/marketing-solutions/audience-segments/delete
bulkDeleteAudiences()	POST /preview/marketing-solutions/audiences/delete
bulkUpdateAudienceSegments()	PATCH /preview/marketing-solutions/audience-segments
bulkUpdateAudiences()	PATCH /preview/marketing-solutions/audiences
computeAudienceSegmentsSizes()	POST /preview/marketing-solutions/audience-segments/compute-sizes
computeAudiencesSizes()	POST /preview/marketing-solutions/audiences/compute-sizes
estimateAudienceSegmentSize()	POST /preview/marketing-solutions/audience-segments/estimate-size
estimateAudienceSize()	POST /preview/marketing-solutions/audiences/estimate-size
getAudienceSegmentContactListStatistics()	GET /preview/marketing-solutions/audience-segments/{audience-segment-id}/contact-list
getAudienceSegmentsInMarketBrands()	GET /preview/marketing-solutions/audience-segments/in-market-brands
getAudienceSegmentsInMarketInterests()	GET /preview/marketing-solutions/audience-segments/in-market-interests
modifyAudienceUsersWithAttributes()	PATCH /preview/audiences/{audience-id}/contactlist-attributes
previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListDelete()	DELETE /preview/marketing-solutions/audience-segments/{audience-segment-id}/contact-list
previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListPatch()	PATCH /preview/marketing-solutions/audience-segments/{audience-segment-id}/contact-list
searchAudienceSegments()	POST /preview/marketing-solutions/audience-segments/search
searchAudiences()	POST /preview/marketing-solutions/audiences/search

`bulkCreateAudienceSegments()`

bulkCreateAudienceSegments($audience_segment_bulk_create_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceSegmentEntityV1ListResponse

Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.

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\AudienceApi(
    // 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
);
$audience_segment_bulk_create_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkCreateInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkCreateInputV1 | Segment creation parameter

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

Parameters

Name	Type	Description	Notes
audience_segment_bulk_create_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkCreateInputV1	Segment creation parameter

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceSegmentEntityV1ListResponse

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]

`bulkCreateAudiences()`

bulkCreateAudiences($audience_bulk_create_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceEntityV1ListResponse

Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.

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\AudienceApi(
    // 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
);
$audience_bulk_create_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceBulkCreateInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceBulkCreateInputV1 | 

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

Parameters

Name	Type	Description	Notes
audience_bulk_create_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceBulkCreateInputV1

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceEntityV1ListResponse

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]

`bulkDeleteAudienceSegments()`

bulkDeleteAudienceSegments($audience_segment_bulk_delete_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceSegmentIdEntityV1ListResponse

Delete the segments associated to the given audience IDs.

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\AudienceApi(
    // 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
);
$audience_segment_bulk_delete_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkDeleteInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkDeleteInputV1 | Segment delete request.

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

Parameters

Name	Type	Description	Notes
audience_segment_bulk_delete_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkDeleteInputV1	Segment delete request.

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceSegmentIdEntityV1ListResponse

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]

`bulkDeleteAudiences()`

bulkDeleteAudiences($audience_bulk_delete_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceIdEntityV1ListResponse

Deletes the audiences associated to the given audience IDs.

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\AudienceApi(
    // 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
);
$audience_bulk_delete_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceBulkDeleteInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceBulkDeleteInputV1 | 

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

Parameters

Name	Type	Description	Notes
audience_bulk_delete_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceBulkDeleteInputV1

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceIdEntityV1ListResponse

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]

`bulkUpdateAudienceSegments()`

bulkUpdateAudienceSegments($audience_segment_bulk_update_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceSegmentEntityV1ListResponse

Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.

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\AudienceApi(
    // 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
);
$audience_segment_bulk_update_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkUpdateInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkUpdateInputV1 | Segment Update request

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

Parameters

Name	Type	Description	Notes
audience_segment_bulk_update_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceSegmentBulkUpdateInputV1	Segment Update request

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceSegmentEntityV1ListResponse

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]

`bulkUpdateAudiences()`

bulkUpdateAudiences($audience_bulk_update_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceEntityV1ListResponse

Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.

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\AudienceApi(
    // 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
);
$audience_bulk_update_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceBulkUpdateInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceBulkUpdateInputV1 | 

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

Parameters

Name	Type	Description	Notes
audience_bulk_update_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceBulkUpdateInputV1

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceEntityV1ListResponse

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]

`computeAudienceSegmentsSizes()`

computeAudienceSegmentsSizes($audience_segment_compute_sizes_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceSegmentSizeEntityV1ListResponse

Gets the size of all segments. An error is returned for those whose size calculation is not supported.

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\AudienceApi(
    // 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
);
$audience_segment_compute_sizes_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceSegmentComputeSizesInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceSegmentComputeSizesInputV1 | 

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

Parameters

Name	Type	Description	Notes
audience_segment_compute_sizes_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceSegmentComputeSizesInputV1

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceSegmentSizeEntityV1ListResponse

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]

`computeAudiencesSizes()`

computeAudiencesSizes($audience_compute_sizes_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceSizeEntityV1ListResponse

Gets the size of all audiences. An error is returned for those whose size calculation is not supported.

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\AudienceApi(
    // 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
);
$audience_compute_sizes_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceComputeSizesInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceComputeSizesInputV1 | 

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

Parameters

Name	Type	Description	Notes
audience_compute_sizes_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceComputeSizesInputV1

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceSizeEntityV1ListResponse

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]

`estimateAudienceSegmentSize()`

estimateAudienceSegmentSize($audience_segment_estimate_size_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceSegmentSizeEstimationV1Response

Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.

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\AudienceApi(
    // 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
);
$audience_segment_estimate_size_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceSegmentEstimateSizeInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceSegmentEstimateSizeInputV1 | 

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

Parameters

Name	Type	Description	Notes
audience_segment_estimate_size_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceSegmentEstimateSizeInputV1

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceSegmentSizeEstimationV1Response

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]

`estimateAudienceSize()`

estimateAudienceSize($audience_estimate_size_input_v1): \criteo\api\marketingsolutions\preview\Model\AudienceSizeEstimationV1Response

Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.

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\AudienceApi(
    // 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
);
$audience_estimate_size_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceEstimateSizeInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceEstimateSizeInputV1 | 

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

Parameters

Name	Type	Description	Notes
audience_estimate_size_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceEstimateSizeInputV1

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceSizeEstimationV1Response

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]

`getAudienceSegmentContactListStatistics()`

getAudienceSegmentContactListStatistics($audience_segment_id): \criteo\api\marketingsolutions\preview\Model\ContactListStatisticsEntityV1Response

Returns the statistics of a contact list segment.

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\AudienceApi(
    // 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
);
$audience_segment_id = 56; // int | The segment ID.

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

Parameters

Name	Type	Description	Notes
audience_segment_id	int	The segment ID.

Return type

\criteo\api\marketingsolutions\preview\Model\ContactListStatisticsEntityV1Response

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]

`getAudienceSegmentsInMarketBrands()`

getAudienceSegmentsInMarketBrands($advertiser_id, $country): \criteo\api\marketingsolutions\preview\Model\InMarketAudienceSegmentBrandEntityV1ListResponse

Returns a list with all available in-market brands that can be used to define an in-market segment.

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\AudienceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser ID.
$country = 'country_example'; // string | The ISO 3166-1 alpha-2 country code.

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser ID.
country	string	The ISO 3166-1 alpha-2 country code.

Return type

\criteo\api\marketingsolutions\preview\Model\InMarketAudienceSegmentBrandEntityV1ListResponse

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]

`getAudienceSegmentsInMarketInterests()`

getAudienceSegmentsInMarketInterests($advertiser_id, $country): \criteo\api\marketingsolutions\preview\Model\InMarketAudienceSegmentInterestEntityV1ListResponse

Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.

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\AudienceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$advertiser_id = 'advertiser_id_example'; // string | The advertiser ID.
$country = 'country_example'; // string | The ISO 3166-1 alpha-2 country code.

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

Parameters

Name	Type	Description	Notes
advertiser_id	string	The advertiser ID.
country	string	The ISO 3166-1 alpha-2 country code.

Return type

\criteo\api\marketingsolutions\preview\Model\InMarketAudienceSegmentInterestEntityV1ListResponse

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]

`modifyAudienceUsersWithAttributes()`

modifyAudienceUsersWithAttributes($audience_id, $contactlist_with_attributes_amendment_request): \criteo\api\marketingsolutions\preview\Model\ModifyAudienceResponse

Add/remove identifiers to or from a contact list.

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\AudienceApi(
    // 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
);
$audience_id = 'audience_id_example'; // string | The id of the contact list audience-segment to amend
$contactlist_with_attributes_amendment_request = new \criteo\api\marketingsolutions\preview\Model\ContactlistWithAttributesAmendmentRequest(); // \criteo\api\marketingsolutions\preview\Model\ContactlistWithAttributesAmendmentRequest

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

Parameters

Name	Type	Description	Notes
audience_id	string	The id of the contact list audience-segment to amend
contactlist_with_attributes_amendment_request	\criteo\api\marketingsolutions\preview\Model\ContactlistWithAttributesAmendmentRequest

Return type

\criteo\api\marketingsolutions\preview\Model\ModifyAudienceResponse

Authorization

oauth, oauth

HTTP request headers

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

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

`previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListDelete()`

previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListDelete($audience_segment_id): \criteo\api\marketingsolutions\preview\Model\DeleteAudienceContactListResponse

Delete all identifiers from a contact list audience-segment.

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\AudienceApi(
    // 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
);
$audience_segment_id = 'audience_segment_id_example'; // string | The id of the contact list audience-segment to amend

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

Parameters

Name	Type	Description	Notes
audience_segment_id	string	The id of the contact list audience-segment to amend

Return type

\criteo\api\marketingsolutions\preview\Model\DeleteAudienceContactListResponse

Authorization

oauth, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListPatch()`

previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListPatch($audience_segment_id, $contactlist_amendment_request): \criteo\api\marketingsolutions\preview\Model\ModifyAudienceResponse

Add/remove identifiers to or from a contact list audience-segment.

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\AudienceApi(
    // 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
);
$audience_segment_id = 'audience_segment_id_example'; // string | The id of the contact list audience-segment to amend
$contactlist_amendment_request = new \criteo\api\marketingsolutions\preview\Model\ContactlistAmendmentRequest(); // \criteo\api\marketingsolutions\preview\Model\ContactlistAmendmentRequest

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

Parameters

Name	Type	Description	Notes
audience_segment_id	string	The id of the contact list audience-segment to amend
contactlist_amendment_request	\criteo\api\marketingsolutions\preview\Model\ContactlistAmendmentRequest

Return type

\criteo\api\marketingsolutions\preview\Model\ModifyAudienceResponse

Authorization

oauth, oauth

HTTP request headers

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

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

`searchAudienceSegments()`

searchAudienceSegments($audience_segment_search_input_v1, $limit, $offset): \criteo\api\marketingsolutions\preview\Model\AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse

Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.

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\AudienceApi(
    // 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
);
$audience_segment_search_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceSegmentSearchInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceSegmentSearchInputV1 | Segment search filters.
$limit = 50; // int | The number of elements to be returned. The default is 50 and the maximum is 100.
$offset = 0; // int | The (zero-based) offset into the collection. The default is 0.

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

Parameters

Name	Type	Description	Notes
audience_segment_search_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceSegmentSearchInputV1	Segment search filters.
limit	int	The number of elements to be returned. The default is 50 and the maximum is 100.	[optional] [default to 50]
offset	int	The (zero-based) offset into the collection. The default is 0.	[optional] [default to 0]

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse

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]

`searchAudiences()`

searchAudiences($audience_search_input_v1, $limit, $offset): \criteo\api\marketingsolutions\preview\Model\AudienceEntityV1AudienceSearchMetadataV1ListResponse

Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.

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\AudienceApi(
    // 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
);
$audience_search_input_v1 = new \criteo\api\marketingsolutions\preview\Model\AudienceSearchInputV1(); // \criteo\api\marketingsolutions\preview\Model\AudienceSearchInputV1 | Audience search filters.
$limit = 50; // int | The number of elements to be returned. The default is 50 and the maximum is 100.
$offset = 0; // int | The (zero-based) offset into the collection. The default is 0.

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

Parameters

Name	Type	Description	Notes
audience_search_input_v1	\criteo\api\marketingsolutions\preview\Model\AudienceSearchInputV1	Audience search filters.
limit	int	The number of elements to be returned. The default is 50 and the maximum is 100.	[optional] [default to 50]
offset	int	The (zero-based) offset into the collection. The default is 0.	[optional] [default to 0]

Return type

\criteo\api\marketingsolutions\preview\Model\AudienceEntityV1AudienceSearchMetadataV1ListResponse

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]

Files

AudienceApi.md

Latest commit

History

AudienceApi.md

File metadata and controls

criteo\api\marketingsolutions\preview\AudienceApi

bulkCreateAudienceSegments()

Example

Parameters

Return type

Authorization

HTTP request headers

bulkCreateAudiences()

Example

Parameters

Return type

Authorization

HTTP request headers

bulkDeleteAudienceSegments()

Example

Parameters

Return type

Authorization

HTTP request headers

bulkDeleteAudiences()

Example

Parameters

Return type

Authorization

HTTP request headers

bulkUpdateAudienceSegments()

Example

Parameters

Return type

Authorization

HTTP request headers

bulkUpdateAudiences()

Example

Parameters

Return type

Authorization

HTTP request headers

computeAudienceSegmentsSizes()

Example

Parameters

Return type

Authorization

HTTP request headers

computeAudiencesSizes()

Example

Parameters

Return type

Authorization

HTTP request headers

estimateAudienceSegmentSize()

Example

Parameters

Return type

Authorization

HTTP request headers

estimateAudienceSize()

Example

Parameters

Return type

Authorization

HTTP request headers

getAudienceSegmentContactListStatistics()

Example

Parameters

Return type

Authorization

HTTP request headers

getAudienceSegmentsInMarketBrands()

Example

Parameters

Return type

Authorization

HTTP request headers

getAudienceSegmentsInMarketInterests()

`bulkCreateAudienceSegments()`

`bulkCreateAudiences()`

`bulkDeleteAudienceSegments()`

`bulkDeleteAudiences()`

`bulkUpdateAudienceSegments()`

`bulkUpdateAudiences()`

`computeAudienceSegmentsSizes()`

`computeAudiencesSizes()`

`estimateAudienceSegmentSize()`

`estimateAudienceSize()`

`getAudienceSegmentContactListStatistics()`

`getAudienceSegmentsInMarketBrands()`

`getAudienceSegmentsInMarketInterests()`

`modifyAudienceUsersWithAttributes()`

`previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListDelete()`

`previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListPatch()`

`searchAudienceSegments()`

`searchAudiences()`