Skip to content

Latest commit

 

History

History
438 lines (332 loc) · 17.1 KB

AudiencesApi.md

File metadata and controls

438 lines (332 loc) · 17.1 KB
Raw

criteo_marketing.AudiencesApi

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

Method HTTP request Description
add_remove_users_to_audience PATCH /v1/audiences/userlist/{audienceId} Add/Remove users to an Audience.
create_audience POST /v1/audiences/userlist Create a new Audience.
delete_audience DELETE /v1/audiences/{audienceId} Delete an Audience.
get_audiences GET /v1/audiences Get the list of Audiences.
remove_users_from_audience DELETE /v1/audiences/userlist/{audienceId}/users Remove all users from an Audience.
update_audience_metadata PUT /v1/audiences/{audienceId} Update an Audience metadata.

add_remove_users_to_audience

AudiencePatchResponse add_remove_users_to_audience(audience_id, authorization, request)

Add/Remove users to an Audience.

Add/Remove users to an Audience.

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.AudiencesApi(criteo_marketing.ApiClient(configuration))
audience_id = 56 # int | Mandatory. The id of the audience to add or remove users to.
authorization = 'Bearer VALID_JWT_TOKEN_BASE64' # str | JWT Bearer Token (default to 'Bearer VALID_JWT_TOKEN_BASE64')
request = criteo_marketing.AudiencePatchRequest() # AudiencePatchRequest | Mandatory. The request to create the Audience.

try:
    # Add/Remove users to an Audience.
    api_response = api_instance.add_remove_users_to_audience(audience_id, authorization, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudiencesApi->add_remove_users_to_audience: %s\n" % e)

Parameters

Name Type Description Notes
audience_id int Mandatory. The id of the audience to add or remove users to.
authorization str JWT Bearer Token [default to 'Bearer VALID_JWT_TOKEN_BASE64']
request AudiencePatchRequest Mandatory. The request to create the Audience.

Return type

AudiencePatchResponse

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 Users were Added/Removed successfully. -
400 Invalid Operation, Schema, no valid identifiers given, too many identifiers given in a single request or invalid use of Gum caller id field. -
401 Authentication failed. -
403 The Advertiser this Audience belongs to is not in current user's portfolio. -
404 Audience 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]

create_audience

AudienceCreateResponse create_audience(authorization, create_request)

Create a new Audience.

Create a new Audience for the given Advertiser.

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.AudiencesApi(criteo_marketing.ApiClient(configuration))
authorization = 'Bearer VALID_JWT_TOKEN_BASE64' # str | JWT Bearer Token (default to 'Bearer VALID_JWT_TOKEN_BASE64')
create_request = criteo_marketing.AudienceCreateRequest() # AudienceCreateRequest | 

try:
    # Create a new Audience.
    api_response = api_instance.create_audience(authorization, create_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudiencesApi->create_audience: %s\n" % e)

Parameters

Name Type Description Notes
authorization str JWT Bearer Token [default to 'Bearer VALID_JWT_TOKEN_BASE64']
create_request AudienceCreateRequest

Return type

AudienceCreateResponse

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 Newly created Audience. -
400 The Audience name is incorrect. Must not be empty. -
401 Authentication failed. -
403 The requested advertiser is missing from current user's portfolio. -
409 The Audience name is already used for this Advertiser. -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

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

delete_audience

object delete_audience(audience_id, authorization)

Delete an Audience.

Delete an Audience.

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.AudiencesApi(criteo_marketing.ApiClient(configuration))
audience_id = 56 # int | Mandatory. The id of the audience to delete.
authorization = 'Bearer VALID_JWT_TOKEN_BASE64' # str | JWT Bearer Token (default to 'Bearer VALID_JWT_TOKEN_BASE64')

try:
    # Delete an Audience.
    api_response = api_instance.delete_audience(audience_id, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudiencesApi->delete_audience: %s\n" % e)

Parameters

Name Type Description Notes
audience_id int Mandatory. The id of the audience to delete.
authorization str JWT Bearer Token [default to 'Bearer VALID_JWT_TOKEN_BASE64']

Return type

object

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 OK -
204 Audience was deleted. -
401 Authentication failed. -
403 The Advertiser this Audience belongs to is not in current user's portfolio. -
404 Audience 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_audiences

AudiencesGetResponse get_audiences(authorization, advertiser_id=advertiser_id)

Get the list of Audiences.

Get the list of Audiences for the given Advertiser.

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.AudiencesApi(criteo_marketing.ApiClient(configuration))
authorization = 'Bearer VALID_JWT_TOKEN_BASE64' # str | JWT Bearer Token (default to 'Bearer VALID_JWT_TOKEN_BASE64')
advertiser_id = 56 # int | Mandatory. Advertiser to get all Audiences for. (optional)

try:
    # Get the list of Audiences.
    api_response = api_instance.get_audiences(authorization, advertiser_id=advertiser_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudiencesApi->get_audiences: %s\n" % e)

Parameters

Name Type Description Notes
authorization str JWT Bearer Token [default to 'Bearer VALID_JWT_TOKEN_BASE64']
advertiser_id int Mandatory. Advertiser to get all Audiences for. [optional]

Return type

AudiencesGetResponse

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 List of Audiences. -
401 Authentication failed. -
403 The requested advertiser is missing from current user's portfolio. -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

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

remove_users_from_audience

object remove_users_from_audience(audience_id, authorization)

Remove all users from an Audience.

Remove all users from an Audience.

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.AudiencesApi(criteo_marketing.ApiClient(configuration))
audience_id = 56 # int | Mandatory. The id of the audience to empty.
authorization = 'Bearer VALID_JWT_TOKEN_BASE64' # str | JWT Bearer Token (default to 'Bearer VALID_JWT_TOKEN_BASE64')

try:
    # Remove all users from an Audience.
    api_response = api_instance.remove_users_from_audience(audience_id, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudiencesApi->remove_users_from_audience: %s\n" % e)

Parameters

Name Type Description Notes
audience_id int Mandatory. The id of the audience to empty.
authorization str JWT Bearer Token [default to 'Bearer VALID_JWT_TOKEN_BASE64']

Return type

object

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 OK -
204 Audience was emptied. -
401 Authentication failed. -
403 The Advertiser this Audience belongs to is not in current user's portfolio. -
404 Audience 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]

update_audience_metadata

object update_audience_metadata(audience_id, authorization, request)

Update an Audience metadata.

Update an Audience metadata.

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.AudiencesApi(criteo_marketing.ApiClient(configuration))
audience_id = 56 # int | Mandatory. The id of the Audience to update.
authorization = 'Bearer VALID_JWT_TOKEN_BASE64' # str | JWT Bearer Token (default to 'Bearer VALID_JWT_TOKEN_BASE64')
request = criteo_marketing.AudiencePutRequest() # AudiencePutRequest | Mandatory. The request to update the Audience metadata.

try:
    # Update an Audience metadata.
    api_response = api_instance.update_audience_metadata(audience_id, authorization, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudiencesApi->update_audience_metadata: %s\n" % e)

Parameters

Name Type Description Notes
audience_id int Mandatory. The id of the Audience to update.
authorization str JWT Bearer Token [default to 'Bearer VALID_JWT_TOKEN_BASE64']
request AudiencePutRequest Mandatory. The request to update the Audience metadata.

Return type

object

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 OK -
204 Audience metadata was successfully changed. -
400 The Audience name is incorrect. Must not be empty. -
401 Authentication failed. -
403 The Advertiser this Audience belongs to is not in current user's portfolio. -
404 Audience not found. -
409 The Audience name is already used for this Advertiser. -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

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