criteo\api\marketingsolutions\preview\RecoApi

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

Method	HTTP request	Description
createProductSet()	POST /preview/product-sets
disableProductFiltering()	DELETE /preview/ads/{ad-id}/product-filter
enableProductFiltering()	POST /preview/ads/{ad-id}/product-filter
fetchProductFilteringConfig()	GET /preview/ads/{ad-id}/product-filter
fetchProductFilteringUsages()	GET /preview/product-sets/{product-set-id}/product-filters
fetchProductSet()	GET /preview/product-sets/{product-set-id}
fetchProductSets()	GET /preview/product-sets/dataset/{dataset-id}
removeProductSet()	DELETE /preview/product-sets/{product-set-id}

`createProductSet()`

createProductSet($value_resource_input_of_create_product_set_request): \criteo\api\marketingsolutions\preview\Model\ResourceOutcomeOfProductSet

Create a new product set

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\preview\Api\RecoApi(
    // 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
);
$value_resource_input_of_create_product_set_request = new \criteo\api\marketingsolutions\preview\Model\ValueResourceInputOfCreateProductSetRequest(); // \criteo\api\marketingsolutions\preview\Model\ValueResourceInputOfCreateProductSetRequest

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

Parameters

Name	Type	Description	Notes
value_resource_input_of_create_product_set_request	\criteo\api\marketingsolutions\preview\Model\ValueResourceInputOfCreateProductSetRequest		[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ResourceOutcomeOfProductSet

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]

`disableProductFiltering()`

disableProductFiltering($ad_id): \criteo\api\marketingsolutions\preview\Model\ValueResourceOutcomeOfProductFilterConfig

Disable product filtering for a given 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\RecoApi(
    // 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_id = 'ad_id_example'; // string | ID of the ad

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

Parameters

Name	Type	Description	Notes
ad_id	string	ID of the ad

Return type

\criteo\api\marketingsolutions\preview\Model\ValueResourceOutcomeOfProductFilterConfig

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]

`enableProductFiltering()`

enableProductFiltering($ad_id, $value_resource_input_of_create_product_filter_request): \criteo\api\marketingsolutions\preview\Model\ValueResourceOutcomeOfProductFilterConfig

Enable product filtering for a given 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\RecoApi(
    // 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_id = 'ad_id_example'; // string | ID of the ad
$value_resource_input_of_create_product_filter_request = new \criteo\api\marketingsolutions\preview\Model\ValueResourceInputOfCreateProductFilterRequest(); // \criteo\api\marketingsolutions\preview\Model\ValueResourceInputOfCreateProductFilterRequest

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

Parameters

Name	Type	Description	Notes
ad_id	string	ID of the ad
value_resource_input_of_create_product_filter_request	\criteo\api\marketingsolutions\preview\Model\ValueResourceInputOfCreateProductFilterRequest		[optional]

Return type

\criteo\api\marketingsolutions\preview\Model\ValueResourceOutcomeOfProductFilterConfig

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]

`fetchProductFilteringConfig()`

fetchProductFilteringConfig($ad_id): \criteo\api\marketingsolutions\preview\Model\ValueResourceOutcomeOfProductFilterConfig

Fetch product filtering configuration for a given 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\RecoApi(
    // 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_id = 'ad_id_example'; // string | ID of the ad

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

Parameters

Name	Type	Description	Notes
ad_id	string	ID of the ad

Return type

\criteo\api\marketingsolutions\preview\Model\ValueResourceOutcomeOfProductFilterConfig

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]

`fetchProductFilteringUsages()`

fetchProductFilteringUsages($product_set_id): \criteo\api\marketingsolutions\preview\Model\ValueResourceCollectionOutcomeOfProductFilterConfig

Fetch product filtering usages for a given product set

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\preview\Api\RecoApi(
    // 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
);
$product_set_id = 'product_set_id_example'; // string | ID of the product set

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

Parameters

Name	Type	Description	Notes
product_set_id	string	ID of the product set

Return type

\criteo\api\marketingsolutions\preview\Model\ValueResourceCollectionOutcomeOfProductFilterConfig

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]

`fetchProductSet()`

fetchProductSet($product_set_id): \criteo\api\marketingsolutions\preview\Model\ResourceOutcomeOfProductSet

Fetch an existing product set

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\preview\Api\RecoApi(
    // 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
);
$product_set_id = 'product_set_id_example'; // string | ID of the product set

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

Parameters

Name	Type	Description	Notes
product_set_id	string	ID of the product set

Return type

\criteo\api\marketingsolutions\preview\Model\ResourceOutcomeOfProductSet

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]

`fetchProductSets()`

fetchProductSets($dataset_id): \criteo\api\marketingsolutions\preview\Model\ResourceCollectionOutcomeOfProductSet

Fetch product sets of a given dataset

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\RecoApi(
    // 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
);
$dataset_id = 'dataset_id_example'; // string | The ID of the dataset that should be used for product set retrieval

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

Parameters

Name	Type	Description	Notes
dataset_id	string	The ID of the dataset that should be used for product set retrieval

Return type

\criteo\api\marketingsolutions\preview\Model\ResourceCollectionOutcomeOfProductSet

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]

`removeProductSet()`

removeProductSet($product_set_id): \criteo\api\marketingsolutions\preview\Model\Outcome

Remove a product set

Example

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


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

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


$apiInstance = new criteo\api\marketingsolutions\preview\Api\RecoApi(
    // 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
);
$product_set_id = 'product_set_id_example'; // string | ID of the product set to remove

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

Parameters

Name	Type	Description	Notes
product_set_id	string	ID of the product set to remove

Return type

\criteo\api\marketingsolutions\preview\Model\Outcome

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

RecoApi.md

Latest commit

History

RecoApi.md

File metadata and controls

criteo\api\marketingsolutions\preview\RecoApi

createProductSet()

Example

Parameters

Return type

Authorization

HTTP request headers

disableProductFiltering()

Example

Parameters

Return type

Authorization

HTTP request headers

enableProductFiltering()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchProductFilteringConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchProductFilteringUsages()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchProductSet()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchProductSets()

Example

Parameters

Return type

Authorization

HTTP request headers

removeProductSet()

Example

Parameters

Return type

Authorization

HTTP request headers

`createProductSet()`

`disableProductFiltering()`

`enableProductFiltering()`

`fetchProductFilteringConfig()`

`fetchProductFilteringUsages()`

`fetchProductSet()`

`fetchProductSets()`

`removeProductSet()`