PIpinterest
bulk

Get advertiser entities in bulk

Changed on

Create an asynchronous report that may include information on campaigns, ad groups, product groups, ads, keywords, schedules,and/or labels; can filter by campaigns. Though the entities may be active, archived, or paused, only active entities will return data.

post/ad_accounts/{ad_account_id}/bulk/download

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

entity_idsBulkDownloadEntityIdsItems[]

All entities specified by these IDs as well as their children and grandchildren will be downloaded if the entity type is one of the types requested to be downloaded.

entity_typesBulkEntityType[]

All entity types specified will be downloaded. Fewer types result in faster downloads.

output_format'CSV' | 'JSON'

Bulk file output format

updated_sincestring

Unix UTC timestamp to retrieve all entities that have changed since this time.

Example request

{
  "campaign_filter": {
    "end_time": "1622848072",
    "name": "campaign name",
    "start_time": "1622848072"
  },
  "entity_types": [
    "CAMPAIGN",
    "AD_GROUP"
  ],
  "updated_since": "1622848072"
}

Response

The request has succeeded.

request_idstring

ID of the bulk request.

Example response

{
  "request_id": "2680059592705"
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      request property / was restricted to a list of enum values

    • breaking

      the request property type changed from string to no type

    • warning

      removed from the / request property allOf list

    • info

      added the new AD enum value to the request property /

    • info

      added the new AD_GROUP enum value to the request property /

    • info

      added the new APP_INSTALL enum value to the request property //

    • info

      added the new CAMPAIGN enum value to the request property /

    • info

      added the new CTV_CONSIDERATION enum value to the request property //

    • info

      added the new ENTITY_HISTORY enum value to the request property /

    • info

      added the new KEYWORD enum value to the request property /

    • info

      added the new LABEL enum value to the request property /

    • info

      added the new LEADS enum value to the request property //

    • info

      added the new PRODUCT_GROUP enum value to the request property /

    • info

      added the new SALES enum value to the request property //

    • info

      added the new SCHEDULE enum value to the request property /

    • 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 non-success response with the status

    • info

      the response optional property became read-only for the status

    • info

      added the success response with the status

  • v514c297539b64Revision changes
    • info

      added the new SCHEDULE enum value to the request property /////