Add Audience

Adds one of the following:

• Audience

  1. Set the type parameter to Single.

  2. Define the conditions under which a viewer qualifies for this audience through the match_type parameter and the following parameters:

     country_codes | devices | dma_codes | ip_networks | zip_codes

• Superaudience

  1. Set the type parameter to Multiple.
  2. Set the sub_audiences parameter to the set of audiences that will be associated with this superaudience.
  3. Determine the conditions under which a viewer qualifies for this superaudience through the match_type parameter.

Request

Request syntax:

POST /audiences

Request body parameters:

Pass the following request body parameters:

Response

A successful request returns a 201 Created response that contains the following properties:

Sample Request/Response

Call the add_audience module (Python 3) to create an audience. This module imports names from the api_auth module.

import json, requests
from api_auth import APICredentials, APIParams

class Audience:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        """
        Create a audience.
        """
        self._create_audience()

    def _create_audience(self):
        url = "{}{}".format(self.host, "/api/v4/audiences")

        payload = {
            'desc': 'My New audience', # Replace with the audience's name.
            'country_codes': ['US', 'CA', 'MX'], # Replace with the desired country codes.
            'external_id': 'NorthAmerica', # Replace with the audience's external ID.
            'match_type': 'ANY' # Determines when a viewer qualifies for this audience.
        }

        headers = {'Content-Type': 'application/json'}

        response = requests.post(
            url, params=APIParams(APICredentials()).get_params({}), data=json.dumps(payload), headers=headers
        )

        print(response.json())

Audience().run()

Response:

{
	'@id': '/api/v4/audiences/abc11672b78c4d03bf4756ec3ea46a22',
	'@type': 'Audience',
	'created': '2021-06-30T22:32:09.362Z',
	'id': 'cc1c1672b78c4d03bf4756ec3ea46a45',
	'owner': 'abc123def456ghi789jkl012mno345pq',
	'match_type': 'ANY',
	'external_id': 'NorthAmerica',
	'country_codes': ['CA', 'MX', 'US'],
	'dma_codes': [],
	'desc': 'My New audience',
	'devices': [],
	'ip_networks': [],
	'zip_codes': [],
	'sub_audiences': [],
	'type': 'Single'
}