Share your feedback and help shape the Display & Video 360 API product roadmap. Take the Display & Video 360 API Annual Survey for 2022 before it closes on September 30th, 2022.

REST Resource: advertisers.manualTriggers

Stay organized with collections Save and categorize content based on your preferences.

Resource: ManualTrigger

A single manual trigger in Display & Video 360.

JSON representation
{
  "name": string,
  "advertiserId": string,
  "triggerId": string,
  "displayName": string,
  "activationDurationMinutes": string,
  "latestActivationTime": string,
  "state": enum (State)
}
Fields
name

string

Output only. The resource name of the manual trigger.

advertiserId

string (int64 format)

Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.

triggerId

string (int64 format)

Output only. The unique ID of the manual trigger.

displayName

string

Required. The display name of the manual trigger.

Must be UTF-8 encoded with a maximum size of 240 bytes.

activationDurationMinutes

string (int64 format)

Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.

latestActivationTime

string (Timestamp format)

Output only. The timestamp of the trigger's latest activation.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Output only. The state of the manual trigger. Will be set to the INACTIVE state upon creation.

State

The state of a manual trigger.

Enums
STATE_UNSPECIFIED Default value when state is not specified or is unknown in this version.
INACTIVE The trigger is currently inactive and ready to be activated.
ACTIVE The trigger is currently active (activated).

Methods

activate

Activates a manual trigger.

create

Creates a new manual trigger.

deactivate

Deactivates a manual trigger.

get

Gets a manual trigger.

list

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

patch

Updates a manual trigger.