Display & Video 360 API . advertisers . manualTriggers

activate(advertiserId, triggerId, body=None, x__xgafv=None)

Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.

Args:
  advertiserId: string, Required. The ID of the advertiser that the manual trigger belongs. (required)
  triggerId: string, Required. The ID of the manual trigger to activate. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ManualTriggerService.ActivateManualTrigger.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single manual trigger in Display & Video 360.
  "activationDurationMinutes": "A String", # 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.
  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
  "name": "A String", # Output only. The resource name of the manual trigger.
  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
}

close()

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

Creates a new manual trigger. Returns the newly created manual trigger if successful.

Args:
  advertiserId: string, Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. (required)
  body: object, The request body.
    The object takes the form of:

{ # A single manual trigger in Display & Video 360.
  "activationDurationMinutes": "A String", # 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.
  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
  "name": "A String", # Output only. The resource name of the manual trigger.
  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single manual trigger in Display & Video 360.
  "activationDurationMinutes": "A String", # 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.
  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
  "name": "A String", # Output only. The resource name of the manual trigger.
  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
}

deactivate(advertiserId, triggerId, body=None, x__xgafv=None)

Deactivates a manual trigger.

Args:
  advertiserId: string, Required. The ID of the advertiser that the manual trigger belongs. (required)
  triggerId: string, Required. The ID of the manual trigger to deactivate. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ManualTriggerService.DeactivateManualTrigger.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single manual trigger in Display & Video 360.
  "activationDurationMinutes": "A String", # 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.
  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
  "name": "A String", # Output only. The resource name of the manual trigger.
  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
}

get(advertiserId, triggerId, x__xgafv=None)

Gets a manual trigger.

Args:
  advertiserId: string, Required. The ID of the advertiser this manual trigger belongs to. (required)
  triggerId: string, Required. The ID of the manual trigger to fetch. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single manual trigger in Display & Video 360.
  "activationDurationMinutes": "A String", # 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.
  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
  "name": "A String", # Output only. The resource name of the manual trigger.
  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
}

list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.

Args:
  advertiserId: string, Required. The ID of the advertiser that the fetched manual triggers belong to. (required)
  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.
  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`.
  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 next_page_token returned from the previous call to `ListManualTriggers` method. If not specified, the first page of results will be returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "manualTriggers": [ # The list of manual triggers. This list will be absent if empty.
    { # A single manual trigger in Display & Video 360.
      "activationDurationMinutes": "A String", # 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.
      "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
      "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
      "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
      "name": "A String", # Output only. The resource name of the manual trigger.
      "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
      "triggerId": "A String", # Output only. The unique ID of the manual trigger.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListManualTriggers` method to retrieve the next page of results.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    

patch(advertiserId, triggerId, body=None, updateMask=None, x__xgafv=None)

Updates a manual trigger. Returns the updated manual trigger if successful.

Args:
  advertiserId: string, Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. (required)
  triggerId: string, Output only. The unique ID of the manual trigger. (required)
  body: object, The request body.
    The object takes the form of:

{ # A single manual trigger in Display & Video 360.
  "activationDurationMinutes": "A String", # 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.
  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
  "name": "A String", # Output only. The resource name of the manual trigger.
  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
}

  updateMask: string, Required. The mask to control which fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single manual trigger in Display & Video 360.
  "activationDurationMinutes": "A String", # 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.
  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
  "name": "A String", # Output only. The resource name of the manual trigger.
  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
}