advertisers

Changed on

Lists ad group ads.

get/v4/advertisers/{+advertiserId}/adGroupAds

Request

  • Base URL: https://displayvideo.googleapis.com
  • URL: https://displayvideo.googleapis.com/v4/advertisers/{+advertiserId}/adGroupAds
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/display-video) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/display-video)

Path parameters

advertiserIdstring required

Required. The ID of the advertiser the ads belong to.

Query parameters

filterstring

Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND. * A restriction has the form of {field} {operator} {value}. * All fields must use the EQUALS (=) operator. Supported fields: * adGroupId * displayName * entityStatus * adGroupAdId * parentCreativeId Examples: * All ad group ads under an ad group: adGroupId="1234" * All ad group ads under an ad group with an entityStatus of ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345" * All ad group ads under a parent creative: parentCreativeId="12345" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

orderBystring

Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

pageSizeinteger

Optional. Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageTokenstring

Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdGroupAds method. If not specified, the first page of results will be returned.

Response

Successful response

Changes

  • 52cdb4885336Revision changes
    • breaking

      removed the media type */* for the response with the status

  • 0f73dc785c76Revision changes
    • info

      the response optional property //// became read-only for the status

    • info

      the response optional property //// became read-only for the status

    • info

      the response optional property ///// became read-only for the status

    • info

      the response optional property ///// became read-only for the status

    • info

      the response optional property //// became read-only for the status

    • info

      the response optional property ///// became read-only for the status

    • info

      the response optional property ///// became read-only for the status

    • info

      the response optional property //// became read-only for the status

    • info

      the response optional property //// became read-only for the status

    • info

      the response optional property ///// became read-only for the status

    • info

      the response optional property //// became read-only for the status

    • info

      the response optional property /// became read-only for the status

    • info

      the response optional property /// became read-only for the status

    • info

      the response optional property ///// became read-only for the status