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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
<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="mirror_v1.html">Google Mirror API</a> . <a href="mirror_v1.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(id)</a></code></p>
<p class="firstline">Deletes a subscription.</p>
<p class="toc_element">
<code><a href="#insert">insert(body)</a></code></p>
<p class="firstline">Creates a new subscription.</p>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">Retrieves a list of subscriptions for the authenticated user and service.</p>
<p class="toc_element">
<code><a href="#update">update(id, body)</a></code></p>
<p class="firstline">Updates an existing subscription in place.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(id)</code>
<pre>Deletes a subscription.
Args:
id: string, The ID of the subscription. (required)
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body)</code>
<pre>Creates a new subscription.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A subscription to events on a collection.
"kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
"notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
"itemId": "A String", # The ID of the item that generated the notification.
"collection": "A String", # The collection that generated the notification.
"verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
"userToken": "A String", # The user token provided by the service when it subscribed for notifications.
"userActions": [ # A list of actions taken by the user that triggered the notification.
{ # Represents an action taken by the user that triggered a notification.
"type": "A String", # The type of action. The value of this can be:
# - SHARE - the user shared an item.
# - REPLY - the user replied to an item.
# - REPLY_ALL - the user replied to all recipients of an item.
# - CUSTOM - the user selected a custom menu item on the timeline item.
# - DELETE - the user deleted the item.
# - PIN - the user pinned the item.
# - UNPIN - the user unpinned the item.
# - LAUNCH - the user initiated a voice command. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
"payload": "A String", # An optional payload for the action.
#
# For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
},
],
"operation": "A String", # The type of operation that generated the notification.
},
"updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
"collection": "A String", # The collection to subscribe to. Allowed values are:
# - timeline - Changes in the timeline including insertion, deletion, and updates.
# - locations - Location updates.
# - settings - Settings updates.
"verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
"userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
"operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
# - UPDATE - The item has been updated.
# - INSERT - A new item has been inserted.
# - DELETE - The item has been deleted.
# - MENU_ACTION - A custom menu item has been triggered by the user.
"A String",
],
"id": "A String", # The ID of the subscription.
"callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
}
Returns:
An object of the form:
{ # A subscription to events on a collection.
"kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
"notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
"itemId": "A String", # The ID of the item that generated the notification.
"collection": "A String", # The collection that generated the notification.
"verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
"userToken": "A String", # The user token provided by the service when it subscribed for notifications.
"userActions": [ # A list of actions taken by the user that triggered the notification.
{ # Represents an action taken by the user that triggered a notification.
"type": "A String", # The type of action. The value of this can be:
# - SHARE - the user shared an item.
# - REPLY - the user replied to an item.
# - REPLY_ALL - the user replied to all recipients of an item.
# - CUSTOM - the user selected a custom menu item on the timeline item.
# - DELETE - the user deleted the item.
# - PIN - the user pinned the item.
# - UNPIN - the user unpinned the item.
# - LAUNCH - the user initiated a voice command. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
"payload": "A String", # An optional payload for the action.
#
# For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
},
],
"operation": "A String", # The type of operation that generated the notification.
},
"updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
"collection": "A String", # The collection to subscribe to. Allowed values are:
# - timeline - Changes in the timeline including insertion, deletion, and updates.
# - locations - Location updates.
# - settings - Settings updates.
"verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
"userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
"operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
# - UPDATE - The item has been updated.
# - INSERT - A new item has been inserted.
# - DELETE - The item has been deleted.
# - MENU_ACTION - A custom menu item has been triggered by the user.
"A String",
],
"id": "A String", # The ID of the subscription.
"callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list()</code>
<pre>Retrieves a list of subscriptions for the authenticated user and service.
Args:
Returns:
An object of the form:
{ # A list of Subscriptions. This is the response from the server to GET requests on the subscription collection.
"items": [ # The list of subscriptions.
{ # A subscription to events on a collection.
"kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
"notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
"itemId": "A String", # The ID of the item that generated the notification.
"collection": "A String", # The collection that generated the notification.
"verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
"userToken": "A String", # The user token provided by the service when it subscribed for notifications.
"userActions": [ # A list of actions taken by the user that triggered the notification.
{ # Represents an action taken by the user that triggered a notification.
"type": "A String", # The type of action. The value of this can be:
# - SHARE - the user shared an item.
# - REPLY - the user replied to an item.
# - REPLY_ALL - the user replied to all recipients of an item.
# - CUSTOM - the user selected a custom menu item on the timeline item.
# - DELETE - the user deleted the item.
# - PIN - the user pinned the item.
# - UNPIN - the user unpinned the item.
# - LAUNCH - the user initiated a voice command. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
"payload": "A String", # An optional payload for the action.
#
# For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
},
],
"operation": "A String", # The type of operation that generated the notification.
},
"updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
"collection": "A String", # The collection to subscribe to. Allowed values are:
# - timeline - Changes in the timeline including insertion, deletion, and updates.
# - locations - Location updates.
# - settings - Settings updates.
"verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
"userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
"operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
# - UPDATE - The item has been updated.
# - INSERT - A new item has been inserted.
# - DELETE - The item has been deleted.
# - MENU_ACTION - A custom menu item has been triggered by the user.
"A String",
],
"id": "A String", # The ID of the subscription.
"callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
},
],
"kind": "mirror#subscriptionsList", # The type of resource. This is always mirror#subscriptionsList.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(id, body)</code>
<pre>Updates an existing subscription in place.
Args:
id: string, The ID of the subscription. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A subscription to events on a collection.
"kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
"notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
"itemId": "A String", # The ID of the item that generated the notification.
"collection": "A String", # The collection that generated the notification.
"verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
"userToken": "A String", # The user token provided by the service when it subscribed for notifications.
"userActions": [ # A list of actions taken by the user that triggered the notification.
{ # Represents an action taken by the user that triggered a notification.
"type": "A String", # The type of action. The value of this can be:
# - SHARE - the user shared an item.
# - REPLY - the user replied to an item.
# - REPLY_ALL - the user replied to all recipients of an item.
# - CUSTOM - the user selected a custom menu item on the timeline item.
# - DELETE - the user deleted the item.
# - PIN - the user pinned the item.
# - UNPIN - the user unpinned the item.
# - LAUNCH - the user initiated a voice command. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
"payload": "A String", # An optional payload for the action.
#
# For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
},
],
"operation": "A String", # The type of operation that generated the notification.
},
"updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
"collection": "A String", # The collection to subscribe to. Allowed values are:
# - timeline - Changes in the timeline including insertion, deletion, and updates.
# - locations - Location updates.
# - settings - Settings updates.
"verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
"userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
"operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
# - UPDATE - The item has been updated.
# - INSERT - A new item has been inserted.
# - DELETE - The item has been deleted.
# - MENU_ACTION - A custom menu item has been triggered by the user.
"A String",
],
"id": "A String", # The ID of the subscription.
"callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
}
Returns:
An object of the form:
{ # A subscription to events on a collection.
"kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
"notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
"itemId": "A String", # The ID of the item that generated the notification.
"collection": "A String", # The collection that generated the notification.
"verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
"userToken": "A String", # The user token provided by the service when it subscribed for notifications.
"userActions": [ # A list of actions taken by the user that triggered the notification.
{ # Represents an action taken by the user that triggered a notification.
"type": "A String", # The type of action. The value of this can be:
# - SHARE - the user shared an item.
# - REPLY - the user replied to an item.
# - REPLY_ALL - the user replied to all recipients of an item.
# - CUSTOM - the user selected a custom menu item on the timeline item.
# - DELETE - the user deleted the item.
# - PIN - the user pinned the item.
# - UNPIN - the user unpinned the item.
# - LAUNCH - the user initiated a voice command. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
"payload": "A String", # An optional payload for the action.
#
# For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
},
],
"operation": "A String", # The type of operation that generated the notification.
},
"updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
"collection": "A String", # The collection to subscribe to. Allowed values are:
# - timeline - Changes in the timeline including insertion, deletion, and updates.
# - locations - Location updates.
# - settings - Settings updates.
"verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
"userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
"operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
# - UPDATE - The item has been updated.
# - INSERT - A new item has been inserted.
# - DELETE - The item has been deleted.
# - MENU_ACTION - A custom menu item has been triggered by the user.
"A String",
],
"id": "A String", # The ID of the subscription.
"callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
}</pre>
</div>
</body></html>
|
