GOgoogle
advertisers

GET /v4/advertisers/{advertisersId}/adGroups

Lists ad groups.

Request

  • Base URL
    https://displayvideo.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/display-video
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/display-video
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

advertisersIdstring required

Query parameters

filterstring

Optional. Allows filtering by custom ad group 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 properties: * adGroupId * displayName * entityStatus * lineItemId * adGroupFormat Examples: * All ad groups under an line item: lineItemId="1234" * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM ad groups under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM" 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 200. 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 ListAdGroups method. If not specified, the first page of results will be returned.

Response

Successful response

nextPageTokenstring

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListAdGroups method to retrieve the next page of results.

Changes

No recorded changes to this operation across all 7 revisions of this API.