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
|
<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="alertcenter_v1beta1.html">G Suite Alert Center API</a> . <a href="alertcenter_v1beta1.v1beta1.html">v1beta1</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#getSettings">getSettings(customerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns customer-level settings.</p>
<p class="toc_element">
<code><a href="#updateSettings">updateSettings(body, customerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the customer-level settings.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="getSettings">getSettings(customerId=None, x__xgafv=None)</code>
<pre>Returns customer-level settings.
Args:
customerId: string, Optional. The unique identifier of the G Suite organization account of the
customer the alert settings are associated with.
Inferred from the caller identity if not provided.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Customer-level settings.
"notifications": [ # The list of notifications.
{ # Settings for callback notifications.
# For more details see [G Suite Alert
# Notification](/admin-sdk/alertcenter/guides/notifications).
"cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
#
# To register for notifications, the owner of the topic must grant
# `alerts-api-push-notifications@system.gserviceaccount.com` the
# `projects.topics.publish` permission.
"payloadFormat": "A String", # Optional. The format of the payload that would be sent.
# If not specified the format will be JSON.
"topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
# (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="updateSettings">updateSettings(body, customerId=None, x__xgafv=None)</code>
<pre>Updates the customer-level settings.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # Customer-level settings.
"notifications": [ # The list of notifications.
{ # Settings for callback notifications.
# For more details see [G Suite Alert
# Notification](/admin-sdk/alertcenter/guides/notifications).
"cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
#
# To register for notifications, the owner of the topic must grant
# `alerts-api-push-notifications@system.gserviceaccount.com` the
# `projects.topics.publish` permission.
"payloadFormat": "A String", # Optional. The format of the payload that would be sent.
# If not specified the format will be JSON.
"topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
# (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
},
},
],
}
customerId: string, Optional. The unique identifier of the G Suite organization account of the
customer the alert settings are associated with.
Inferred from the caller identity if not provided.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Customer-level settings.
"notifications": [ # The list of notifications.
{ # Settings for callback notifications.
# For more details see [G Suite Alert
# Notification](/admin-sdk/alertcenter/guides/notifications).
"cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
#
# To register for notifications, the owner of the topic must grant
# `alerts-api-push-notifications@system.gserviceaccount.com` the
# `projects.topics.publish` permission.
"payloadFormat": "A String", # Optional. The format of the payload that would be sent.
# If not specified the format will be JSON.
"topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
# (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
},
},
],
}</pre>
</div>
</body></html>
|