| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<h1><a href="forms_v1.html">Google Forms API</a> . <a href="forms_v1.forms.html">forms</a> . <a href="forms_v1.forms.watches.html">watches</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#create">create(formId, body=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">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).</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#delete">delete(formId, watchId, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Delete a watch.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#list">list(formId, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">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.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#renew">renew(formId, watchId, body=None, x__xgafv=None)</a></code></p> |
| 91 |
<p class="firstline">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`.</p> |
| 92 |
<h3>Method Details</h3> |
| 93 |
<div class="method"> |
| 94 |
<code class="details" id="close">close()</code> |
| 95 |
<pre>Close httplib2 connections.</pre> |
| 96 |
</div> |
| 97 |
|
| 98 |
<div class="method"> |
| 99 |
<code class="details" id="create">create(formId, body=None, x__xgafv=None)</code> |
| 100 |
<pre>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). |
| 101 |
|
| 102 |
Args: |
| 103 |
formId: string, Required. ID of the Form to watch. (required) |
| 104 |
body: object, The request body. |
| 105 |
The object takes the form of: |
| 106 |
|
| 107 |
{ # Create a new watch. |
| 108 |
"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. |
| 109 |
"createTime": "A String", # Output only. Timestamp of when this was created. |
| 110 |
"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. |
| 111 |
"eventType": "A String", # Required. Which event type to watch for. |
| 112 |
"expireTime": "A String", # Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future. |
| 113 |
"id": "A String", # Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id. |
| 114 |
"state": "A String", # Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`. |
| 115 |
"target": { # The target for notification delivery. # Required. Where to send the notification. |
| 116 |
"topic": { # A Pub/Sub topic. # A Pub/Sub topic. To receive notifications, the topic must grant publish privileges to the Forms service account `serviceAccount:[email protected]`. Only the project that owns a topic may create a watch with it. Pub/Sub delivery guarantees should be considered. |
| 117 |
"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. |
| 118 |
}, |
| 119 |
}, |
| 120 |
}, |
| 121 |
"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-/. |
| 122 |
} |
| 123 |
|
| 124 |
x__xgafv: string, V1 error format. |
| 125 |
Allowed values |
| 126 |
1 - v1 error format |
| 127 |
2 - v2 error format |
| 128 |
|
| 129 |
Returns: |
| 130 |
An object of the form: |
| 131 |
|
| 132 |
{ # 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 |
| 133 |
"createTime": "A String", # Output only. Timestamp of when this was created. |
| 134 |
"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. |
| 135 |
"eventType": "A String", # Required. Which event type to watch for. |
| 136 |
"expireTime": "A String", # Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future. |
| 137 |
"id": "A String", # Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id. |
| 138 |
"state": "A String", # Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`. |
| 139 |
"target": { # The target for notification delivery. # Required. Where to send the notification. |
| 140 |
"topic": { # A Pub/Sub topic. # A Pub/Sub topic. To receive notifications, the topic must grant publish privileges to the Forms service account `serviceAccount:[email protected]`. Only the project that owns a topic may create a watch with it. Pub/Sub delivery guarantees should be considered. |
| 141 |
"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. |
| 142 |
}, |
| 143 |
}, |
| 144 |
}</pre> |
| 145 |
</div> |
| 146 |
|
| 147 |
<div class="method"> |
| 148 |
<code class="details" id="delete">delete(formId, watchId, x__xgafv=None)</code> |
| 149 |
<pre>Delete a watch. |
| 150 |
|
| 151 |
Args: |
| 152 |
formId: string, Required. The ID of the Form. (required) |
| 153 |
watchId: string, Required. The ID of the Watch to delete. (required) |
| 154 |
x__xgafv: string, V1 error format. |
| 155 |
Allowed values |
| 156 |
1 - v1 error format |
| 157 |
2 - v2 error format |
| 158 |
|
| 159 |
Returns: |
| 160 |
An object of the form: |
| 161 |
|
| 162 |
{ # 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); } |
| 163 |
}</pre> |
| 164 |
</div> |
| 165 |
|
| 166 |
<div class="method"> |
| 167 |
<code class="details" id="list">list(formId, x__xgafv=None)</code> |
| 168 |
<pre>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. |
| 169 |
|
| 170 |
Args: |
| 171 |
formId: string, Required. ID of the Form whose watches to list. (required) |
| 172 |
x__xgafv: string, V1 error format. |
| 173 |
Allowed values |
| 174 |
1 - v1 error format |
| 175 |
2 - v2 error format |
| 176 |
|
| 177 |
Returns: |
| 178 |
An object of the form: |
| 179 |
|
| 180 |
{ # The response of a ListWatchesRequest. |
| 181 |
"watches": [ # The returned watches. |
| 182 |
{ # 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 |
| 183 |
"createTime": "A String", # Output only. Timestamp of when this was created. |
| 184 |
"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. |
| 185 |
"eventType": "A String", # Required. Which event type to watch for. |
| 186 |
"expireTime": "A String", # Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future. |
| 187 |
"id": "A String", # Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id. |
| 188 |
"state": "A String", # Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`. |
| 189 |
"target": { # The target for notification delivery. # Required. Where to send the notification. |
| 190 |
"topic": { # A Pub/Sub topic. # A Pub/Sub topic. To receive notifications, the topic must grant publish privileges to the Forms service account `serviceAccount:[email protected]`. Only the project that owns a topic may create a watch with it. Pub/Sub delivery guarantees should be considered. |
| 191 |
"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. |
| 192 |
}, |
| 193 |
}, |
| 194 |
}, |
| 195 |
], |
| 196 |
}</pre> |
| 197 |
</div> |
| 198 |
|
| 199 |
<div class="method"> |
| 200 |
<code class="details" id="renew">renew(formId, watchId, body=None, x__xgafv=None)</code> |
| 201 |
<pre>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`. |
| 202 |
|
| 203 |
Args: |
| 204 |
formId: string, Required. The ID of the Form. (required) |
| 205 |
watchId: string, Required. The ID of the Watch to renew. (required) |
| 206 |
body: object, The request body. |
| 207 |
The object takes the form of: |
| 208 |
|
| 209 |
{ # Renew an existing Watch for seven days. |
| 210 |
} |
| 211 |
|
| 212 |
x__xgafv: string, V1 error format. |
| 213 |
Allowed values |
| 214 |
1 - v1 error format |
| 215 |
2 - v2 error format |
| 216 |
|
| 217 |
Returns: |
| 218 |
An object of the form: |
| 219 |
|
| 220 |
{ # 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 |
| 221 |
"createTime": "A String", # Output only. Timestamp of when this was created. |
| 222 |
"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. |
| 223 |
"eventType": "A String", # Required. Which event type to watch for. |
| 224 |
"expireTime": "A String", # Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future. |
| 225 |
"id": "A String", # Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id. |
| 226 |
"state": "A String", # Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`. |
| 227 |
"target": { # The target for notification delivery. # Required. Where to send the notification. |
| 228 |
"topic": { # A Pub/Sub topic. # A Pub/Sub topic. To receive notifications, the topic must grant publish privileges to the Forms service account `serviceAccount:[email protected]`. Only the project that owns a topic may create a watch with it. Pub/Sub delivery guarantees should be considered. |
| 229 |
"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. |
| 230 |
}, |
| 231 |
}, |
| 232 |
}</pre> |
| 233 |
</div> |
| 234 |
|
| 235 |
</body></html> |