google-shopping-merchant-issue_resolution-v1beta 0.a → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +154 -8
- data/lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/client.rb +692 -0
- data/lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/paths.rb +66 -0
- data/lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/rest/client.rb +645 -0
- data/lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/rest/service_stub.rb +269 -0
- data/lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service/rest.rb +55 -0
- data/lib/google/shopping/merchant/issue_resolution/v1beta/issue_resolution_service.rb +58 -0
- data/lib/google/shopping/merchant/issue_resolution/v1beta/rest.rb +39 -0
- data/lib/google/shopping/merchant/issue_resolution/v1beta/version.rb +7 -2
- data/lib/google/shopping/merchant/issue_resolution/v1beta.rb +47 -0
- data/lib/google/shopping/merchant/issueresolution/v1beta/issueresolution_pb.rb +87 -0
- data/lib/google/shopping/merchant/issueresolution/v1beta/issueresolution_services_pb.rb +66 -0
- data/lib/google-shopping-merchant-issue_resolution-v1beta.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +473 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb +954 -0
- metadata +69 -9
@@ -0,0 +1,954 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Shopping
|
22
|
+
module Merchant
|
23
|
+
module IssueResolution
|
24
|
+
module V1beta
|
25
|
+
# Response containing an issue resolution content and actions for listed
|
26
|
+
# account issues.
|
27
|
+
# @!attribute [rw] rendered_issues
|
28
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::RenderedIssue>]
|
29
|
+
# List of account issues for a given account.
|
30
|
+
#
|
31
|
+
# This list can be shown with compressed, expandable items. In the compressed
|
32
|
+
# form, the title and impact should be shown for each issue. Once the issue
|
33
|
+
# is expanded, the detailed
|
34
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::RenderedIssue#prerendered_content content}
|
35
|
+
# and available
|
36
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::RenderedIssue#actions actions}
|
37
|
+
# should be rendered.
|
38
|
+
class RenderAccountIssuesResponse
|
39
|
+
include ::Google::Protobuf::MessageExts
|
40
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
41
|
+
end
|
42
|
+
|
43
|
+
# Request to provide issue resolution content and actions for business's
|
44
|
+
# account issues.
|
45
|
+
# @!attribute [rw] name
|
46
|
+
# @return [::String]
|
47
|
+
# Required. The account to fetch issues for.
|
48
|
+
# Format: `accounts/{account}`
|
49
|
+
# @!attribute [rw] language_code
|
50
|
+
# @return [::String]
|
51
|
+
# Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language
|
52
|
+
# code used to localize issue resolution content. If not set, the result will
|
53
|
+
# be in default language `en-US`.
|
54
|
+
# @!attribute [rw] time_zone
|
55
|
+
# @return [::String]
|
56
|
+
# Optional. The [IANA](https://www.iana.org/time-zones) timezone used to
|
57
|
+
# localize times in an issue resolution content. For example
|
58
|
+
# 'America/Los_Angeles'. If not set, results will use as a default UTC.
|
59
|
+
# @!attribute [rw] payload
|
60
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::RenderIssuesRequestPayload]
|
61
|
+
# Optional. The payload for configuring how the content should be rendered.
|
62
|
+
class RenderAccountIssuesRequest
|
63
|
+
include ::Google::Protobuf::MessageExts
|
64
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
|
+
end
|
66
|
+
|
67
|
+
# The payload for configuring how the content should be rendered.
|
68
|
+
# @!attribute [rw] content_option
|
69
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::ContentOption]
|
70
|
+
# Optional. How the detailed content should be returned. Default option is to
|
71
|
+
# return the content as a pre-rendered HTML text.
|
72
|
+
# @!attribute [rw] user_input_action_option
|
73
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::UserInputActionRenderingOption]
|
74
|
+
# Optional. How actions with user input form should be handled. If not
|
75
|
+
# provided, actions will be returned as links that points the business to
|
76
|
+
# Merchant Center where they can request the action.
|
77
|
+
class RenderIssuesRequestPayload
|
78
|
+
include ::Google::Protobuf::MessageExts
|
79
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
80
|
+
end
|
81
|
+
|
82
|
+
# Response containing an issue resolution content and actions for listed
|
83
|
+
# product issues.
|
84
|
+
# @!attribute [rw] rendered_issues
|
85
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::RenderedIssue>]
|
86
|
+
# List of issues for a given product.
|
87
|
+
#
|
88
|
+
# This list can be shown with compressed, expandable items. In the compressed
|
89
|
+
# form, the
|
90
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::RenderedIssue#title title}
|
91
|
+
# and
|
92
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::RenderedIssue#impact impact}
|
93
|
+
# should be shown for each issue. Once the issue is expanded, the detailed
|
94
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::RenderedIssue#prerendered_content content}
|
95
|
+
# and available
|
96
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::RenderedIssue#actions actions}
|
97
|
+
# should be rendered.
|
98
|
+
class RenderProductIssuesResponse
|
99
|
+
include ::Google::Protobuf::MessageExts
|
100
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
101
|
+
end
|
102
|
+
|
103
|
+
# Request to provide an issue resolution content and actions for product issues
|
104
|
+
# of business's product.
|
105
|
+
# @!attribute [rw] name
|
106
|
+
# @return [::String]
|
107
|
+
# Required. The name of the product to fetch issues for.
|
108
|
+
# Format: `accounts/{account}/products/{product}`
|
109
|
+
# @!attribute [rw] language_code
|
110
|
+
# @return [::String]
|
111
|
+
# Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language
|
112
|
+
# code used to localize an issue resolution content. If not set, the result
|
113
|
+
# will be in default language `en-US`.
|
114
|
+
# @!attribute [rw] time_zone
|
115
|
+
# @return [::String]
|
116
|
+
# Optional. The [IANA](https://www.iana.org/time-zones) timezone used to
|
117
|
+
# localize times in an issue resolution content. For example
|
118
|
+
# 'America/Los_Angeles'. If not set, results will use as a default UTC.
|
119
|
+
# @!attribute [rw] payload
|
120
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::RenderIssuesRequestPayload]
|
121
|
+
# Optional. The payload for configuring how the content should be rendered.
|
122
|
+
class RenderProductIssuesRequest
|
123
|
+
include ::Google::Protobuf::MessageExts
|
124
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
125
|
+
end
|
126
|
+
|
127
|
+
# An issue affecting specific business or their product.
|
128
|
+
# @!attribute [rw] prerendered_content
|
129
|
+
# @return [::String]
|
130
|
+
# Details of the issue as a pre-rendered HTML. HTML elements contain CSS
|
131
|
+
# classes that can be used to customize the style of the content.
|
132
|
+
#
|
133
|
+
# Always sanitize the HTML before embedding it directly to your
|
134
|
+
# application. The sanitizer needs to allow basic HTML tags, such as:
|
135
|
+
# `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example,
|
136
|
+
# you can use [DOMPurify](https://www.npmjs.com/package/dompurify).
|
137
|
+
#
|
138
|
+
# CSS classes:
|
139
|
+
#
|
140
|
+
# * `issue-detail` - top level container for the detail of the issue
|
141
|
+
# * `callout-banners` - section of the `issue-detail` with callout banners
|
142
|
+
# * `callout-banner` - single callout banner, inside `callout-banners`
|
143
|
+
# * `callout-banner-info` - callout with important information (default)
|
144
|
+
# * `callout-banner-warning` - callout with a warning
|
145
|
+
# * `callout-banner-error` - callout informing about an error (most severe)
|
146
|
+
# * `issue-content` - section of the `issue-detail`, contains multiple
|
147
|
+
# `content-element`
|
148
|
+
# * `content-element` - content element such as a list, link or paragraph,
|
149
|
+
# inside `issue-content`
|
150
|
+
# * `root-causes` - unordered list with items describing root causes of the
|
151
|
+
# issue, inside `issue-content`
|
152
|
+
# * `root-causes-intro` - intro text before the `root-causes` list, inside
|
153
|
+
# `issue-content`
|
154
|
+
# * `segment` - section of the text, `span` inside paragraph
|
155
|
+
# * `segment-attribute` - section of the text that represents a product
|
156
|
+
# attribute, for example 'image\_link'
|
157
|
+
# * `segment-literal` - section of the text that contains a special value,
|
158
|
+
# for example '0-1000 kg'
|
159
|
+
# * `segment-bold` - section of the text that should be rendered as bold
|
160
|
+
# * `segment-italic` - section of the text that should be rendered as
|
161
|
+
# italic
|
162
|
+
# * `tooltip` - used on paragraphs that should be rendered with a tooltip.
|
163
|
+
# A section of the text in such a paragraph will have a class
|
164
|
+
# `tooltip-text` and is intended to be shown in a mouse over dialog. If the
|
165
|
+
# style is not used, the `tooltip-text` section would be shown on a new
|
166
|
+
# line, after the main part of the text.
|
167
|
+
# * `tooltip-text` - marks a section of the text within a `tooltip`, that
|
168
|
+
# is intended to be shown in a mouse over dialog.
|
169
|
+
# * `tooltip-icon` - marks a section of the text within a `tooltip`, that
|
170
|
+
# can be replaced with a tooltip icon, for example '?' or 'i'. By default,
|
171
|
+
# this section contains a `br` tag, that is separating the main text and
|
172
|
+
# the tooltip text when the style is not used.
|
173
|
+
# * `tooltip-style-question` - the tooltip shows helpful information,
|
174
|
+
# can use the '?' as an icon.
|
175
|
+
# * `tooltip-style-info` - the tooltip adds additional information fitting
|
176
|
+
# to the context, can use the 'i' as an icon.
|
177
|
+
# * `content-moderation` - marks the paragraph that explains how the issue
|
178
|
+
# was identified.
|
179
|
+
# * `new-element` - Present for new elements added to the pre-rendered
|
180
|
+
# content in the future. To make sure that a new content element does not
|
181
|
+
# break your style, you can hide everything with this class.
|
182
|
+
# @!attribute [rw] prerendered_out_of_court_dispute_settlement
|
183
|
+
# @return [::String]
|
184
|
+
# Pre-rendered HTML that contains a link to the external location where the
|
185
|
+
# ODS can be requested and instructions for how to request it. HTML
|
186
|
+
# elements contain CSS classes that can be used to customize the style of
|
187
|
+
# this snippet.
|
188
|
+
#
|
189
|
+
# Always sanitize the HTML before embedding it directly to your
|
190
|
+
# application. The sanitizer needs to allow basic HTML tags, such as:
|
191
|
+
# `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example,
|
192
|
+
# you can use [DOMPurify](https://www.npmjs.com/package/dompurify).
|
193
|
+
#
|
194
|
+
# CSS classes:
|
195
|
+
#
|
196
|
+
# * `ods-section`* - wrapper around the out-of-court dispute resolution
|
197
|
+
# section
|
198
|
+
# * `ods-description`* - intro text for the out-of-court dispute
|
199
|
+
# resolution. It may contain multiple segments and a link.
|
200
|
+
# * `ods-param`* - wrapper around the header-value pair for parameters that
|
201
|
+
# the business may need to provide during the ODS process.
|
202
|
+
# * `ods-routing-id`* - ods param for the Routing ID.
|
203
|
+
# * `ods-reference-id`* - ods param for the Routing ID.
|
204
|
+
# * `ods-param-header`* - header for the ODS parameter
|
205
|
+
# * `ods-param-value`* - value of the ODS parameter. This value should be
|
206
|
+
# rendered in a way that it is easy for the user to identify and copy.
|
207
|
+
# * `segment` - section of the text, `span` inside paragraph
|
208
|
+
# * `segment-attribute` - section of the text that represents a product
|
209
|
+
# attribute, for example 'image\_link'
|
210
|
+
# * `segment-literal` - section of the text that contains a special value,
|
211
|
+
# for example '0-1000 kg'
|
212
|
+
# * `segment-bold` - section of the text that should be rendered as bold
|
213
|
+
# * `segment-italic` - section of the text that should be rendered as
|
214
|
+
# italic
|
215
|
+
# * `tooltip` - used on paragraphs that should be rendered with a tooltip.
|
216
|
+
# A section of the text in such a paragraph will have a class
|
217
|
+
# `tooltip-text` and is intended to be shown in a mouse over dialog. If the
|
218
|
+
# style is not used, the `tooltip-text` section would be shown on a new
|
219
|
+
# line, after the main part of the text.
|
220
|
+
# * `tooltip-text` - marks a section of the text within a `tooltip`, that
|
221
|
+
# is intended to be shown in a mouse over dialog.
|
222
|
+
# * `tooltip-icon` - marks a section of the text within a `tooltip`, that
|
223
|
+
# can be replaced with a tooltip icon, for example '?' or 'i'. By default,
|
224
|
+
# this section contains a `br` tag, that is separating the main text and
|
225
|
+
# the tooltip text when the style is not used.
|
226
|
+
# * `tooltip-style-question` - the tooltip shows helpful information,
|
227
|
+
# can use the '?' as an icon.
|
228
|
+
# * `tooltip-style-info` - the tooltip adds additional information fitting
|
229
|
+
# to the context, can use the 'i' as an icon.
|
230
|
+
# @!attribute [rw] title
|
231
|
+
# @return [::String]
|
232
|
+
# Title of the issue.
|
233
|
+
# @!attribute [rw] impact
|
234
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Impact]
|
235
|
+
# Clarifies the severity of the issue.
|
236
|
+
#
|
237
|
+
# The [summarizing
|
238
|
+
# message][google.shopping.merchant.issueresolution.v1beta.Impact.message],
|
239
|
+
# if present, should be shown right under the title for each issue. It helps
|
240
|
+
# business to quickly understand the impact of the issue.
|
241
|
+
#
|
242
|
+
# The detailed
|
243
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::Impact#breakdowns breakdown}
|
244
|
+
# helps the business to fully understand the impact of the issue. It can be
|
245
|
+
# rendered as dialog that opens when the business mouse over the summarized
|
246
|
+
# impact statement.
|
247
|
+
#
|
248
|
+
# Issues with different
|
249
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::Impact#severity severity}
|
250
|
+
# can be styled differently. They may use a different color or icon to signal
|
251
|
+
# the difference between `ERROR`, `WARNING` and `INFO`.
|
252
|
+
# @!attribute [rw] actions
|
253
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::Action>]
|
254
|
+
# A list of actionable steps that can be executed to solve the issue. An
|
255
|
+
# example is requesting a re-review or providing arguments when business
|
256
|
+
# disagrees with the issue.
|
257
|
+
#
|
258
|
+
# Actions that are supported in (your) third-party application can be
|
259
|
+
# rendered as buttons and should be available to the business when they
|
260
|
+
# expand the issue.
|
261
|
+
class RenderedIssue
|
262
|
+
include ::Google::Protobuf::MessageExts
|
263
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
264
|
+
end
|
265
|
+
|
266
|
+
# Overall impact of the issue.
|
267
|
+
# @!attribute [rw] message
|
268
|
+
# @return [::String]
|
269
|
+
# Optional. Message summarizing the overall impact of the issue. If present,
|
270
|
+
# it should be rendered to the business. For example: "Disapproves 90k offers
|
271
|
+
# in 25 countries"
|
272
|
+
# @!attribute [rw] severity
|
273
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Severity]
|
274
|
+
# The severity of the issue.
|
275
|
+
# @!attribute [rw] breakdowns
|
276
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::Breakdown>]
|
277
|
+
# Detailed impact breakdown. Explains the types of restriction the issue has
|
278
|
+
# in different shopping destinations and territory. If present, it should be
|
279
|
+
# rendered to the business. Can be shown as a mouse over dropdown or a
|
280
|
+
# dialog. Each breakdown item represents a group of regions with the same
|
281
|
+
# impact details.
|
282
|
+
class Impact
|
283
|
+
include ::Google::Protobuf::MessageExts
|
284
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
285
|
+
end
|
286
|
+
|
287
|
+
# A detailed impact breakdown for a group of regions where the impact of the
|
288
|
+
# issue on different shopping destinations is the same.
|
289
|
+
# @!attribute [rw] regions
|
290
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::Breakdown::Region>]
|
291
|
+
# Lists of regions. Should be rendered as a title for this group of details.
|
292
|
+
# The full list should be shown to the business. If the list is too long, it
|
293
|
+
# is recommended to make it expandable.
|
294
|
+
# @!attribute [rw] details
|
295
|
+
# @return [::Array<::String>]
|
296
|
+
# Human readable, localized description of issue's effect on different
|
297
|
+
# targets. Should be rendered as a list.
|
298
|
+
#
|
299
|
+
# For example:
|
300
|
+
#
|
301
|
+
# * "Products not showing in ads"
|
302
|
+
# * "Products not showing organically"
|
303
|
+
class Breakdown
|
304
|
+
include ::Google::Protobuf::MessageExts
|
305
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
306
|
+
|
307
|
+
# Region with code and localized name.
|
308
|
+
# @!attribute [rw] code
|
309
|
+
# @return [::String]
|
310
|
+
# The [CLDR territory code]
|
311
|
+
# (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)
|
312
|
+
# @!attribute [rw] name
|
313
|
+
# @return [::String]
|
314
|
+
# The localized name of the region.
|
315
|
+
# For region with code='001' the value is 'All countries' or the equivalent
|
316
|
+
# in other languages.
|
317
|
+
class Region
|
318
|
+
include ::Google::Protobuf::MessageExts
|
319
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
320
|
+
end
|
321
|
+
end
|
322
|
+
|
323
|
+
# An actionable step that can be executed to solve the issue.
|
324
|
+
# @!attribute [rw] builtin_simple_action
|
325
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInSimpleAction]
|
326
|
+
# Action implemented and performed in (your) third-party application. The
|
327
|
+
# application should point the business to the place, where they can access
|
328
|
+
# the corresponding functionality or provide instructions, if the specific
|
329
|
+
# functionality is not available.
|
330
|
+
#
|
331
|
+
# Note: The following fields are mutually exclusive: `builtin_simple_action`, `external_action`, `builtin_user_input_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
332
|
+
# @!attribute [rw] external_action
|
333
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::ExternalAction]
|
334
|
+
# Action that is implemented and performed outside of (your) third-party
|
335
|
+
# application. The application needs to redirect the business to the
|
336
|
+
# external location where they can perform the action.
|
337
|
+
#
|
338
|
+
# Note: The following fields are mutually exclusive: `external_action`, `builtin_simple_action`, `builtin_user_input_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
339
|
+
# @!attribute [rw] builtin_user_input_action
|
340
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInUserInputAction]
|
341
|
+
# Action implemented and performed in (your) third-party application.
|
342
|
+
# The application needs to show an additional content and input form to the
|
343
|
+
# business as specified for given action. They can trigger the action only
|
344
|
+
# when they provided all required inputs.
|
345
|
+
#
|
346
|
+
# Note: The following fields are mutually exclusive: `builtin_user_input_action`, `builtin_simple_action`, `external_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
347
|
+
# @!attribute [rw] button_label
|
348
|
+
# @return [::String]
|
349
|
+
# Label of the action button.
|
350
|
+
# @!attribute [rw] is_available
|
351
|
+
# @return [::Boolean]
|
352
|
+
# Controlling whether the button is active or disabled. The value is 'false'
|
353
|
+
# when the action was already requested or is not available. If the action is
|
354
|
+
# not available then a
|
355
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::Action#reasons reason}
|
356
|
+
# will be present. If (your) third-party application shows a disabled button
|
357
|
+
# for action that is not available, then it should also show reasons.
|
358
|
+
# @!attribute [rw] reasons
|
359
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::Action::Reason>]
|
360
|
+
# List of reasons why the action is not available. The list of reasons is
|
361
|
+
# empty if the action is available. If there is only one reason, it can be
|
362
|
+
# displayed next to the disabled button. If there are more reasons, all of
|
363
|
+
# them should be displayed, for example in a pop-up dialog.
|
364
|
+
class Action
|
365
|
+
include ::Google::Protobuf::MessageExts
|
366
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
367
|
+
|
368
|
+
# A single reason why the action is not available.
|
369
|
+
# @!attribute [rw] message
|
370
|
+
# @return [::String]
|
371
|
+
# Messages summarizing the reason, why the action is not available.
|
372
|
+
# For example: "Review requested on Jan 03. Review requests can take a few
|
373
|
+
# days to complete."
|
374
|
+
# @!attribute [rw] detail
|
375
|
+
# @return [::String]
|
376
|
+
# Detailed explanation of the reason. Should be displayed as a hint if
|
377
|
+
# present.
|
378
|
+
# @!attribute [rw] action
|
379
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Action]
|
380
|
+
# Optional. An action that needs to be performed to solve the problem
|
381
|
+
# represented by this reason. This action will always be available. Should
|
382
|
+
# be rendered as a link or button next to the summarizing message.
|
383
|
+
#
|
384
|
+
# For example, the review may be available only once the business configure
|
385
|
+
# all required attributes. In such a situation this action can be a link to
|
386
|
+
# the form, where they can fill the missing attribute to unblock the main
|
387
|
+
# action.
|
388
|
+
class Reason
|
389
|
+
include ::Google::Protobuf::MessageExts
|
390
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
391
|
+
end
|
392
|
+
end
|
393
|
+
|
394
|
+
# Action that is implemented and performed in (your) third-party application.
|
395
|
+
# Represents various functionality that is expected to be available to business
|
396
|
+
# and will help them with resolving the issue. The application should point the
|
397
|
+
# business to the place, where they can access the corresponding functionality.
|
398
|
+
# If the functionality is not supported, it is recommended to explain the
|
399
|
+
# situation to the business and provide them with instructions how to solve the
|
400
|
+
# issue.
|
401
|
+
# @!attribute [rw] type
|
402
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInSimpleAction::BuiltInSimpleActionType]
|
403
|
+
# The type of action that represents a functionality that is expected to be
|
404
|
+
# available in third-party application.
|
405
|
+
# @!attribute [rw] attribute_code
|
406
|
+
# @return [::String]
|
407
|
+
# The attribute that needs to be updated. Present when the
|
408
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInSimpleAction#type type}
|
409
|
+
# is `EDIT_ITEM_ATTRIBUTE`.
|
410
|
+
#
|
411
|
+
# This field contains a code for attribute, represented in snake_case. You
|
412
|
+
# can find a list of product's attributes, with their codes
|
413
|
+
# [here](https://support.google.com/merchants/answer/7052112).
|
414
|
+
# @!attribute [rw] additional_content
|
415
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInSimpleAction::AdditionalContent]
|
416
|
+
# Long text from an external source that should be available to the business.
|
417
|
+
# Present when the
|
418
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInSimpleAction#type type}
|
419
|
+
# is `SHOW_ADDITIONAL_CONTENT`.
|
420
|
+
class BuiltInSimpleAction
|
421
|
+
include ::Google::Protobuf::MessageExts
|
422
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
423
|
+
|
424
|
+
# Long text from external source.
|
425
|
+
# @!attribute [rw] title
|
426
|
+
# @return [::String]
|
427
|
+
# Title of the additional content;
|
428
|
+
# @!attribute [rw] paragraphs
|
429
|
+
# @return [::Array<::String>]
|
430
|
+
# Long text organized into paragraphs.
|
431
|
+
class AdditionalContent
|
432
|
+
include ::Google::Protobuf::MessageExts
|
433
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
434
|
+
end
|
435
|
+
|
436
|
+
# Enum specifying the type of action in third-party application.
|
437
|
+
module BuiltInSimpleActionType
|
438
|
+
# Default value. Will never be provided by the API.
|
439
|
+
BUILT_IN_SIMPLE_ACTION_TYPE_UNSPECIFIED = 0
|
440
|
+
|
441
|
+
# Redirect the business to the part of your application where they can
|
442
|
+
# verify their phone.
|
443
|
+
VERIFY_PHONE = 1
|
444
|
+
|
445
|
+
# Redirect the business to the part of your application where they can
|
446
|
+
# claim their website.
|
447
|
+
CLAIM_WEBSITE = 2
|
448
|
+
|
449
|
+
# Redirect the business to the part of your application where they can add
|
450
|
+
# products.
|
451
|
+
ADD_PRODUCTS = 3
|
452
|
+
|
453
|
+
# Open a form where the business can edit their contact information.
|
454
|
+
ADD_CONTACT_INFO = 4
|
455
|
+
|
456
|
+
# Redirect the business to the part of your application where they can link
|
457
|
+
# ads account.
|
458
|
+
LINK_ADS_ACCOUNT = 5
|
459
|
+
|
460
|
+
# Open a form where the business can add their business registration
|
461
|
+
# number.
|
462
|
+
ADD_BUSINESS_REGISTRATION_NUMBER = 6
|
463
|
+
|
464
|
+
# Open a form where the business can edit an attribute. The attribute that
|
465
|
+
# needs to be updated is specified in
|
466
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInSimpleAction#attribute_code attribute_code}
|
467
|
+
# field of the action.
|
468
|
+
EDIT_ITEM_ATTRIBUTE = 7
|
469
|
+
|
470
|
+
# Redirect the business from the product issues to the diagnostic page with
|
471
|
+
# their account issues in your application.
|
472
|
+
#
|
473
|
+
# This action will be returned only for product issues that are caused by
|
474
|
+
# an account issue and thus the business should resolve the problem on the
|
475
|
+
# account level.
|
476
|
+
FIX_ACCOUNT_ISSUE = 8
|
477
|
+
|
478
|
+
# Show [additional
|
479
|
+
# content][google.shopping.merchant.issueresolution.v1beta.BuiltInSimpleAction.additional_content]
|
480
|
+
# to the business.
|
481
|
+
#
|
482
|
+
# This action will be used for example to deliver a justification from
|
483
|
+
# national authority.
|
484
|
+
SHOW_ADDITIONAL_CONTENT = 9
|
485
|
+
end
|
486
|
+
end
|
487
|
+
|
488
|
+
# Action that is implemented and performed in (your) third-party application.
|
489
|
+
# The application needs to show an additional content and input form to the
|
490
|
+
# business. They can start the action only when they provided all required
|
491
|
+
# inputs. The application will request processing of the action by calling the
|
492
|
+
# [triggeraction
|
493
|
+
# method](https://developers.google.com/merchant/api/reference/rest/issueresolution_v1beta/issueresolution/triggeraction).
|
494
|
+
# @!attribute [rw] action_context
|
495
|
+
# @return [::String]
|
496
|
+
# Contains the action's context that must be included as part of the
|
497
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::TriggerActionPayload#action_context TriggerActionPayload.action_context}
|
498
|
+
# in
|
499
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::TriggerActionRequest#payload TriggerActionRequest.payload}
|
500
|
+
# to call the `triggeraction` method. The content should be treated as opaque
|
501
|
+
# and must not be modified.
|
502
|
+
# @!attribute [rw] flows
|
503
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::ActionFlow>]
|
504
|
+
# Actions may provide multiple different flows. Business selects one that
|
505
|
+
# fits best to their intent. Selecting the flow is the first step in user's
|
506
|
+
# interaction with the action. It affects what input fields will be available
|
507
|
+
# and required and also how the request will be processed.
|
508
|
+
class BuiltInUserInputAction
|
509
|
+
include ::Google::Protobuf::MessageExts
|
510
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
511
|
+
end
|
512
|
+
|
513
|
+
# Flow that can be selected for an action. When a business selects a flow,
|
514
|
+
# application should open a dialog with more information and input form.
|
515
|
+
# @!attribute [rw] id
|
516
|
+
# @return [::String]
|
517
|
+
# Not for display but need to be sent back for the selected action flow.
|
518
|
+
# @!attribute [rw] label
|
519
|
+
# @return [::String]
|
520
|
+
# Text value describing the intent for the action flow. It can be used as an
|
521
|
+
# input label if business needs to pick one of multiple flows. For example:
|
522
|
+
# "I disagree with the issue"
|
523
|
+
# @!attribute [rw] inputs
|
524
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputField>]
|
525
|
+
# A list of input fields.
|
526
|
+
# @!attribute [rw] dialog_title
|
527
|
+
# @return [::String]
|
528
|
+
# Title of the request dialog. For example: "Before you request a review"
|
529
|
+
# @!attribute [rw] dialog_message
|
530
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
|
531
|
+
# Message displayed in the request dialog. For example: "Make sure you've
|
532
|
+
# fixed all your country-specific issues. If not, you may have to wait 7 days
|
533
|
+
# to request another review". There may be an more information to be shown in
|
534
|
+
# a tooltip.
|
535
|
+
# @!attribute [rw] dialog_callout
|
536
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Callout]
|
537
|
+
# Important message to be highlighted in the request dialog. For example:
|
538
|
+
# "You can only request a review for disagreeing with this issue once. If
|
539
|
+
# it's not approved, you'll need to fix the issue and wait a few days before
|
540
|
+
# you can request another review."
|
541
|
+
# @!attribute [rw] dialog_button_label
|
542
|
+
# @return [::String]
|
543
|
+
# Label for the button to trigger the action from the action dialog. For
|
544
|
+
# example: "Request review"
|
545
|
+
class ActionFlow
|
546
|
+
include ::Google::Protobuf::MessageExts
|
547
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
548
|
+
end
|
549
|
+
|
550
|
+
# Input field that needs to be available to the business. If the field is
|
551
|
+
# marked as required, then a value needs to be provided for a successful
|
552
|
+
# processing of the request.
|
553
|
+
# @!attribute [rw] text_input
|
554
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput]
|
555
|
+
# Input field to provide text information.
|
556
|
+
# Corresponds to the [html input
|
557
|
+
# type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text)
|
558
|
+
# or [html
|
559
|
+
# textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
|
560
|
+
#
|
561
|
+
# Note: The following fields are mutually exclusive: `text_input`, `choice_input`, `checkbox_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
562
|
+
# @!attribute [rw] choice_input
|
563
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput]
|
564
|
+
# Input field to select one of the offered choices.
|
565
|
+
# Corresponds to the [html input
|
566
|
+
# type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio).
|
567
|
+
#
|
568
|
+
# Note: The following fields are mutually exclusive: `choice_input`, `text_input`, `checkbox_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
569
|
+
# @!attribute [rw] checkbox_input
|
570
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::CheckboxInput]
|
571
|
+
# Input field to provide a boolean value.
|
572
|
+
# Corresponds to the [html input
|
573
|
+
# type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox).
|
574
|
+
#
|
575
|
+
# Note: The following fields are mutually exclusive: `checkbox_input`, `text_input`, `choice_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
576
|
+
# @!attribute [rw] id
|
577
|
+
# @return [::String]
|
578
|
+
# Not for display but need to be sent back for the given input field.
|
579
|
+
# @!attribute [rw] label
|
580
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
|
581
|
+
# Input field label. There may be more information to be shown in a tooltip.
|
582
|
+
# @!attribute [rw] required
|
583
|
+
# @return [::Boolean]
|
584
|
+
# Whether the field is required. The action button needs to stay disabled
|
585
|
+
# till values for all required fields are provided.
|
586
|
+
class InputField
|
587
|
+
include ::Google::Protobuf::MessageExts
|
588
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
589
|
+
|
590
|
+
# Text input allows the business to provide a text value.
|
591
|
+
# @!attribute [rw] type
|
592
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput::TextInputType]
|
593
|
+
# Type of the text input
|
594
|
+
# @!attribute [rw] additional_info
|
595
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
|
596
|
+
# Additional info regarding the field to be displayed to the business. For
|
597
|
+
# example, warning to not include personal identifiable information. There
|
598
|
+
# may be more information to be shown in a tooltip.
|
599
|
+
# @!attribute [rw] format_info
|
600
|
+
# @return [::String]
|
601
|
+
# Information about the required format. If present, it should be shown
|
602
|
+
# close to the input field to help the business to provide a correct value.
|
603
|
+
# For example: "VAT numbers should be in a format similar to SK9999999999"
|
604
|
+
# @!attribute [rw] aria_label
|
605
|
+
# @return [::String]
|
606
|
+
# Text to be used as the
|
607
|
+
# [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the
|
608
|
+
# input.
|
609
|
+
class TextInput
|
610
|
+
include ::Google::Protobuf::MessageExts
|
611
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
612
|
+
|
613
|
+
# Enum specifying the type of the text input and how it should be rendered.
|
614
|
+
module TextInputType
|
615
|
+
# Default value. Will never be provided by the API.
|
616
|
+
TEXT_INPUT_TYPE_UNSPECIFIED = 0
|
617
|
+
|
618
|
+
# Used when a short text is expected. The field can be rendered as a
|
619
|
+
# [text
|
620
|
+
# field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
|
621
|
+
GENERIC_SHORT_TEXT = 1
|
622
|
+
|
623
|
+
# Used when a longer text is expected. The field should be rendered as a
|
624
|
+
# [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
|
625
|
+
GENERIC_LONG_TEXT = 2
|
626
|
+
end
|
627
|
+
end
|
628
|
+
|
629
|
+
# Choice input allows the business to select one of the offered choices. Some
|
630
|
+
# choices may be linked to additional input fields that should be displayed
|
631
|
+
# under or next to the choice option. The value for the additional input
|
632
|
+
# field needs to be provided only when the specific choice is selected by the
|
633
|
+
# the business. For example, additional input field can be hidden or disabled
|
634
|
+
# until the business selects the specific choice.
|
635
|
+
# @!attribute [rw] options
|
636
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::ChoiceInput::ChoiceInputOption>]
|
637
|
+
# A list of choices. Only one option can be selected.
|
638
|
+
class ChoiceInput
|
639
|
+
include ::Google::Protobuf::MessageExts
|
640
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
641
|
+
|
642
|
+
# A choice that the business can select.
|
643
|
+
# @!attribute [rw] id
|
644
|
+
# @return [::String]
|
645
|
+
# Not for display but need to be sent back for the selected choice
|
646
|
+
# option.
|
647
|
+
# @!attribute [rw] label
|
648
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
|
649
|
+
# Short description of the choice option. There may be more information
|
650
|
+
# to be shown as a tooltip.
|
651
|
+
# @!attribute [rw] additional_input
|
652
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputField]
|
653
|
+
# Input that should be displayed when this option is selected.
|
654
|
+
# The additional input will not contain a `ChoiceInput`.
|
655
|
+
class ChoiceInputOption
|
656
|
+
include ::Google::Protobuf::MessageExts
|
657
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
658
|
+
end
|
659
|
+
end
|
660
|
+
|
661
|
+
# Checkbox input allows the business to provide a boolean value. Corresponds
|
662
|
+
# to the [html input
|
663
|
+
# type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox).
|
664
|
+
#
|
665
|
+
# If the business checks the box, the input value for the field is `true`,
|
666
|
+
# otherwise it is `false`.
|
667
|
+
#
|
668
|
+
# This type of input is often used as a confirmation that the business
|
669
|
+
# completed required steps before they are allowed to start the action. In
|
670
|
+
# such a case, the input field is marked as
|
671
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::InputField#required required}
|
672
|
+
# and the button to trigger the action should stay disabled until the
|
673
|
+
# business checks the box.
|
674
|
+
class CheckboxInput
|
675
|
+
include ::Google::Protobuf::MessageExts
|
676
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
677
|
+
end
|
678
|
+
end
|
679
|
+
|
680
|
+
# Block of text that may contain a tooltip with more information.
|
681
|
+
# @!attribute [rw] simple_value
|
682
|
+
# @return [::String]
|
683
|
+
# Value of the message as a simple text.
|
684
|
+
# @!attribute [rw] simple_tooltip_value
|
685
|
+
# @return [::String]
|
686
|
+
# Value of the tooltip as a simple text.
|
687
|
+
# @!attribute [rw] tooltip_icon_style
|
688
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip::TooltipIconStyle]
|
689
|
+
# The suggested type of an icon for tooltip, if a tooltip is present.
|
690
|
+
class TextWithTooltip
|
691
|
+
include ::Google::Protobuf::MessageExts
|
692
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
693
|
+
|
694
|
+
# Enum specifying the type of an icon that is being used to display a
|
695
|
+
# corresponding tooltip in the Merchant Center.
|
696
|
+
module TooltipIconStyle
|
697
|
+
# Default value. Will never be provided by the API.
|
698
|
+
TOOLTIP_ICON_STYLE_UNSPECIFIED = 0
|
699
|
+
|
700
|
+
# Used when the tooltip adds additional information to the context,
|
701
|
+
# the 'i' can be used as an icon.
|
702
|
+
INFO = 1
|
703
|
+
|
704
|
+
# Used when the tooltip shows helpful information, the '?' can be used as
|
705
|
+
# an icon.
|
706
|
+
QUESTION = 2
|
707
|
+
end
|
708
|
+
end
|
709
|
+
|
710
|
+
# An important message that should be highlighted. Usually displayed as a
|
711
|
+
# banner.
|
712
|
+
# @!attribute [rw] style_hint
|
713
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::Callout::CalloutStyleHint]
|
714
|
+
# Can be used to render messages with different severity in different styles.
|
715
|
+
# Snippets off all types contain important information that should be
|
716
|
+
# displayed to the business.
|
717
|
+
# @!attribute [rw] full_message
|
718
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip]
|
719
|
+
# A full message that needs to be shown to the business.
|
720
|
+
class Callout
|
721
|
+
include ::Google::Protobuf::MessageExts
|
722
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
723
|
+
|
724
|
+
# Enum specifying the suggested style, how the message should be rendered.
|
725
|
+
module CalloutStyleHint
|
726
|
+
# Default value. Will never be provided by the API.
|
727
|
+
CALLOUT_STYLE_HINT_UNSPECIFIED = 0
|
728
|
+
|
729
|
+
# The most important type of information highlighting problems, like an
|
730
|
+
# unsuccessful outcome of previously requested actions.
|
731
|
+
ERROR = 1
|
732
|
+
|
733
|
+
# Information warning about pending problems, risks or deadlines.
|
734
|
+
WARNING = 2
|
735
|
+
|
736
|
+
# Default severity for important information like pending status of
|
737
|
+
# previously requested action or cooldown for re-review.
|
738
|
+
INFO = 3
|
739
|
+
end
|
740
|
+
end
|
741
|
+
|
742
|
+
# Action that is implemented and performed outside of the third-party
|
743
|
+
# application. It should redirect the business to the provided URL of an
|
744
|
+
# external system where they can perform the action. For example to request a
|
745
|
+
# review in the Merchant Center.
|
746
|
+
# @!attribute [rw] type
|
747
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::ExternalAction::ExternalActionType]
|
748
|
+
# The type of external action.
|
749
|
+
# @!attribute [rw] uri
|
750
|
+
# @return [::String]
|
751
|
+
# URL to external system, for example Merchant Center, where the business can
|
752
|
+
# perform the action.
|
753
|
+
class ExternalAction
|
754
|
+
include ::Google::Protobuf::MessageExts
|
755
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
756
|
+
|
757
|
+
# Enum specifying the type of action that requires to redirect the business
|
758
|
+
# to an external location.
|
759
|
+
module ExternalActionType
|
760
|
+
# Default value. Will never be provided by the API.
|
761
|
+
EXTERNAL_ACTION_TYPE_UNSPECIFIED = 0
|
762
|
+
|
763
|
+
# Redirect to Merchant Center where the business can request a review for
|
764
|
+
# issue related to their product.
|
765
|
+
REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER = 1
|
766
|
+
|
767
|
+
# Redirect to Merchant Center where the business can request a review for
|
768
|
+
# issue related to their account.
|
769
|
+
REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER = 2
|
770
|
+
|
771
|
+
# Redirect to the form in Help Center where the business can request a
|
772
|
+
# legal appeal for the issue.
|
773
|
+
LEGAL_APPEAL_IN_HELP_CENTER = 3
|
774
|
+
|
775
|
+
# Redirect to Merchant Center where the business can perform identity
|
776
|
+
# verification.
|
777
|
+
VERIFY_IDENTITY_IN_MERCHANT_CENTER = 4
|
778
|
+
end
|
779
|
+
end
|
780
|
+
|
781
|
+
# Request to start the selected action
|
782
|
+
# @!attribute [rw] name
|
783
|
+
# @return [::String]
|
784
|
+
# Required. The business's account that is triggering the action.
|
785
|
+
# Format: `accounts/{account}`
|
786
|
+
# @!attribute [rw] payload
|
787
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::TriggerActionPayload]
|
788
|
+
# Required. The payload for the triggered action.
|
789
|
+
# @!attribute [rw] language_code
|
790
|
+
# @return [::String]
|
791
|
+
# Optional. Language code [IETF BCP 47
|
792
|
+
# syntax](https://tools.ietf.org/html/bcp47) used to localize the response.
|
793
|
+
# If not set, the result will be in default language `en-US`.
|
794
|
+
class TriggerActionRequest
|
795
|
+
include ::Google::Protobuf::MessageExts
|
796
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
797
|
+
end
|
798
|
+
|
799
|
+
# The payload for the triggered action.
|
800
|
+
# @!attribute [rw] action_context
|
801
|
+
# @return [::String]
|
802
|
+
# Required. The
|
803
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::BuiltInUserInputAction#action_context context}
|
804
|
+
# from the selected action. The value is obtained from rendered issues and
|
805
|
+
# needs to be sent back to identify the
|
806
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::Action#builtin_user_input_action action}
|
807
|
+
# that is being triggered.
|
808
|
+
# @!attribute [rw] action_input
|
809
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::ActionInput]
|
810
|
+
# Required. Input provided by the business.
|
811
|
+
class TriggerActionPayload
|
812
|
+
include ::Google::Protobuf::MessageExts
|
813
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
814
|
+
end
|
815
|
+
|
816
|
+
# Response informing about the started action.
|
817
|
+
# @!attribute [rw] message
|
818
|
+
# @return [::String]
|
819
|
+
# The message for the business.
|
820
|
+
class TriggerActionResponse
|
821
|
+
include ::Google::Protobuf::MessageExts
|
822
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
823
|
+
end
|
824
|
+
|
825
|
+
# Input provided by the business.
|
826
|
+
# @!attribute [rw] action_flow_id
|
827
|
+
# @return [::String]
|
828
|
+
# Required.
|
829
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::ActionFlow#id Id} of the
|
830
|
+
# selected action flow.
|
831
|
+
# @!attribute [rw] input_values
|
832
|
+
# @return [::Array<::Google::Shopping::Merchant::IssueResolution::V1beta::InputValue>]
|
833
|
+
# Required. Values for input fields.
|
834
|
+
class ActionInput
|
835
|
+
include ::Google::Protobuf::MessageExts
|
836
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
837
|
+
end
|
838
|
+
|
839
|
+
# Input provided by the business for input field.
|
840
|
+
# @!attribute [rw] text_input_value
|
841
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputValue::TextInputValue]
|
842
|
+
# Value for [text
|
843
|
+
# input][google.shopping.merchant.issueresolution.v1beta.InputField.TextInput]
|
844
|
+
# field.
|
845
|
+
#
|
846
|
+
# Note: The following fields are mutually exclusive: `text_input_value`, `choice_input_value`, `checkbox_input_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
847
|
+
# @!attribute [rw] choice_input_value
|
848
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputValue::ChoiceInputValue]
|
849
|
+
# Value for [choice
|
850
|
+
# input][google.shopping.merchant.issueresolution.v1beta.InputField.ChoiceInput]
|
851
|
+
# field.
|
852
|
+
#
|
853
|
+
# Note: The following fields are mutually exclusive: `choice_input_value`, `text_input_value`, `checkbox_input_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
854
|
+
# @!attribute [rw] checkbox_input_value
|
855
|
+
# @return [::Google::Shopping::Merchant::IssueResolution::V1beta::InputValue::CheckboxInputValue]
|
856
|
+
# Value for [checkbox
|
857
|
+
# input][google.shopping.merchant.issueresolution.v1beta.InputField.CheckboxInput]
|
858
|
+
# field.
|
859
|
+
#
|
860
|
+
# Note: The following fields are mutually exclusive: `checkbox_input_value`, `text_input_value`, `choice_input_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
861
|
+
# @!attribute [rw] input_field_id
|
862
|
+
# @return [::String]
|
863
|
+
# Required.
|
864
|
+
# {::Google::Shopping::Merchant::IssueResolution::V1beta::InputField#id Id} of the
|
865
|
+
# corresponding input field.
|
866
|
+
class InputValue
|
867
|
+
include ::Google::Protobuf::MessageExts
|
868
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
869
|
+
|
870
|
+
# Value for [text
|
871
|
+
# input][google.shopping.merchant.issueresolution.v1beta.InputField.TextInput]
|
872
|
+
# field.
|
873
|
+
# @!attribute [rw] value
|
874
|
+
# @return [::String]
|
875
|
+
# Required. Text provided by the business.
|
876
|
+
class TextInputValue
|
877
|
+
include ::Google::Protobuf::MessageExts
|
878
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
879
|
+
end
|
880
|
+
|
881
|
+
# Value for [choice
|
882
|
+
# input][google.shopping.merchant.issueresolution.v1beta.InputField.ChoiceInput]
|
883
|
+
# field.
|
884
|
+
# @!attribute [rw] choice_input_option_id
|
885
|
+
# @return [::String]
|
886
|
+
# Required. [Id][InputField.ChoiceInput.id] of the option that was selected
|
887
|
+
# by the business.
|
888
|
+
class ChoiceInputValue
|
889
|
+
include ::Google::Protobuf::MessageExts
|
890
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
891
|
+
end
|
892
|
+
|
893
|
+
# Value for [checkbox
|
894
|
+
# input][google.shopping.merchant.issueresolution.v1beta.InputField.CheckboxInput]
|
895
|
+
# field.
|
896
|
+
# @!attribute [rw] value
|
897
|
+
# @return [::Boolean]
|
898
|
+
# Required. True if the business checked the box field. False otherwise.
|
899
|
+
class CheckboxInputValue
|
900
|
+
include ::Google::Protobuf::MessageExts
|
901
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
902
|
+
end
|
903
|
+
end
|
904
|
+
|
905
|
+
# Enum specifying the severity of the issue.
|
906
|
+
module Severity
|
907
|
+
# Default value. Will never be provided by the API.
|
908
|
+
SEVERITY_UNSPECIFIED = 0
|
909
|
+
|
910
|
+
# Causes either an account suspension or an item disapproval. Errors should
|
911
|
+
# be resolved as soon as possible to ensure items are eligible to appear in
|
912
|
+
# results again.
|
913
|
+
ERROR = 1
|
914
|
+
|
915
|
+
# Warnings can negatively impact the performance of ads and can lead to item
|
916
|
+
# or account suspensions in the future unless the issue is resolved.
|
917
|
+
WARNING = 2
|
918
|
+
|
919
|
+
# Infos are suggested optimizations to increase data quality. Resolving these
|
920
|
+
# issues is recommended, but not required.
|
921
|
+
INFO = 3
|
922
|
+
end
|
923
|
+
|
924
|
+
# Enum specifying how is the content returned.
|
925
|
+
module ContentOption
|
926
|
+
# Default value. Will never be provided by the API.
|
927
|
+
CONTENT_OPTION_UNSPECIFIED = 0
|
928
|
+
|
929
|
+
# Returns the detail of the issue as a pre-rendered HTML text.
|
930
|
+
PRE_RENDERED_HTML = 1
|
931
|
+
end
|
932
|
+
|
933
|
+
# Enum specifying how actions with user input forms, such as requesting
|
934
|
+
# re-review, are handled.
|
935
|
+
module UserInputActionRenderingOption
|
936
|
+
# Default value. Will never be provided by the API.
|
937
|
+
USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED = 0
|
938
|
+
|
939
|
+
# Actions that require user input are represented only as links that points
|
940
|
+
# the business to Merchant Center where they can request the action. Provides
|
941
|
+
# easier to implement alternative to `BUILT_IN_USER_INPUT_ACTIONS`.
|
942
|
+
REDIRECT_TO_MERCHANT_CENTER = 1
|
943
|
+
|
944
|
+
# Returns content and input form definition for each complex action. Your
|
945
|
+
# application needs to display this content and input form to the business
|
946
|
+
# before they can request processing of the action. To start the action, your
|
947
|
+
# application needs to call the `triggeraction` method.
|
948
|
+
BUILT_IN_USER_INPUT_ACTIONS = 2
|
949
|
+
end
|
950
|
+
end
|
951
|
+
end
|
952
|
+
end
|
953
|
+
end
|
954
|
+
end
|