PIpinterest
campaigns

List campaigns

Changed on

Get a list of the campaigns in the specified ad_account_id, filtered by the specified options.

  • The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
get/ad_accounts/{ad_account_id}/campaigns

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.

entity_statusesEntityStatus[]

Entity status

[
  "ACTIVE"
]

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "ad_account_id": "549755885175",
      "bid_options": {
        "age_bucket_multipliers": {
          "18-24": 0.9,
          "25-34": 1.1,
          "35-44": 1.2
        },
        "app_type_multipliers": {
          "android_mobile": 1.1,
          "android_tablet": 1.1,
          "ipad": 1.2,
          "iphone": 1.2,
          "web": 0.9,
          "web_mobile": 0.8
        },
        "audience_multipliers": {
          "123": 1.1,
          "456": 1.2
        },
        "frequency_multipliers": {
          "0": 1.5,
          "1": 1.3,
          "2": 0.8
        },
        "gender_multipliers": {
          "female": 2.1,
          "male": 0.8
        },
        "placement_multipliers": {
          "browse": 0.9,
          "search": 1.2,
          "related_pins": 1.1
        }
      },
      "created_time": 1432744744,
      "daily_spend_cap": 1432744744,
      "end_time": 1644023526,
      "id": "549755885175",
      "is_automated_campaign": true,
      "is_campaign_budget_optimization": true,
      "is_carting": true,
      "is_flexible_daily_budgets": true,
      "is_ltv_optimized": true,
      "is_performance_plus": true,
      "is_top_of_search": true,
      "lifetime_spend_cap": 1432744744,
      "name": "ACME Tools",
      "order_line_id": "549755885175",
      "start_time": 1580865126,
      "status": "ACTIVE",
      "tracking_urls": {
        "impression": [
          "URL1",
          "URL2"
        ],
        "click": [
          "URL1",
          "URL2"
        ],
        "engagement": [
          "URL1",
          "URL2"
        ],
        "buyable_button": [
          "URL1",
          "URL2"
        ],
        "audience_verification": [
          "URL1",
          "URL2"
        ]
      },
      "type": "campaign",
      "updated_time": 1432744744
    }
  ]
}

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

  • v514c297539b64Revision changes
    • info

      for the query request parameter campaign_ids, the maxItems was increased from 100 to 250