criteo_marketing_transition.CampaignApi

All URIs are relative to https://api.criteo.com

Method	HTTP request	Description
get_ad_set	GET /2021-04/marketing-solutions/ad-sets/{adSetId}
get_bids	GET /legacy/marketing/v1/campaigns/bids	Gets a the bids for campaigns and their categories
get_categories	GET /legacy/marketing/v1/campaigns/{campaignId}/categories	Gets categories
get_category	GET /legacy/marketing/v1/campaigns/{campaignId}/categories/{categoryHashCode}	Gets a specific category
patch_ad_sets	PATCH /2021-04/marketing-solutions/ad-sets
search_ad_sets	POST /2021-04/marketing-solutions/ad-sets/search
start_ad_sets	POST /2021-04/marketing-solutions/ad-sets/start
stop_ad_sets	POST /2021-04/marketing-solutions/ad-sets/stop
update_bids	PUT /legacy/marketing/v1/campaigns/bids	Update bids for campaigns and their categories

get_ad_set

ResponseReadAdSet get_ad_set(ad_set_id)

Get the data for the specified ad set

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
ad_set_id = 'ad_set_id_example' # str | Id of the ad set

try:
    api_response = api_instance.get_ad_set(ad_set_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->get_ad_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
ad_set_id	str	Id of the ad set

Return type

ResponseReadAdSet

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	data for the ad set	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

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

get_bids

list[CampaignBidMessage] get_bids(campaign_ids=campaign_ids, advertiser_ids=advertiser_ids, category_hash_codes=category_hash_codes, bid_type=bid_type, campaign_status=campaign_status, pending_changes=pending_changes)

Gets a the bids for campaigns and their categories

Get the campaigns' bids, as well as the bids of their categories

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
campaign_ids = 'campaign_ids_example' # str | Optional. The ids of the campaigns we want to get the bids on. If not specified, advertiserIds will be used. (optional)
advertiser_ids = 'advertiser_ids_example' # str | Optional. The ids of the advertisers' campaigns we want to get the bids on. If campaignIds not specified, and neither is advertiserIds, all the advertisers in the user's portfolio are used. (optional)
category_hash_codes = 'category_hash_codes_example' # str | Optional. Filters only specified categories. By default no filtering is applied. (optional)
bid_type = 'bid_type_example' # str | Optional. Filters by bid type. By default no filtering is applied. (optional)
campaign_status = 'campaign_status_example' # str | Optional. Filters by campaign status. By default no filtering is applied. (optional)
pending_changes = True # bool | Optional. Filters only pending changes or settled ones. By default no filtering is applied. (optional)

try:
    # Gets a the bids for campaigns and their categories
    api_response = api_instance.get_bids(campaign_ids=campaign_ids, advertiser_ids=advertiser_ids, category_hash_codes=category_hash_codes, bid_type=bid_type, campaign_status=campaign_status, pending_changes=pending_changes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->get_bids: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_ids	str	Optional. The ids of the campaigns we want to get the bids on. If not specified, advertiserIds will be used.	[optional]
advertiser_ids	str	Optional. The ids of the advertisers' campaigns we want to get the bids on. If campaignIds not specified, and neither is advertiserIds, all the advertisers in the user's portfolio are used.	[optional]
category_hash_codes	str	Optional. Filters only specified categories. By default no filtering is applied.	[optional]
bid_type	str	Optional. Filters by bid type. By default no filtering is applied.	[optional]
campaign_status	str	Optional. Filters by campaign status. By default no filtering is applied.	[optional]
pending_changes	bool	Optional. Filters only pending changes or settled ones. By default no filtering is applied.	[optional]

Return type

list[CampaignBidMessage]

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Bids returned OK.	-
401	Authentication failed.	-
403	There is not even one valid advertiserId or campaignId requested.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

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

get_categories

CategoryMessage get_categories(campaign_id, enabled_only=enabled_only)

Gets categories

Get the list of categories linked to the requested campaign.

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
campaign_id = 56 # int | Mandatory. The id of the campaign the categories are linked to.
enabled_only = True # bool | Optional. Returns only categories you can bid on. Defaults to false. (optional)

try:
    # Gets categories
    api_response = api_instance.get_categories(campaign_id, enabled_only=enabled_only)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->get_categories: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	int	Mandatory. The id of the campaign the categories are linked to.
enabled_only	bool	Optional. Returns only categories you can bid on. Defaults to false.	[optional]

Return type

CategoryMessage

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Categories returned OK.	-
401	Authentication failed.	-
403	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested campaign was not found.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

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

get_category

CategoryMessage get_category(campaign_id, category_hash_code)

Gets a specific category

Get a specific category linked to the requested campaign.

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
campaign_id = 56 # int | Mandatory. The id of the campaign the categories are linked to.
category_hash_code = 56 # int | Mandatory. The id of the category to return.

try:
    # Gets a specific category
    api_response = api_instance.get_category(campaign_id, category_hash_code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->get_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	int	Mandatory. The id of the campaign the categories are linked to.
category_hash_code	int	Mandatory. The id of the category to return.

Return type

CategoryMessage

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Category returned OK.	-
401	Authentication failed.	-
403	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested category was not found for the campaign.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

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

patch_ad_sets

ResponseAdSetId patch_ad_sets(requests_patch_ad_set=requests_patch_ad_set)

Patch a list of AdSets.

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
requests_patch_ad_set = criteo_marketing_transition.RequestsPatchAdSet() # RequestsPatchAdSet | List of adsets to patch. (optional)

try:
    api_response = api_instance.patch_ad_sets(requests_patch_ad_set=requests_patch_ad_set)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->patch_ad_sets: %s\n" % e)

Parameters

Name	Type	Description	Notes
requests_patch_ad_set	RequestsPatchAdSet	List of adsets to patch.	[optional]

Return type

ResponseAdSetId

Authorization

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	List of patched adSets.	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

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

search_ad_sets

ResponsesReadAdSet search_ad_sets(request_ad_set_search=request_ad_set_search)

Search for ad sets

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
request_ad_set_search = criteo_marketing_transition.RequestAdSetSearch() # RequestAdSetSearch |  (optional)

try:
    api_response = api_instance.search_ad_sets(request_ad_set_search=request_ad_set_search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->search_ad_sets: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_ad_set_search	RequestAdSetSearch		[optional]

Return type

ResponsesReadAdSet

Authorization

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	data for the ad sets	-
400	Bad Request	-
401	The API client is not properly authenticated.	-
403	Forbidden	-

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

start_ad_sets

ResponsesAdSetId start_ad_sets(requests_ad_set_id=requests_ad_set_id)

Start the specified list of ad sets

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
requests_ad_set_id = criteo_marketing_transition.RequestsAdSetId() # RequestsAdSetId | All the ad sets to start (optional)

try:
    api_response = api_instance.start_ad_sets(requests_ad_set_id=requests_ad_set_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->start_ad_sets: %s\n" % e)

Parameters

Name	Type	Description	Notes
requests_ad_set_id	RequestsAdSetId	All the ad sets to start	[optional]

Return type

ResponsesAdSetId

Authorization

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	List of ad sets that have been started and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

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

stop_ad_sets

ResponsesAdSetId stop_ad_sets(requests_ad_set_id=requests_ad_set_id)

Stop the specified list of ad sets

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
requests_ad_set_id = criteo_marketing_transition.RequestsAdSetId() # RequestsAdSetId | All the ad sets to stop (optional)

try:
    api_response = api_instance.stop_ad_sets(requests_ad_set_id=requests_ad_set_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->stop_ad_sets: %s\n" % e)

Parameters

Name	Type	Description	Notes
requests_ad_set_id	RequestsAdSetId	All the ad sets to stop	[optional]

Return type

ResponsesAdSetId

Authorization

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	List of ad sets that have been stopped and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

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

update_bids

list[CampaignMessage] update_bids(bid_changes)

Update bids for campaigns and their categories

If a campaign bid is updated, all (if any) category bids for this campaign will be updated with the new value if they are initially equal to the campaign bid. If the category bid is not wanted to be cascaded to the categories with the same bid value, new change bids must be added in the request for the categories where the value should be kept (with the initial value).

Example

OAuth Authentication (Authorization):

from __future__ import print_function
import time
import criteo_marketing_transition
from criteo_marketing_transition.rest import ApiException
from pprint import pprint
configuration = criteo_marketing_transition.Configuration()
# Configure OAuth2 access token for authorization: Authorization
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.criteo.com
configuration.host = "https://api.criteo.com"
# Create an instance of the API class
api_instance = criteo_marketing_transition.CampaignApi(criteo_marketing_transition.ApiClient(configuration))
bid_changes = [criteo_marketing_transition.CampaignBidChangeRequest()] # list[CampaignBidChangeRequest] | Specifies the list of bid changes to be applied.

try:
    # Update bids for campaigns and their categories
    api_response = api_instance.update_bids(bid_changes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignApi->update_bids: %s\n" % e)

Parameters

Name	Type	Description	Notes
bid_changes	list[CampaignBidChangeRequest]	Specifies the list of bid changes to be applied.

Return type

list[CampaignMessage]

Authorization

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, text/html
Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code	Description	Response headers
200	Campaign bids updated OK.	-
400	Invalid input. Please check returned message for details.	-
401	Authentication failed.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

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

Files

CampaignApi.md

Latest commit

History

CampaignApi.md

File metadata and controls

criteo_marketing_transition.CampaignApi

get_ad_set

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_bids

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_categories

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_category

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_ad_sets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

search_ad_sets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_ad_sets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

stop_ad_sets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_bids

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details