targeted-audiences

Targeted Audiences

GET accounts/:account_id/custom_audiences/:custom_audience_id/targeted¶

Retrieve a list of active or all line items and campaigns that target a given custom_audience_id

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: `18ce54d4x5t`
custom_audience_id required	A reference to the custom audience you are operating with in the request. Type: string Example: `2906h`
with_active optional	When `false`, includes line items that have `servable=false` status Type: boolean Default: `true` Possible values: `true`, `false`
cursor optional	Specifies a cursor to get the next page of results. See Pagination for more information. Type: string Example: `8x7v00oow`

Example Request¶

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h/targeted

Example Response¶

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "custom_audience_id": "2906h",
    }
  },
  "next_cursor": null,
  "data": [
    {
      "campaign_id": "59hod",
      "campaign_name": "test-campaign",
      "line_items": [
        {
          "id": "5gzog",
          "name": "test-line-item",
          "servable": true
        }
      ]
    },
    {
      "campaign_id": "arja7",
      "campaign_name": "Untitled campaign",
      "line_items": [
        {
          "id": "bjw1q",
          "name": null,
          "servable": true
        }
      ]
    }
  ]
}