google-shopping-merchant-promotions-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 +144 -8
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_common_pb.rb +62 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_pb.rb +57 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_service/client.rb +642 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_service/credentials.rb +49 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_service/paths.rb +52 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/client.rb +595 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest/service_stub.rb +249 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_service/rest.rb +54 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_service.rb +57 -0
- data/lib/google/shopping/merchant/promotions/v1beta/promotions_services_pb.rb +60 -0
- data/lib/google/shopping/merchant/promotions/v1beta/rest.rb +39 -0
- data/lib/google/shopping/merchant/promotions/v1beta/version.rb +7 -2
- data/lib/google/shopping/merchant/promotions/v1beta.rb +47 -0
- data/lib/google-shopping-merchant-promotions-v1beta.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +399 -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 +222 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb +176 -0
- data/proto_docs/google/shopping/merchant/promotions/v1beta/promotions_common.rb +445 -0
- data/proto_docs/google/shopping/type/types.rb +210 -0
- data/proto_docs/google/type/interval.rb +45 -0
- metadata +89 -10
@@ -0,0 +1,445 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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 Promotions
|
24
|
+
module V1beta
|
25
|
+
# Attributes.
|
26
|
+
# @!attribute [rw] product_applicability
|
27
|
+
# @return [::Google::Shopping::Merchant::Promotions::V1beta::ProductApplicability]
|
28
|
+
# Required. Applicability of the promotion to either all products or
|
29
|
+
# [only specific
|
30
|
+
# products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC).
|
31
|
+
# @!attribute [rw] offer_type
|
32
|
+
# @return [::Google::Shopping::Merchant::Promotions::V1beta::OfferType]
|
33
|
+
# Required.
|
34
|
+
# [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC)
|
35
|
+
# of the promotion. Use this attribute to indicate whether or not customers
|
36
|
+
# need a coupon code to redeem your promotion.
|
37
|
+
# @!attribute [rw] generic_redemption_code
|
38
|
+
# @return [::String]
|
39
|
+
# Optional. Generic redemption code for the promotion. To be used with the
|
40
|
+
# `offerType` field and must meet the [minimum
|
41
|
+
# requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC).
|
42
|
+
# @!attribute [rw] long_title
|
43
|
+
# @return [::String]
|
44
|
+
# Required. [Long
|
45
|
+
# title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC)
|
46
|
+
# for the promotion.
|
47
|
+
# @!attribute [rw] coupon_value_type
|
48
|
+
# @return [::Google::Shopping::Merchant::Promotions::V1beta::CouponValueType]
|
49
|
+
# Required. The [coupon value type]
|
50
|
+
# (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC)
|
51
|
+
# attribute to signal the type of promotion that you are running. Depending
|
52
|
+
# on type of the selected coupon value [some attributes are
|
53
|
+
# required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
|
54
|
+
# @!attribute [rw] promotion_destinations
|
55
|
+
# @return [::Array<::Google::Shopping::Type::Destination::DestinationEnum>]
|
56
|
+
# Required. The list of destinations where the promotion applies to. If you
|
57
|
+
# don't specify a destination by including a supported value in your data
|
58
|
+
# source, your promotion will display in Shopping ads and free listings by
|
59
|
+
# default.
|
60
|
+
#
|
61
|
+
# You may have previously submitted the following values as destinations for
|
62
|
+
# your products: Shopping Actions, Surfaces across Google, Local surfaces
|
63
|
+
# across Google. To represent these values use `FREE_LISTINGS`,
|
64
|
+
# `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see
|
65
|
+
# [Promotion
|
66
|
+
# destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC)
|
67
|
+
# @!attribute [rw] item_id_inclusion
|
68
|
+
# @return [::Array<::String>]
|
69
|
+
# Optional. Product filter by [item
|
70
|
+
# ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC)
|
71
|
+
# for the promotion. The product filter attributes only applies when the
|
72
|
+
# products eligible for promotion product applicability
|
73
|
+
# `product_applicability` attribute is set to
|
74
|
+
# [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
|
75
|
+
# @!attribute [rw] brand_inclusion
|
76
|
+
# @return [::Array<::String>]
|
77
|
+
# Optional. Product filter by brand for the promotion. The product filter
|
78
|
+
# attributes only applies when the products eligible for promotion product
|
79
|
+
# applicability `product_applicability` attribute is set to
|
80
|
+
# [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
|
81
|
+
# @!attribute [rw] item_group_id_inclusion
|
82
|
+
# @return [::Array<::String>]
|
83
|
+
# Optional. Product filter by item group ID for the promotion. The product
|
84
|
+
# filter attributes only applies when the products eligible for promotion
|
85
|
+
# product applicability [product_applicability] attribute is set to
|
86
|
+
# [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
|
87
|
+
# @!attribute [rw] product_type_inclusion
|
88
|
+
# @return [::Array<::String>]
|
89
|
+
# Optional. Product filter by product type for the promotion. The product
|
90
|
+
# filter attributes only applies when the products eligible for promotion
|
91
|
+
# product applicability `product_applicability` attribute is set to
|
92
|
+
# [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
|
93
|
+
# @!attribute [rw] item_id_exclusion
|
94
|
+
# @return [::Array<::String>]
|
95
|
+
# Optional. Product filter by [item ID
|
96
|
+
# exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC)
|
97
|
+
# for the promotion. The product filter attributes only applies when the
|
98
|
+
# products eligible for promotion product applicability
|
99
|
+
# `product_applicability` attribute is set to
|
100
|
+
# [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
|
101
|
+
# @!attribute [rw] brand_exclusion
|
102
|
+
# @return [::Array<::String>]
|
103
|
+
# Optional. Product filter by [brand
|
104
|
+
# exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC)
|
105
|
+
# for the promotion. The product filter attributes only applies when the
|
106
|
+
# products eligible for promotion product applicability
|
107
|
+
# `product_applicability` attribute is set to
|
108
|
+
# [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
|
109
|
+
# @!attribute [rw] item_group_id_exclusion
|
110
|
+
# @return [::Array<::String>]
|
111
|
+
# Optional. Product filter by [item group
|
112
|
+
# ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC).
|
113
|
+
# The product filter attributes only applies when the products eligible for
|
114
|
+
# promotion product applicability `product_applicability` attribute is set to
|
115
|
+
# [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
|
116
|
+
# exclusion for the promotion.
|
117
|
+
# @!attribute [rw] product_type_exclusion
|
118
|
+
# @return [::Array<::String>]
|
119
|
+
# Optional. Product filter by [product type
|
120
|
+
# exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC)
|
121
|
+
# for the promotion. The product filter attributes only applies when the
|
122
|
+
# products eligible for promotion product applicability
|
123
|
+
# `product_applicability` attribute is set to
|
124
|
+
# [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
|
125
|
+
# @!attribute [rw] minimum_purchase_amount
|
126
|
+
# @return [::Google::Shopping::Type::Price]
|
127
|
+
# Optional. [Minimum purchase
|
128
|
+
# amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC)
|
129
|
+
# for the promotion.
|
130
|
+
# @!attribute [rw] minimum_purchase_quantity
|
131
|
+
# @return [::Integer]
|
132
|
+
# Optional. [Minimum purchase
|
133
|
+
# quantity](https://support.google.com/merchants/answer/13838182?ref_topic=13773355&sjid=17642868584668136159-NC)
|
134
|
+
# for the promotion.
|
135
|
+
# @!attribute [rw] limit_quantity
|
136
|
+
# @return [::Integer]
|
137
|
+
# Optional. [Maximum purchase
|
138
|
+
# quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC)
|
139
|
+
# for the promotion.
|
140
|
+
# @!attribute [rw] limit_value
|
141
|
+
# @return [::Google::Shopping::Type::Price]
|
142
|
+
# Optional. [Maximum product
|
143
|
+
# price](https://support.google.com/merchants/answer/2906014) for
|
144
|
+
# promotion.
|
145
|
+
# @!attribute [rw] percent_off
|
146
|
+
# @return [::Integer]
|
147
|
+
# Optional. The [percentage
|
148
|
+
# discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC)
|
149
|
+
# offered in the promotion.
|
150
|
+
# @!attribute [rw] money_off_amount
|
151
|
+
# @return [::Google::Shopping::Type::Price]
|
152
|
+
# Optional. The [money off
|
153
|
+
# amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC)
|
154
|
+
# offered in the promotion.
|
155
|
+
# @!attribute [rw] get_this_quantity_discounted
|
156
|
+
# @return [::Integer]
|
157
|
+
# Optional. The number of items discounted in the promotion. The attribute is
|
158
|
+
# set when `couponValueType` is equal to `buy_m_get_n_money_off` or
|
159
|
+
# `buy_m_get_n_percent_off`.
|
160
|
+
# @!attribute [rw] free_gift_value
|
161
|
+
# @return [::Google::Shopping::Type::Price]
|
162
|
+
# Optional. [Free gift
|
163
|
+
# value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC)
|
164
|
+
# for the promotion.
|
165
|
+
# @!attribute [rw] free_gift_description
|
166
|
+
# @return [::String]
|
167
|
+
# Optional. [Free gift
|
168
|
+
# description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC)
|
169
|
+
# for the promotion.
|
170
|
+
# @!attribute [rw] free_gift_item_id
|
171
|
+
# @return [::String]
|
172
|
+
# Optional. [Free gift item
|
173
|
+
# ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC)
|
174
|
+
# for the promotion.
|
175
|
+
# @!attribute [rw] promotion_effective_time_period
|
176
|
+
# @return [::Google::Type::Interval]
|
177
|
+
# Required. `TimePeriod` representation of the promotion's effective dates.
|
178
|
+
# This attribute specifies that the promotion can be tested on your online
|
179
|
+
# store during this time period.
|
180
|
+
# @!attribute [rw] promotion_display_time_period
|
181
|
+
# @return [::Google::Type::Interval]
|
182
|
+
# Optional. `TimePeriod` representation of the promotion's display dates.
|
183
|
+
# This attribute specifies the date and time frame when the promotion will be
|
184
|
+
# live on Google.com and Shopping ads. If the display time period for
|
185
|
+
# promotion `promotion_display_time_period` attribute is not specified, the
|
186
|
+
# promotion effective time period `promotion_effective_time_period`
|
187
|
+
# determines the date and time frame when the promotion will be live on
|
188
|
+
# Google.com and Shopping ads.
|
189
|
+
# @!attribute [rw] store_applicability
|
190
|
+
# @return [::Google::Shopping::Merchant::Promotions::V1beta::StoreApplicability]
|
191
|
+
# Optional. Whether the promotion applies to [all stores, or only specified
|
192
|
+
# stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC).
|
193
|
+
# Local Inventory ads promotions throw an error if no store applicability is
|
194
|
+
# included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is
|
195
|
+
# set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion`
|
196
|
+
# is set to a value.
|
197
|
+
# @!attribute [rw] store_codes_inclusion
|
198
|
+
# @return [::Array<::String>]
|
199
|
+
# Optional. [Store codes to
|
200
|
+
# include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC)
|
201
|
+
# for the promotion. The store filter attributes only applies when the
|
202
|
+
# `store_applicability` attribute is set to
|
203
|
+
# [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
|
204
|
+
#
|
205
|
+
# Store code (the store ID from
|
206
|
+
# your Business Profile) of the physical store the product is sold in. See
|
207
|
+
# the [Local product inventory data
|
208
|
+
# specification](https://support.google.com/merchants/answer/3061342) for
|
209
|
+
# more information.
|
210
|
+
# @!attribute [rw] store_codes_exclusion
|
211
|
+
# @return [::Array<::String>]
|
212
|
+
# Optional. [Store codes to
|
213
|
+
# exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC)
|
214
|
+
# for the promotion. The store filter attributes only applies when the
|
215
|
+
# `store_applicability` attribute is set to
|
216
|
+
# [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
|
217
|
+
# @!attribute [rw] promotion_url
|
218
|
+
# @return [::String]
|
219
|
+
# Optional. URL to the page on the merchant's site where the promotion shows.
|
220
|
+
# Local Inventory ads promotions throw an error if no `promotion_url` is
|
221
|
+
# included. URL is used to confirm that the promotion is valid and can be
|
222
|
+
# redeemed.
|
223
|
+
class Attributes
|
224
|
+
include ::Google::Protobuf::MessageExts
|
225
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
226
|
+
end
|
227
|
+
|
228
|
+
# The status of the promotion.
|
229
|
+
# @!attribute [r] destination_statuses
|
230
|
+
# @return [::Array<::Google::Shopping::Merchant::Promotions::V1beta::PromotionStatus::DestinationStatus>]
|
231
|
+
# Output only. The intended destinations for the promotion.
|
232
|
+
# @!attribute [r] item_level_issues
|
233
|
+
# @return [::Array<::Google::Shopping::Merchant::Promotions::V1beta::PromotionStatus::ItemLevelIssue>]
|
234
|
+
# Output only. A list of issues associated with the promotion.
|
235
|
+
# @!attribute [r] creation_date
|
236
|
+
# @return [::Google::Protobuf::Timestamp]
|
237
|
+
# Output only. Date on which the promotion has been created
|
238
|
+
# in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time,
|
239
|
+
# and offset, for example `2020-01-02T09:00:00+01:00` or
|
240
|
+
# `2020-01-02T09:00:00Z`
|
241
|
+
# @!attribute [r] last_update_date
|
242
|
+
# @return [::Google::Protobuf::Timestamp]
|
243
|
+
# Output only. Date on which the promotion status has been last updated
|
244
|
+
# in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time,
|
245
|
+
# and offset, for example `2020-01-02T09:00:00+01:00` or
|
246
|
+
# `2020-01-02T09:00:00Z`
|
247
|
+
class PromotionStatus
|
248
|
+
include ::Google::Protobuf::MessageExts
|
249
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
250
|
+
|
251
|
+
# The status for the specified destination.
|
252
|
+
# @!attribute [r] reporting_context
|
253
|
+
# @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
|
254
|
+
# Output only. The name of the promotion destination.
|
255
|
+
# @!attribute [r] status
|
256
|
+
# @return [::Google::Shopping::Merchant::Promotions::V1beta::PromotionStatus::DestinationStatus::State]
|
257
|
+
# Output only. The status for the specified destination.
|
258
|
+
class DestinationStatus
|
259
|
+
include ::Google::Protobuf::MessageExts
|
260
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
261
|
+
|
262
|
+
# The current state of the promotion.
|
263
|
+
module State
|
264
|
+
# Unknown promotion state.
|
265
|
+
STATE_UNSPECIFIED = 0
|
266
|
+
|
267
|
+
# The promotion is under review.
|
268
|
+
IN_REVIEW = 1
|
269
|
+
|
270
|
+
# The promotion is disapproved.
|
271
|
+
REJECTED = 2
|
272
|
+
|
273
|
+
# The promotion is approved and active.
|
274
|
+
LIVE = 3
|
275
|
+
|
276
|
+
# The promotion is stopped by merchant.
|
277
|
+
STOPPED = 4
|
278
|
+
|
279
|
+
# The promotion is no longer active.
|
280
|
+
EXPIRED = 5
|
281
|
+
|
282
|
+
# The promotion is not stopped, and all reviews are approved, but the
|
283
|
+
# active date is in the future.
|
284
|
+
PENDING = 6
|
285
|
+
end
|
286
|
+
end
|
287
|
+
|
288
|
+
# The issue associated with the promotion.
|
289
|
+
# @!attribute [r] code
|
290
|
+
# @return [::String]
|
291
|
+
# Output only. The error code of the issue.
|
292
|
+
# @!attribute [r] severity
|
293
|
+
# @return [::Google::Shopping::Merchant::Promotions::V1beta::PromotionStatus::ItemLevelIssue::Severity]
|
294
|
+
# Output only. How this issue affects serving of the promotion.
|
295
|
+
# @!attribute [r] resolution
|
296
|
+
# @return [::String]
|
297
|
+
# Output only. Whether the issue can be resolved by the merchant.
|
298
|
+
# @!attribute [r] attribute
|
299
|
+
# @return [::String]
|
300
|
+
# Output only. The attribute's name, if the issue is caused by a single
|
301
|
+
# attribute.
|
302
|
+
# @!attribute [r] reporting_context
|
303
|
+
# @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
|
304
|
+
# Output only. The destination the issue applies to.
|
305
|
+
# @!attribute [r] description
|
306
|
+
# @return [::String]
|
307
|
+
# Output only. A short issue description in English.
|
308
|
+
# @!attribute [r] detail
|
309
|
+
# @return [::String]
|
310
|
+
# Output only. A detailed issue description in English.
|
311
|
+
# @!attribute [r] documentation
|
312
|
+
# @return [::String]
|
313
|
+
# Output only. The URL of a web page to help with resolving this issue.
|
314
|
+
# @!attribute [r] applicable_countries
|
315
|
+
# @return [::Array<::String>]
|
316
|
+
# Output only. List of country codes (ISO 3166-1 alpha-2) where issue
|
317
|
+
# applies to the offer.
|
318
|
+
class ItemLevelIssue
|
319
|
+
include ::Google::Protobuf::MessageExts
|
320
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
321
|
+
|
322
|
+
# The severity of the issue.
|
323
|
+
module Severity
|
324
|
+
# Not specified.
|
325
|
+
SEVERITY_UNSPECIFIED = 0
|
326
|
+
|
327
|
+
# This issue represents a warning and does not have a direct affect
|
328
|
+
# on the promotion.
|
329
|
+
NOT_IMPACTED = 1
|
330
|
+
|
331
|
+
# The promotion is demoted and most likely have limited performance
|
332
|
+
# in search results
|
333
|
+
DEMOTED = 2
|
334
|
+
|
335
|
+
# Issue disapproves the promotion.
|
336
|
+
DISAPPROVED = 3
|
337
|
+
end
|
338
|
+
end
|
339
|
+
end
|
340
|
+
|
341
|
+
# Which product or list of products the promotion applies to.
|
342
|
+
module ProductApplicability
|
343
|
+
# Which products the promotion applies to is unknown.
|
344
|
+
PRODUCT_APPLICABILITY_UNSPECIFIED = 0
|
345
|
+
|
346
|
+
# Applicable to all products.
|
347
|
+
ALL_PRODUCTS = 1
|
348
|
+
|
349
|
+
# Applicable to only a single product or list of products.
|
350
|
+
SPECIFIC_PRODUCTS = 2
|
351
|
+
end
|
352
|
+
|
353
|
+
# Store codes or list of store codes the promotion applies to. Only for
|
354
|
+
# Local inventory ads promotions.
|
355
|
+
module StoreApplicability
|
356
|
+
# Which store codes the promotion applies to is unknown.
|
357
|
+
STORE_APPLICABILITY_UNSPECIFIED = 0
|
358
|
+
|
359
|
+
# Promotion applies to all stores.
|
360
|
+
ALL_STORES = 1
|
361
|
+
|
362
|
+
# Promotion applies to only the specified stores.
|
363
|
+
SPECIFIC_STORES = 2
|
364
|
+
end
|
365
|
+
|
366
|
+
# Offer type of a promotion.
|
367
|
+
module OfferType
|
368
|
+
# Unknown offer type.
|
369
|
+
OFFER_TYPE_UNSPECIFIED = 0
|
370
|
+
|
371
|
+
# Offer type without a code.
|
372
|
+
NO_CODE = 1
|
373
|
+
|
374
|
+
# Offer type with a code. Generic redemption code for the promotion is
|
375
|
+
# required when `offerType` = `GENERIC_CODE`.
|
376
|
+
GENERIC_CODE = 2
|
377
|
+
end
|
378
|
+
|
379
|
+
# Channel of a promotion.
|
380
|
+
module RedemptionChannel
|
381
|
+
# Indicates that the channel is unspecified.
|
382
|
+
REDEMPTION_CHANNEL_UNSPECIFIED = 0
|
383
|
+
|
384
|
+
# Indicates that the channel is in store.
|
385
|
+
# This is same as `local` channel used for `products`.
|
386
|
+
IN_STORE = 1
|
387
|
+
|
388
|
+
# Indicates that the channel is online.
|
389
|
+
ONLINE = 2
|
390
|
+
end
|
391
|
+
|
392
|
+
# [Coupon value
|
393
|
+
# type](https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC)
|
394
|
+
# of a promotion.
|
395
|
+
module CouponValueType
|
396
|
+
# Indicates that the coupon value type is unspecified.
|
397
|
+
COUPON_VALUE_TYPE_UNSPECIFIED = 0
|
398
|
+
|
399
|
+
# Money off coupon value type.
|
400
|
+
MONEY_OFF = 1
|
401
|
+
|
402
|
+
# Percent off coupon value type.
|
403
|
+
PERCENT_OFF = 2
|
404
|
+
|
405
|
+
# Buy M quantity, get N money off coupon value type.
|
406
|
+
# `minimum_purchase_quantity` and `get_this_quantity_discounted` must be
|
407
|
+
# present. `money_off_amount` must also be present.
|
408
|
+
BUY_M_GET_N_MONEY_OFF = 3
|
409
|
+
|
410
|
+
# Buy M quantity, get N percent off coupon value type.
|
411
|
+
# `minimum_purchase_quantity` and `get_this_quantity_discounted` must be
|
412
|
+
# present. `percent_off_percentage` must also be present.
|
413
|
+
BUY_M_GET_N_PERCENT_OFF = 4
|
414
|
+
|
415
|
+
# Buy M quantity, get money off. `minimum_purchase_quantity` and
|
416
|
+
# `money_off_amount` must be present.
|
417
|
+
BUY_M_GET_MONEY_OFF = 5
|
418
|
+
|
419
|
+
# Buy M quantity, get money off. `minimum_purchase_quantity` and
|
420
|
+
# `percent_off_percentage` must be present.
|
421
|
+
BUY_M_GET_PERCENT_OFF = 6
|
422
|
+
|
423
|
+
# Free gift with description only.
|
424
|
+
FREE_GIFT = 7
|
425
|
+
|
426
|
+
# Free gift with monetary value.
|
427
|
+
FREE_GIFT_WITH_VALUE = 8
|
428
|
+
|
429
|
+
# Free gift with item ID.
|
430
|
+
FREE_GIFT_WITH_ITEM_ID = 9
|
431
|
+
|
432
|
+
# Standard free shipping coupon value type.
|
433
|
+
FREE_SHIPPING_STANDARD = 10
|
434
|
+
|
435
|
+
# Overnight free shipping coupon value type.
|
436
|
+
FREE_SHIPPING_OVERNIGHT = 11
|
437
|
+
|
438
|
+
# Two day free shipping coupon value type.
|
439
|
+
FREE_SHIPPING_TWO_DAY = 12
|
440
|
+
end
|
441
|
+
end
|
442
|
+
end
|
443
|
+
end
|
444
|
+
end
|
445
|
+
end
|
@@ -0,0 +1,210 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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 Type
|
23
|
+
# The weight represented as the value in string and the unit.
|
24
|
+
# @!attribute [rw] amount_micros
|
25
|
+
# @return [::Integer]
|
26
|
+
# Required. The weight represented as a number in micros (1 million micros is
|
27
|
+
# an equivalent to one's currency standard unit, for example, 1 kg = 1000000
|
28
|
+
# micros).
|
29
|
+
# This field can also be set as infinity by setting to -1.
|
30
|
+
# This field only support -1 and positive value.
|
31
|
+
# @!attribute [rw] unit
|
32
|
+
# @return [::Google::Shopping::Type::Weight::WeightUnit]
|
33
|
+
# Required. The weight unit.
|
34
|
+
# Acceptable values are: kg and lb
|
35
|
+
class Weight
|
36
|
+
include ::Google::Protobuf::MessageExts
|
37
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
38
|
+
|
39
|
+
# The weight unit.
|
40
|
+
module WeightUnit
|
41
|
+
# unit unspecified
|
42
|
+
WEIGHT_UNIT_UNSPECIFIED = 0
|
43
|
+
|
44
|
+
# lb unit.
|
45
|
+
POUND = 1
|
46
|
+
|
47
|
+
# kg unit.
|
48
|
+
KILOGRAM = 2
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
# The price represented as a number and currency.
|
53
|
+
# @!attribute [rw] amount_micros
|
54
|
+
# @return [::Integer]
|
55
|
+
# The price represented as a number in micros (1 million micros is an
|
56
|
+
# equivalent to one's currency standard unit, for example, 1 USD = 1000000
|
57
|
+
# micros).
|
58
|
+
# @!attribute [rw] currency_code
|
59
|
+
# @return [::String]
|
60
|
+
# The currency of the price using three-letter acronyms according to [ISO
|
61
|
+
# 4217](http://en.wikipedia.org/wiki/ISO_4217).
|
62
|
+
class Price
|
63
|
+
include ::Google::Protobuf::MessageExts
|
64
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
|
+
end
|
66
|
+
|
67
|
+
# A message that represents custom attributes. Exactly one of `value` or
|
68
|
+
# `group_values` must not be empty.
|
69
|
+
# @!attribute [rw] name
|
70
|
+
# @return [::String]
|
71
|
+
# The name of the attribute.
|
72
|
+
# @!attribute [rw] value
|
73
|
+
# @return [::String]
|
74
|
+
# The value of the attribute. If `value` is not empty, `group_values` must be
|
75
|
+
# empty.
|
76
|
+
# @!attribute [rw] group_values
|
77
|
+
# @return [::Array<::Google::Shopping::Type::CustomAttribute>]
|
78
|
+
# Subattributes within this attribute group. If
|
79
|
+
# `group_values` is not empty, `value` must be empty.
|
80
|
+
class CustomAttribute
|
81
|
+
include ::Google::Protobuf::MessageExts
|
82
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
|
+
end
|
84
|
+
|
85
|
+
# Destinations available for a product.
|
86
|
+
#
|
87
|
+
# Destinations are used in Merchant Center to allow you to control where the
|
88
|
+
# products from your data feed should be displayed.
|
89
|
+
class Destination
|
90
|
+
include ::Google::Protobuf::MessageExts
|
91
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
92
|
+
|
93
|
+
# Destination values.
|
94
|
+
module DestinationEnum
|
95
|
+
# Not specified.
|
96
|
+
DESTINATION_ENUM_UNSPECIFIED = 0
|
97
|
+
|
98
|
+
# [Shopping ads](https://support.google.com/google-ads/answer/2454022).
|
99
|
+
SHOPPING_ADS = 1
|
100
|
+
|
101
|
+
# [Display ads](https://support.google.com/merchants/answer/6069387).
|
102
|
+
DISPLAY_ADS = 2
|
103
|
+
|
104
|
+
# [Local inventory
|
105
|
+
# ads](https://support.google.com/merchants/answer/3057972).
|
106
|
+
LOCAL_INVENTORY_ADS = 3
|
107
|
+
|
108
|
+
# [Free listings](https://support.google.com/merchants/answer/9199328).
|
109
|
+
FREE_LISTINGS = 4
|
110
|
+
|
111
|
+
# [Free local product
|
112
|
+
# listings](https://support.google.com/merchants/answer/9825611).
|
113
|
+
FREE_LOCAL_LISTINGS = 5
|
114
|
+
|
115
|
+
# [YouTube Shopping](https://support.google.com/merchants/answer/12362804).
|
116
|
+
YOUTUBE_SHOPPING = 6
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
# Reporting contexts that your account and product issues apply to.
|
121
|
+
#
|
122
|
+
# Reporting contexts are groups of surfaces and formats for product results on
|
123
|
+
# Google. They can represent the entire destination (for example, [Shopping
|
124
|
+
# ads](https://support.google.com/merchants/answer/6149970)) or a subset of
|
125
|
+
# formats within a destination (for example, [Demand Gen
|
126
|
+
# ads](https://support.google.com/merchants/answer/13389785)).
|
127
|
+
class ReportingContext
|
128
|
+
include ::Google::Protobuf::MessageExts
|
129
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
130
|
+
|
131
|
+
# Reporting context values.
|
132
|
+
module ReportingContextEnum
|
133
|
+
# Not specified.
|
134
|
+
REPORTING_CONTEXT_ENUM_UNSPECIFIED = 0
|
135
|
+
|
136
|
+
# [Shopping ads](https://support.google.com/merchants/answer/6149970).
|
137
|
+
SHOPPING_ADS = 1
|
138
|
+
|
139
|
+
# Deprecated: Use `DEMAND_GEN_ADS` instead.
|
140
|
+
# [Discovery and Demand Gen
|
141
|
+
# ads](https://support.google.com/merchants/answer/13389785).
|
142
|
+
DISCOVERY_ADS = 2
|
143
|
+
|
144
|
+
# [Demand Gen ads](https://support.google.com/merchants/answer/13389785).
|
145
|
+
DEMAND_GEN_ADS = 13
|
146
|
+
|
147
|
+
# [Demand Gen ads on Discover
|
148
|
+
# surface](https://support.google.com/merchants/answer/13389785).
|
149
|
+
DEMAND_GEN_ADS_DISCOVER_SURFACE = 14
|
150
|
+
|
151
|
+
# [Video ads](https://support.google.com/google-ads/answer/6340491).
|
152
|
+
VIDEO_ADS = 3
|
153
|
+
|
154
|
+
# [Display ads](https://support.google.com/merchants/answer/6069387).
|
155
|
+
DISPLAY_ADS = 4
|
156
|
+
|
157
|
+
# [Local inventory
|
158
|
+
# ads](https://support.google.com/merchants/answer/3271956).
|
159
|
+
LOCAL_INVENTORY_ADS = 5
|
160
|
+
|
161
|
+
# [Vehicle inventory
|
162
|
+
# ads](https://support.google.com/merchants/answer/11544533).
|
163
|
+
VEHICLE_INVENTORY_ADS = 6
|
164
|
+
|
165
|
+
# [Free product
|
166
|
+
# listings](https://support.google.com/merchants/answer/9199328).
|
167
|
+
FREE_LISTINGS = 7
|
168
|
+
|
169
|
+
# [Free local product
|
170
|
+
# listings](https://support.google.com/merchants/answer/9825611).
|
171
|
+
FREE_LOCAL_LISTINGS = 8
|
172
|
+
|
173
|
+
# [Free local vehicle
|
174
|
+
# listings](https://support.google.com/merchants/answer/11544533).
|
175
|
+
FREE_LOCAL_VEHICLE_LISTINGS = 9
|
176
|
+
|
177
|
+
# [YouTube
|
178
|
+
# Shopping](https://support.google.com/merchants/answer/13478370).
|
179
|
+
YOUTUBE_SHOPPING = 10
|
180
|
+
|
181
|
+
# [Cloud retail](https://cloud.google.com/solutions/retail).
|
182
|
+
CLOUD_RETAIL = 11
|
183
|
+
|
184
|
+
# [Local cloud retail](https://cloud.google.com/solutions/retail).
|
185
|
+
LOCAL_CLOUD_RETAIL = 12
|
186
|
+
end
|
187
|
+
end
|
188
|
+
|
189
|
+
# [Channel](https://support.google.com/merchants/answer/7361332) of a product.
|
190
|
+
#
|
191
|
+
# Channel is used to distinguish between online and local products.
|
192
|
+
class Channel
|
193
|
+
include ::Google::Protobuf::MessageExts
|
194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
|
+
|
196
|
+
# Channel values.
|
197
|
+
module ChannelEnum
|
198
|
+
# Not specified.
|
199
|
+
CHANNEL_ENUM_UNSPECIFIED = 0
|
200
|
+
|
201
|
+
# Online product.
|
202
|
+
ONLINE = 1
|
203
|
+
|
204
|
+
# Local product.
|
205
|
+
LOCAL = 2
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|
210
|
+
end
|