Audiences
Tailored Audience Changes¶
DEPRECATED These endpoints have been deprecated and will no longer be available as of 2019-02-28
GET accounts/:account_id/tailored_audience_changes¶
Retrieve details for some or all changes made to Tailored Audiences associated with the current account.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/tailored_audience_changes
Parameters¶
Name | Description |
---|---|
account_id
required
|
The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
count
optional
|
Specifies the number of records to try and retrieve per distinct request. Type: int Default:
200 Min, Max:
1 , 1000 |
cursor
optional
|
Specifies a cursor to get the next page of results. See Pagination for more information. Type: string Example: |
sort_by
optional
|
Sorts by supported attribute in ascending or descending order. See Sorting for more information. Type: string Example: |
tailored_audience_change_ids
optional
|
Scope the response to just the desired tailored audience changes by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided. Type: string Example: |
with_deleted
optional
|
Include deleted results in your request. Type: boolean Default:
false Possible values:
true , false |
with_total_count
optional
|
Include the Note: This parameter will be ignored if Note: Requests which include Type: boolean Default:
false Possible values:
true , false |
Example Request¶
GET https://ads-api.twitter.com/4/accounts/18ce54d4x5t/tailored_audience_changes?tailored_audience_change_ids=768t3
Example Response¶
{
"request": {
"params": {
"tailored_audience_change_ids": [
"768t3"
],
"account_id": "18ce54d4x5t"
}
},
"next_cursor": null,
"data": [
{
"input_file_path": "/ta_partner/2417045708/C8dI-eHVFB1PKVC.txt",
"tailored_audience_id": "1nmth",
"state": "COMPLETED",
"id": "768t3",
"operation": "ADD"
}
]
}
GET accounts/:account_id/tailored_audience_changes/:tailored_audience_change_id¶
Retrieve a specific Tailored Audience change record.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/tailored_audience_changes/:tailored_audience_change_id
Parameters¶
Name | Description |
---|---|
account_id
required
|
The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
tailored_audience_change_id
required
|
A reference to the tailored audience change record you are operating with in the request. Type: string Example: |
with_deleted
optional
|
Include deleted results in your request. Type: boolean Default:
false Possible values:
true , false |
Example Request¶
GET https://ads-api.twitter.com/4/accounts/18ce54d4x5t/tailored_audience_changes/7nm3j
Example Response¶
{
"request": {
"params": {
"tailored_audience_change_id": "7nm3j",
"account_id": "18ce54d4x5t"
}
},
"data": {
"input_file_path": "/ta_partner/2417045708/gsbgpZyEwHyO7nU.txt",
"tailored_audience_id": "28wk9",
"state": "COMPLETED",
"id": "7nm3j",
"operation": "ADD"
}
}
POST accounts/:account_id/tailored_audience_changes¶
Submit a change to a Tailored Audience.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/tailored_audience_changes
Parameters¶
Name | Description |
---|---|
account_id
required
|
The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
tailored_audience_id
required
|
The identifier for the tailored audience. Type: string Example: |
input_file_path
required
|
The file path returned by the TON API endpoint. Type: string Example: |
operation
required
|
The operation to take on this audience with the uploaded list. Type: enum Possible values: |
Example Request¶
POST https://ads-api.twitter.com/4/accounts/18ce54d4x5t/tailored_audience_changes?tailored_audience_id=13sf&operation=ADD&input_file_path=/1.1/ton/data/ta_partner/1877861928/Axbsh2.csv
Example Response¶
{
"data": {
"input_file_path": "/ta_partner/Axbsh2",
"tailored_audience_id": "13sf",
"state": "COMPLETED",
"id": "9q0",
"operation": "ADD"
},
"request": {
"params": {
"tailored_audience_id": "13sf",
"input_file_path": "/1.1/ton/data/ta_partner/1877861928/Axbsh2.csv",
"operation": "ADD",
"account_id": "18ce54d4x5t"
}
}
}