Google Forms API . forms . watches

close()

Close httplib2 connections.

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

Create a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form limit is one watch per Watch.EventType. A watch expires seven days after it is created (see Watch.expire_time).

Args:
  formId: string, Required. ID of the Form to watch. (required)
  body: object, The request body.
    The object takes the form of:

{ # Create a new watch.
  "watch": { # A watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification's attributes will include a `formId` key that has the ID of the watched form and an `eventType` key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew # Required. The watch object. No ID should be set on this object; use `watch_id` instead.
    "createTime": "A String", # Output only. Timestamp of when this was created.
    "errorType": "A String", # Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information.
    "eventType": "A String", # Required. Which event type to watch for.
    "expireTime": "A String", # Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.
    "id": "A String", # Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.
    "state": "A String", # Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`.
    "target": { # The target for notification delivery. # Required. Where to send the notification.
      "topic": { # A Pub/Sub topic. # A Pub/Sub topic. To receive notifications, the topic must grant publish privileges to the Forms service account `serviceAccount:forms-notifications@system.gserviceaccount.com`. Only the project that owns a topic may create a watch with it. Pub/Sub delivery guarantees should be considered.
        "topicName": "A String", # Required. A fully qualified Pub/Sub topic name to publish the events to. This topic must be owned by the calling project and already exist in Pub/Sub.
      },
    },
  },
  "watchId": "A String", # The ID to use for the watch. If specified, the ID must not already be in use. If not specified, an ID is generated. This value should be 4-63 characters, and valid characters are /a-z-/.
}

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

Returns:
  An object of the form:

    { # A watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification's attributes will include a `formId` key that has the ID of the watched form and an `eventType` key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew
  "createTime": "A String", # Output only. Timestamp of when this was created.
  "errorType": "A String", # Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information.
  "eventType": "A String", # Required. Which event type to watch for.
  "expireTime": "A String", # Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.
  "id": "A String", # Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.
  "state": "A String", # Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`.
  "target": { # The target for notification delivery. # Required. Where to send the notification.
    "topic": { # A Pub/Sub topic. # A Pub/Sub topic. To receive notifications, the topic must grant publish privileges to the Forms service account `serviceAccount:forms-notifications@system.gserviceaccount.com`. Only the project that owns a topic may create a watch with it. Pub/Sub delivery guarantees should be considered.
      "topicName": "A String", # Required. A fully qualified Pub/Sub topic name to publish the events to. This topic must be owned by the calling project and already exist in Pub/Sub.
    },
  },
}

delete(formId, watchId, x__xgafv=None)

Delete a watch.

Args:
  formId: string, Required. The ID of the Form. (required)
  watchId: string, Required. The ID of the Watch to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

list(formId, x__xgafv=None)

Return a list of the watches owned by the invoking project. The maximum number of watches is two: For each invoker, the limit is one for each event type per form.

Args:
  formId: string, Required. ID of the Form whose watches to list. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response of a ListWatchesRequest.
  "watches": [ # The returned watches.
    { # A watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification's attributes will include a `formId` key that has the ID of the watched form and an `eventType` key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew
      "createTime": "A String", # Output only. Timestamp of when this was created.
      "errorType": "A String", # Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information.
      "eventType": "A String", # Required. Which event type to watch for.
      "expireTime": "A String", # Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.
      "id": "A String", # Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.
      "state": "A String", # Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`.
      "target": { # The target for notification delivery. # Required. Where to send the notification.
        "topic": { # A Pub/Sub topic. # A Pub/Sub topic. To receive notifications, the topic must grant publish privileges to the Forms service account `serviceAccount:forms-notifications@system.gserviceaccount.com`. Only the project that owns a topic may create a watch with it. Pub/Sub delivery guarantees should be considered.
          "topicName": "A String", # Required. A fully qualified Pub/Sub topic name to publish the events to. This topic must be owned by the calling project and already exist in Pub/Sub.
        },
      },
    },
  ],
}

renew(formId, watchId, body=None, x__xgafv=None)

Renew an existing watch for seven days. The state of the watch after renewal is `ACTIVE`, and the `expire_time` is seven days from the renewal. Renewing a watch in an error state (e.g. `SUSPENDED`) succeeds if the error is no longer present, but fail otherwise. After a watch has expired, RenewWatch returns `NOT_FOUND`.

Args:
  formId: string, Required. The ID of the Form. (required)
  watchId: string, Required. The ID of the Watch to renew. (required)
  body: object, The request body.
    The object takes the form of:

{ # Renew an existing Watch for seven days.
}

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

Returns:
  An object of the form:

    { # A watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification's attributes will include a `formId` key that has the ID of the watched form and an `eventType` key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew
  "createTime": "A String", # Output only. Timestamp of when this was created.
  "errorType": "A String", # Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information.
  "eventType": "A String", # Required. Which event type to watch for.
  "expireTime": "A String", # Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.
  "id": "A String", # Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.
  "state": "A String", # Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`.
  "target": { # The target for notification delivery. # Required. Where to send the notification.
    "topic": { # A Pub/Sub topic. # A Pub/Sub topic. To receive notifications, the topic must grant publish privileges to the Forms service account `serviceAccount:forms-notifications@system.gserviceaccount.com`. Only the project that owns a topic may create a watch with it. Pub/Sub delivery guarantees should be considered.
      "topicName": "A String", # Required. A fully qualified Pub/Sub topic name to publish the events to. This topic must be owned by the calling project and already exist in Pub/Sub.
    },
  },
}