Method: advertisers.manualTriggers.list

Lists manual triggers that are accessible to the current user for a given advertiser ID.

The order is defined by the orderBy parameter.

A single advertiserId is required.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the advertiser that the fetched manual triggers belong to.

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 manualTriggers.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)
  • state

The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

filter

string

Allows filtering by manual trigger 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:
    • displayName
    • state Examples:
  • All active manual triggers under an advertiser: state="ACTIVE"

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
{
  "manualTriggers": [
    {
      object (ManualTrigger)
    }
  ],
  "nextPageToken": string
}
Fields
manualTriggers[]

object (ManualTrigger)

The list of manual triggers.

This list will be absent if empty.

nextPageToken

string

A token to retrieve the next page of results. Pass this value in the [pageToken][ListManualTriggersResponse.page_token] field in the subsequent call to manualTriggers.list method to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.