Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 78 | <code><a href="#create">create(alertId, body=None, customerId=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 85 | <code class="details" id="create">create(alertId, body=None, customerId=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | <pre>Creates new feedback for an alert. Attempting to create a feedback for |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 87 | a non-existent alert returns `NOT_FOUND` error. Attempting to create a |
| 88 | feedback for an alert that is marked for deletion returns |
| 89 | `FAILED_PRECONDITION' error. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 90 | |
| 91 | Args: |
| 92 | alertId: string, Required. The identifier of the alert this feedback belongs to. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 93 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | The object takes the form of: |
| 95 | |
| 96 | { # A customer feedback about an alert. |
| 97 | "feedbackId": "A String", # Output only. The unique identifier for the feedback. |
| 98 | "alertId": "A String", # Output only. The alert identifier. |
| 99 | "createTime": "A String", # Output only. The time this feedback was created. |
| 100 | "customerId": "A String", # Output only. The unique identifier of the Google account of the customer. |
| 101 | "type": "A String", # Required. The type of the feedback. |
| 102 | "email": "A String", # Output only. The email of the user that provided the feedback. |
| 103 | } |
| 104 | |
| 105 | customerId: string, Optional. The unique identifier of the G Suite organization account of the |
| 106 | customer the alert is associated with. |
| 107 | Inferred from the caller identity if not provided. |
| 108 | x__xgafv: string, V1 error format. |
| 109 | Allowed values |
| 110 | 1 - v1 error format |
| 111 | 2 - v2 error format |
| 112 | |
| 113 | Returns: |
| 114 | An object of the form: |
| 115 | |
| 116 | { # A customer feedback about an alert. |
| 117 | "feedbackId": "A String", # Output only. The unique identifier for the feedback. |
| 118 | "alertId": "A String", # Output only. The alert identifier. |
| 119 | "createTime": "A String", # Output only. The time this feedback was created. |
| 120 | "customerId": "A String", # Output only. The unique identifier of the Google account of the customer. |
| 121 | "type": "A String", # Required. The type of the feedback. |
| 122 | "email": "A String", # Output only. The email of the user that provided the feedback. |
| 123 | }</pre> |
| 124 | </div> |
| 125 | |
| 126 | <div class="method"> |
| 127 | <code class="details" id="list">list(alertId, customerId=None, x__xgafv=None, filter=None)</code> |
| 128 | <pre>Lists all the feedback for an alert. Attempting to list feedbacks for |
| 129 | a non-existent alert returns `NOT_FOUND` error. |
| 130 | |
| 131 | Args: |
| 132 | alertId: string, Required. The alert identifier. |
| 133 | The "-" wildcard could be used to represent all alerts. (required) |
| 134 | customerId: string, Optional. The unique identifier of the G Suite organization account of the |
| 135 | customer the alert feedback are associated with. |
| 136 | Inferred from the caller identity if not provided. |
| 137 | x__xgafv: string, V1 error format. |
| 138 | Allowed values |
| 139 | 1 - v1 error format |
| 140 | 2 - v2 error format |
| 141 | filter: string, Optional. A query string for filtering alert feedback results. |
| 142 | For more details, see [Query |
| 143 | filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported |
| 144 | query filter |
| 145 | fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list). |
| 146 | |
| 147 | Returns: |
| 148 | An object of the form: |
| 149 | |
| 150 | { # Response message for an alert feedback listing request. |
| 151 | "feedback": [ # The list of alert feedback. |
| 152 | # Feedback entries for each alert are ordered by creation time descending. |
| 153 | { # A customer feedback about an alert. |
| 154 | "feedbackId": "A String", # Output only. The unique identifier for the feedback. |
| 155 | "alertId": "A String", # Output only. The alert identifier. |
| 156 | "createTime": "A String", # Output only. The time this feedback was created. |
| 157 | "customerId": "A String", # Output only. The unique identifier of the Google account of the customer. |
| 158 | "type": "A String", # Required. The type of the feedback. |
| 159 | "email": "A String", # Output only. The email of the user that provided the feedback. |
| 160 | }, |
| 161 | ], |
| 162 | }</pre> |
| 163 | </div> |
| 164 | |
| 165 | </body></html> |