labels

Closed beta

See a list of labels for assets that your account owns, and filter the list by different criteria. If no filter is provided, it will default to labels associated with the ad account id.

get/ad_accounts/{ad_account_id}/labels

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

campaign_idsCampaignIdType[]

List of Campaign Ids to use to filter the results.

label_idsQueryLabelIdsItems[]

List of Label Ids to use to filter the results.

entity_statusesQueryLabelEntityStatusesItems[]

Label entity status

label_typesQueryLabelTypesItems[]

Label type.

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.

Response

The request has succeeded.

bookmarkstring nullable

Changes

    • 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

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • warning

      added the new ACTIVE enum value to the ////// response property for the response status

    • warning

      added the new ACTIVE enum value to the ///// response property for the response status

    • warning

      added the new ARCHIVED enum value to the ////// response property for the response status

    • warning

      added the new ARCHIVED enum value to the ///// response property for the response status

    • warning

      added the new BRAND enum value to the ////// response property for the response status

    • warning

      added the new BRAND enum value to the ///// response property for the response status

    • warning

      added the new CAMPAIGN enum value to the ////// response property for the response status

    • warning

      added the new CAMPAIGN enum value to the ///// response property for the response status

    • warning

      added the new CUSTOM enum value to the ////// response property for the response status

    • warning

      added the new CUSTOM enum value to the ///// response property for the response status

    • warning

      added the new undefined enum value to the ////// response property for the response status

    • warning

      added the new undefined enum value to the ////// response property for the response status

    • warning

      added the new undefined enum value to the ////// response property for the response status

    • warning

      added the new undefined enum value to the ///// response property for the response status

    • warning

      added the new undefined enum value to the ///// response property for the response status

    • warning

      added the new undefined enum value to the ///// response property for the response status

    • info

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

    • info

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