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
|
<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="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.notifications.html">notifications</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(customer, notificationId)</a></code></p>
<p class="firstline">Deletes a notification</p>
<p class="toc_element">
<code><a href="#get">get(customer, notificationId)</a></code></p>
<p class="firstline">Retrieves a notification.</p>
<p class="toc_element">
<code><a href="#list">list(customer, language=None, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves a list of notifications.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(customer, notificationId, body)</a></code></p>
<p class="firstline">Updates a notification. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(customer, notificationId, body)</a></code></p>
<p class="firstline">Updates a notification.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(customer, notificationId)</code>
<pre>Deletes a notification
Args:
customer: string, The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource. (required)
notificationId: string, The unique ID of the notification. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customer, notificationId)</code>
<pre>Retrieves a notification.
Args:
customer: string, The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource. (required)
notificationId: string, The unique ID of the notification. (required)
Returns:
An object of the form:
{ # Template for a notification resource.
"body": "A String", # Body of the notification (Read-only)
"kind": "admin#directory#notification", # The type of the resource.
"etag": "A String", # ETag of the resource.
"sendTime": "A String", # Time at which notification was sent (Read-only)
"notificationId": "A String",
"fromAddress": "A String", # Address from which the notification is received (Read-only)
"isUnread": True or False, # Boolean indicating whether the notification is unread or not.
"subject": "A String", # Subject of the notification (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customer, language=None, pageToken=None, maxResults=None)</code>
<pre>Retrieves a list of notifications.
Args:
customer: string, The unique ID for the customer's Google account. (required)
language: string, The ISO 639-1 code of the language notifications are returned in. The default is English (en).
pageToken: string, The token to specify the page of results to retrieve.
maxResults: integer, Maximum number of notifications to return per page. The default is 100.
Returns:
An object of the form:
{ # Template for notifications list response.
"nextPageToken": "A String", # Token for fetching the next page of notifications.
"items": [ # List of notifications in this page.
{ # Template for a notification resource.
"body": "A String", # Body of the notification (Read-only)
"kind": "admin#directory#notification", # The type of the resource.
"etag": "A String", # ETag of the resource.
"sendTime": "A String", # Time at which notification was sent (Read-only)
"notificationId": "A String",
"fromAddress": "A String", # Address from which the notification is received (Read-only)
"isUnread": True or False, # Boolean indicating whether the notification is unread or not.
"subject": "A String", # Subject of the notification (Read-only)
},
],
"kind": "admin#directory#notifications", # The type of the resource.
"etag": "A String", # ETag of the resource.
"unreadNotificationsCount": 42, # Number of unread notification for the domain.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>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.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customer, notificationId, body)</code>
<pre>Updates a notification. This method supports patch semantics.
Args:
customer: string, The unique ID for the customer's Google account. (required)
notificationId: string, The unique ID of the notification. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Template for a notification resource.
"body": "A String", # Body of the notification (Read-only)
"kind": "admin#directory#notification", # The type of the resource.
"etag": "A String", # ETag of the resource.
"sendTime": "A String", # Time at which notification was sent (Read-only)
"notificationId": "A String",
"fromAddress": "A String", # Address from which the notification is received (Read-only)
"isUnread": True or False, # Boolean indicating whether the notification is unread or not.
"subject": "A String", # Subject of the notification (Read-only)
}
Returns:
An object of the form:
{ # Template for a notification resource.
"body": "A String", # Body of the notification (Read-only)
"kind": "admin#directory#notification", # The type of the resource.
"etag": "A String", # ETag of the resource.
"sendTime": "A String", # Time at which notification was sent (Read-only)
"notificationId": "A String",
"fromAddress": "A String", # Address from which the notification is received (Read-only)
"isUnread": True or False, # Boolean indicating whether the notification is unread or not.
"subject": "A String", # Subject of the notification (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customer, notificationId, body)</code>
<pre>Updates a notification.
Args:
customer: string, The unique ID for the customer's Google account. (required)
notificationId: string, The unique ID of the notification. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Template for a notification resource.
"body": "A String", # Body of the notification (Read-only)
"kind": "admin#directory#notification", # The type of the resource.
"etag": "A String", # ETag of the resource.
"sendTime": "A String", # Time at which notification was sent (Read-only)
"notificationId": "A String",
"fromAddress": "A String", # Address from which the notification is received (Read-only)
"isUnread": True or False, # Boolean indicating whether the notification is unread or not.
"subject": "A String", # Subject of the notification (Read-only)
}
Returns:
An object of the form:
{ # Template for a notification resource.
"body": "A String", # Body of the notification (Read-only)
"kind": "admin#directory#notification", # The type of the resource.
"etag": "A String", # ETag of the resource.
"sendTime": "A String", # Time at which notification was sent (Read-only)
"notificationId": "A String",
"fromAddress": "A String", # Address from which the notification is received (Read-only)
"isUnread": True or False, # Boolean indicating whether the notification is unread or not.
"subject": "A String", # Subject of the notification (Read-only)
}</pre>
</div>
</body></html>
|
