Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
CustomerSet

Create a new CustomerSet.

Create a new CustomerSet.

post/cm/v1/customer-sets

Query parameters

ad_account_idstring required

The AdAccount ID.

Request body

idstring

Unique identifier of the CustomerSet. Automatically set by server on creation.

titlestring required

A descriptive name of the CustomerSet.

descriptionstring

An optional description of the CustomerSet.

id_type'UNKNOWN_ID_TYPE' | 'GOOGLE_ADID' | 'APPLE_IDFA' required
  • UNKNOWN_ID_TYPE: Unknown user ID type.
  • GOOGLE_ADID: Google Android advertising ID type.
  • APPLE_IDFA: Apple iOS advertising ID type.
status'UNKNOWN_STATUS' | 'PREPARING' | 'READY' | 'FAILED'

Unknown status.

  • PREPARING: Premature status.
  • READY: Ready.
  • FAILED: Failed to be ready.
data_file_pathstring required

Data source path of users. ex) gcs path for txt file of specific-type user lists (query result for postback, or journal...).

APPLE_IDFA user list txt file example: (one idfa per line).

8a05cce7-da5c-4980-8cef-2603ae1742b6 ffffffff-ffff-4fff-8fff-ffffffffffff

is_upperboolean

A flag indicating that identifiers are upper-cased. False if they are lower-cased.

auto_delete_atstring date-time

CustomerSet used nowhere for specific time will be removed automatically. It represents when this will be deleted in UTC.

created_atstring date-time

Created time.

updated_atstring date-time

Last updated time. Should not modify on the client side.

Response

A successful response.