Skip to content
This repository has been archived by the owner on Sep 19, 2022. It is now read-only.

Latest commit

 

History

History
152 lines (114 loc) · 7.46 KB

CategoriesApi.md

File metadata and controls

152 lines (114 loc) · 7.46 KB

criteo_marketing.CategoriesApi

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

Method HTTP request Description
get_categories GET /v1/categories Gets categories
update_categories PUT /v1/categories Enables/disables categories

get_categories

list[CategoryMessage] get_categories(authorization, campaign_ids=campaign_ids, advertiser_ids=advertiser_ids, category_hash_codes=category_hash_codes, enabled_only=enabled_only)

Gets categories

Get the list of categories with the specified filters. If a category is requested but is missing from current user's portfolio, it will not be included in the list. If neither campaign ids nor advertisers ids are provided, then the user's portfolio will be used.

Example

  • Api Key Authentication (Authorization):
from __future__ import print_function
import time
import criteo_marketing
from criteo_marketing.rest import ApiException
from pprint import pprint
configuration = criteo_marketing.Configuration()
# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to https://api.criteo.com/marketing
configuration.host = "https://api.criteo.com/marketing"
# Create an instance of the API class
api_instance = criteo_marketing.CategoriesApi(criteo_marketing.ApiClient(configuration))
authorization = 'Bearer VALID_JWT_TOKEN_BASE64' # str | JWT Bearer Token (default to 'Bearer VALID_JWT_TOKEN_BASE64')
campaign_ids = 'campaign_ids_example' # str | Optional. One or more campaign ids, E.g., 78, 12932, 45236. If the campaign ids requested are not liked to advertisers in the user's portfolio, they will be skipped. (optional)
advertiser_ids = 'advertiser_ids_example' # str | Optional. One or more advertiser ids, E.g., 78, 12932, 45236. If the advertiser ids requested are not part of the user's portfolio, they will be skipped. (optional)
category_hash_codes = 'category_hash_codes_example' # str | Optional. One or more category hash codes. (optional)
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(authorization, campaign_ids=campaign_ids, advertiser_ids=advertiser_ids, category_hash_codes=category_hash_codes, enabled_only=enabled_only)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CategoriesApi->get_categories: %s\n" % e)

Parameters

Name Type Description Notes
authorization str JWT Bearer Token [default to 'Bearer VALID_JWT_TOKEN_BASE64']
campaign_ids str Optional. One or more campaign ids, E.g., 78, 12932, 45236. If the campaign ids requested are not liked to advertisers in the user's portfolio, they will be skipped. [optional]
advertiser_ids str Optional. One or more advertiser ids, E.g., 78, 12932, 45236. If the advertiser ids requested are not part of the user's portfolio, they will be skipped. [optional]
category_hash_codes str Optional. One or more category hash codes. [optional]
enabled_only bool Optional. Returns only categories you can bid on. Defaults to false. [optional]

Return type

list[CategoryMessage]

Authorization

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. -
400 There is not even one valid advertiserId or campaignId requested. -
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]

update_categories

list[CategoryUpdatesPerCatalog] update_categories(authorization, categories_per_catalog)

Enables/disables categories

Update categories for multiple catalogs.
Please note that all validations need to pass before applying the requested changes; the subsequent validation error messages will be returned in the response.
Please note that bidding will still happen for disabled categories, but using the Camapign's bid. If the call is successful, full details about the changed categories will be returned.

Example

  • Api Key Authentication (Authorization):
from __future__ import print_function
import time
import criteo_marketing
from criteo_marketing.rest import ApiException
from pprint import pprint
configuration = criteo_marketing.Configuration()
# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to https://api.criteo.com/marketing
configuration.host = "https://api.criteo.com/marketing"
# Create an instance of the API class
api_instance = criteo_marketing.CategoriesApi(criteo_marketing.ApiClient(configuration))
authorization = 'Bearer VALID_JWT_TOKEN_BASE64' # str | JWT Bearer Token (default to 'Bearer VALID_JWT_TOKEN_BASE64')
categories_per_catalog = [criteo_marketing.CategoryUpdatesPerCatalog()] # list[CategoryUpdatesPerCatalog] | The list of categories to be enabled/disabled, grouped by catalog.

try:
    # Enables/disables categories
    api_response = api_instance.update_categories(authorization, categories_per_catalog)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CategoriesApi->update_categories: %s\n" % e)

Parameters

Name Type Description Notes
authorization str JWT Bearer Token [default to 'Bearer VALID_JWT_TOKEN_BASE64']
categories_per_catalog list[CategoryUpdatesPerCatalog] The list of categories to be enabled/disabled, grouped by catalog.

Return type

list[CategoryUpdatesPerCatalog]

Authorization

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 Categories 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]