blob: b63f40e34e9d050e1a110206b3c23093871e0a25 [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
75<h1><a href="alertcenter_v1beta1.html">G Suite Alert Center API</a> . <a href="alertcenter_v1beta1.alerts.html">alerts</a> . <a href="alertcenter_v1beta1.alerts.feedback.html">feedback</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(alertId, body, customerId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates new feedback for an alert. Attempting to create a feedback for</p>
80<p class="toc_element">
81 <code><a href="#list">list(alertId, customerId=None, x__xgafv=None, filter=None)</a></code></p>
82<p class="firstline">Lists all the feedback for an alert. Attempting to list feedbacks for</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="create">create(alertId, body, customerId=None, x__xgafv=None)</code>
86 <pre>Creates new feedback for an alert. Attempting to create a feedback for
87a non-existent alert returns `NOT_FOUND` error.
88
89Args:
90 alertId: string, Required. The identifier of the alert this feedback belongs to. (required)
91 body: object, The request body. (required)
92 The object takes the form of:
93
94{ # A customer feedback about an alert.
95 "feedbackId": "A String", # Output only. The unique identifier for the feedback.
96 "alertId": "A String", # Output only. The alert identifier.
97 "createTime": "A String", # Output only. The time this feedback was created.
98 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
99 "type": "A String", # Required. The type of the feedback.
100 "email": "A String", # Output only. The email of the user that provided the feedback.
101 }
102
103 customerId: string, Optional. The unique identifier of the G Suite organization account of the
104customer the alert is associated with.
105Inferred from the caller identity if not provided.
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
114 { # A customer feedback about an alert.
115 "feedbackId": "A String", # Output only. The unique identifier for the feedback.
116 "alertId": "A String", # Output only. The alert identifier.
117 "createTime": "A String", # Output only. The time this feedback was created.
118 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
119 "type": "A String", # Required. The type of the feedback.
120 "email": "A String", # Output only. The email of the user that provided the feedback.
121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="list">list(alertId, customerId=None, x__xgafv=None, filter=None)</code>
126 <pre>Lists all the feedback for an alert. Attempting to list feedbacks for
127a non-existent alert returns `NOT_FOUND` error.
128
129Args:
130 alertId: string, Required. The alert identifier.
131The "-" wildcard could be used to represent all alerts. (required)
132 customerId: string, Optional. The unique identifier of the G Suite organization account of the
133customer the alert feedback are associated with.
134Inferred from the caller identity if not provided.
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139 filter: string, Optional. A query string for filtering alert feedback results.
140For more details, see [Query
141filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported
142query filter
143fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).
144
145Returns:
146 An object of the form:
147
148 { # Response message for an alert feedback listing request.
149 "feedback": [ # The list of alert feedback.
150 # Feedback entries for each alert are ordered by creation time descending.
151 { # A customer feedback about an alert.
152 "feedbackId": "A String", # Output only. The unique identifier for the feedback.
153 "alertId": "A String", # Output only. The alert identifier.
154 "createTime": "A String", # Output only. The time this feedback was created.
155 "customerId": "A String", # Output only. The unique identifier of the Google account of the customer.
156 "type": "A String", # Required. The type of the feedback.
157 "email": "A String", # Output only. The email of the user that provided the feedback.
158 },
159 ],
160 }</pre>
161</div>
162
163</body></html>