Method: advertisers.campaigns.list

Lists campaigns in an advertiser.

The order is defined by the orderBy parameter. If a filter by entityStatus is not specified, campaigns with ENTITY_STATUS_ARCHIVED will not be included in the results.

HTTP request

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/campaigns

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

The ID of the advertiser to list campaigns for.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 100. If unspecified will default to 100.

pageToken

string

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

orderBy

string

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.

filter

string

Allows filtering by campaign properties.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • The operator must be EQUALS (=).
  • Supported fields:
    • entityStatus

Examples:

  • All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED campaigns under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")

The length of this field should be no more than 500 characters.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Fields
campaigns[]

object (Campaign)

The list of campaigns.

This list will be absent if empty.

nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to campaigns.list method to retrieve the next page of results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

For more information, see the OAuth 2.0 Overview.