PIpinterest
ad_groups

List ad groups

Changed on

List ad groups based on provided campaign IDs or ad group IDs.(campaign_ids or ad_group_ids). Note: Provide only campaign_id or ad_group_id. Do not provide both.

get/ad_accounts/{ad_account_id}/ad_groups

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page. See documentation on Pagination for more information.

order'ASCENDING' | 'DESCENDING'

The order in which to sort the items returned: "ASCENDING" or "DESCENDING" by ID. Note that higher-value IDs are associated with more-recently added items.

campaign_idsCampaignIdType[]

List of Campaign Ids to use to filter the results.

ad_group_idsPinterestLibIntegerFormatType[]

List of Ad group Ids to retrieve keywords from. This feature is currently in BETA and is not available to all users.

entity_statusesEntityStatus[]

Entity status

[
  "ACTIVE"
]
translate_interests_to_namesboolean

Return interests as text names (if value is true) rather than topic IDs.

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "billable_event": "CLICKTHROUGH",
      "placement_group": "ALL",
      "status": "ACTIVE",
      "targeting_spec": {
        "SHOPPING_RETARGETING": [
          {
            "lookback_window": 30,
            "exclusion_window": 14,
            "tag_types": [
              0,
              6
            ]
          }
        ]
      },
      "tracking_urls": {
        "impression": [
          "URL1",
          "URL2"
        ],
        "click": [
          "URL1",
          "URL2"
        ],
        "engagement": [
          "URL1",
          "URL2"
        ],
        "buyable_button": [
          "URL1",
          "URL2"
        ],
        "audience_verification": [
          "URL1",
          "URL2"
        ]
      }
    }
  ]
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      for the query request parameter order, default value ASCENDING was added

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • v5537bde5a50b1Revision changes
    • breaking

      the ///////// response property's minItems was decreased from 100 to 0 for the response status

    • breaking

      the ///////// response property's minItems was decreased from 100 to 0 for the response status