Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / alertcenter_v1beta1.v1beta1.html
blob: a4246f4c9167edb7b40e027ba766c5d7569a84ca [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="alertcenter_v1beta1.html">G Suite Alert Center API</a> . <a href="alertcenter_v1beta1.v1beta1.html">v1beta1</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#getSettings">getSettings(customerId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Returns customer-level settings.</p>
80<p class="toc_element">
81 <code><a href="#updateSettings">updateSettings(body, customerId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Updates the customer-level settings.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="getSettings">getSettings(customerId=None, x__xgafv=None)</code>
86 <pre>Returns customer-level settings.
87
88Args:
89 customerId: string, Optional. The unique identifier of the G Suite organization account of the
90customer the alert settings are associated with.
91Inferred from the caller identity if not provided.
92 x__xgafv: string, V1 error format.
93 Allowed values
94 1 - v1 error format
95 2 - v2 error format
96
97Returns:
98 An object of the form:
99
100 { # Customer-level settings.
101 "notifications": [ # The list of notifications.
102 { # Settings for callback notifications.
103 # For more details see [G Suite Alert
104 # Notification](/admin-sdk/alertcenter/guides/notifications).
105 "cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
106 #
107 # To register for notifications, the owner of the topic must grant
108 # `alerts-api-push-notifications@system.gserviceaccount.com` the
109 # `projects.topics.publish` permission.
110 "payloadFormat": "A String", # Optional. The format of the payload that would be sent.
111 # If not specified the format will be JSON.
112 "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
113 # (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
114 },
115 },
116 ],
117 }</pre>
118</div>
119
120<div class="method">
121 <code class="details" id="updateSettings">updateSettings(body, customerId=None, x__xgafv=None)</code>
122 <pre>Updates the customer-level settings.
123
124Args:
125 body: object, The request body. (required)
126 The object takes the form of:
127
128{ # Customer-level settings.
129 "notifications": [ # The list of notifications.
130 { # Settings for callback notifications.
131 # For more details see [G Suite Alert
132 # Notification](/admin-sdk/alertcenter/guides/notifications).
133 "cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
134 #
135 # To register for notifications, the owner of the topic must grant
136 # `alerts-api-push-notifications@system.gserviceaccount.com` the
137 # `projects.topics.publish` permission.
138 "payloadFormat": "A String", # Optional. The format of the payload that would be sent.
139 # If not specified the format will be JSON.
140 "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
141 # (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
142 },
143 },
144 ],
145}
146
147 customerId: string, Optional. The unique identifier of the G Suite organization account of the
148customer the alert settings are associated with.
149Inferred from the caller identity if not provided.
150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
154
155Returns:
156 An object of the form:
157
158 { # Customer-level settings.
159 "notifications": [ # The list of notifications.
160 { # Settings for callback notifications.
161 # For more details see [G Suite Alert
162 # Notification](/admin-sdk/alertcenter/guides/notifications).
163 "cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
164 #
165 # To register for notifications, the owner of the topic must grant
166 # `alerts-api-push-notifications@system.gserviceaccount.com` the
167 # `projects.topics.publish` permission.
168 "payloadFormat": "A String", # Optional. The format of the payload that would be sent.
169 # If not specified the format will be JSON.
170 "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
171 # (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
172 },
173 },
174 ],
175 }</pre>
176</div>
177
178</body></html>