blob: 8f079e01eea81684412295e3c4e7133740b750d4 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080075<h1><a href="alertcenter_v1beta1.html">Google Workspace Alert Center API</a> . <a href="alertcenter_v1beta1.alerts.html">alerts</a> . <a href="alertcenter_v1beta1.alerts.feedback.html">feedback</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070080<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070081 <code><a href="#create">create(alertId, body=None, customerId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns `NOT_FOUND` error. Attempting to create a feedback for an alert that is marked for deletion returns `FAILED_PRECONDITION' error.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#list">list(alertId, customerId=None, filter=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns `NOT_FOUND` error.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code class="details" id="create">create(alertId, body=None, customerId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <pre>Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns `NOT_FOUND` error. Attempting to create a feedback for an alert that is marked for deletion returns `FAILED_PRECONDITION&#x27; error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095
96Args:
97 alertId: string, Required. The identifier of the alert this feedback belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -070098 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099 The object takes the form of:
100
101{ # A customer feedback about an alert.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800102 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800103 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this feedback was created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800104 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800105 &quot;email&quot;: &quot;A String&quot;, # Output only. The email of the user that provided the feedback.
106 &quot;feedbackId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the feedback.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800107 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the feedback.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800108}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800110 customerId: string, Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # A customer feedback about an alert.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
121 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this feedback was created.
122 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
123 &quot;email&quot;: &quot;A String&quot;, # Output only. The email of the user that provided the feedback.
124 &quot;feedbackId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the feedback.
125 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the feedback.
126}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700127</div>
128
129<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800130 <code class="details" id="list">list(alertId, customerId=None, filter=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700131 <pre>Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns `NOT_FOUND` error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700132
133Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700134 alertId: string, Required. The alert identifier. The &quot;-&quot; wildcard could be used to represent all alerts. (required)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800135 customerId: string, Optional. The unique identifier of the Google Workspace organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.
yoshi-code-bot38664e82021-05-29 00:50:02 -0700136 filter: string, Optional. A query string for filtering alert feedback results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).
Bu Sun Kim65020912020-05-20 12:08:20 -0700137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141
142Returns:
143 An object of the form:
144
145 { # Response message for an alert feedback listing request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800146 &quot;feedback&quot;: [ # The list of alert feedback. Feedback entries for each alert are ordered by creation time descending.
147 { # A customer feedback about an alert.
148 &quot;alertId&quot;: &quot;A String&quot;, # Output only. The alert identifier.
149 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this feedback was created.
150 &quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the Google account of the customer.
151 &quot;email&quot;: &quot;A String&quot;, # Output only. The email of the user that provided the feedback.
152 &quot;feedbackId&quot;: &quot;A String&quot;, # Output only. The unique identifier for the feedback.
153 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the feedback.
154 },
155 ],
156}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700157</div>
158
159</body></html>