1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(formId, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#delete">delete(formId, watchId, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a watch.</p>
<p class="toc_element">
<code><a href="#list">list(formId, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#renew">renew(formId, watchId, body=None, x__xgafv=None)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(formId, body=None, x__xgafv=None)</code>
<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).
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.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(formId, watchId, x__xgafv=None)</code>
<pre>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); }
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(formId, x__xgafv=None)</code>
<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.
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.
},
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="renew">renew(formId, watchId, body=None, x__xgafv=None)</code>
<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`.
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.
},
},
}</pre>
</div>
</body></html>
|
