@@ -32,6 +32,8 @@ class Attributes
32
32
attr_accessor :additional_image_links
33
33
34
34
# Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
35
+ # For more information, see [Display ads attribute](https://support.google.com/
36
+ # merchants/answer/6069387).
35
37
# Corresponds to the JSON property `adsGrouping`
36
38
# @return [String]
37
39
attr_accessor :ads_grouping
@@ -64,7 +66,8 @@ class Attributes
64
66
# @return [Google::Apis::MerchantapiProductsV1beta::Price]
65
67
attr_accessor :auto_pricing_min_price
66
68
67
- # Availability status of the item.
69
+ # [Availability](https://support.google.com/merchants/answer/6324448) status of
70
+ # the item. For example, "in_stock" or "out_of_stock".
68
71
# Corresponds to the JSON property `availability`
69
72
# @return [String]
70
73
attr_accessor :availability
@@ -75,7 +78,8 @@ class Attributes
75
78
# @return [String]
76
79
attr_accessor :availability_date
77
80
78
- # Brand of the item.
81
+ # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For
82
+ # example, "Google".
79
83
# Corresponds to the JSON property `brand`
80
84
# @return [String]
81
85
attr_accessor :brand
@@ -98,12 +102,14 @@ class Attributes
98
102
# @return [Array<Google::Apis::MerchantapiProductsV1beta::CloudExportAdditionalProperties>]
99
103
attr_accessor :cloud_export_additional_properties
100
104
101
- # Color of the item.
105
+ # [Color](https://support.google.com/merchants/answer/6324487) of the item. For
106
+ # example, "red".
102
107
# Corresponds to the JSON property `color`
103
108
# @return [String]
104
109
attr_accessor :color
105
110
106
- # Condition or state of the item.
111
+ # [Condition](https://support.google.com/merchants/answer/6324469) or state of
112
+ # the item. For example, "new" or "used".
107
113
# Corresponds to the JSON property `condition`
108
114
# @return [String]
109
115
attr_accessor :condition
@@ -113,27 +119,32 @@ class Attributes
113
119
# @return [Google::Apis::MerchantapiProductsV1beta::Price]
114
120
attr_accessor :cost_of_goods_sold
115
121
116
- # Custom label 0 for custom grouping of items in a Shopping campaign.
122
+ # [Custom label 0](https://support.google.com/merchants/answer/6324473) for
123
+ # custom grouping of items in a Shopping campaign.
117
124
# Corresponds to the JSON property `customLabel0`
118
125
# @return [String]
119
126
attr_accessor :custom_label0
120
127
121
- # Custom label 1 for custom grouping of items in a Shopping campaign.
128
+ # [Custom label 1](https://support.google.com/merchants/answer/6324473) for
129
+ # custom grouping of items in a Shopping campaign.
122
130
# Corresponds to the JSON property `customLabel1`
123
131
# @return [String]
124
132
attr_accessor :custom_label1
125
133
126
- # Custom label 2 for custom grouping of items in a Shopping campaign.
134
+ # [Custom label 2](https://support.google.com/merchants/answer/6324473) for
135
+ # custom grouping of items in a Shopping campaign.
127
136
# Corresponds to the JSON property `customLabel2`
128
137
# @return [String]
129
138
attr_accessor :custom_label2
130
139
131
- # Custom label 3 for custom grouping of items in a Shopping campaign.
140
+ # [Custom label 3](https://support.google.com/merchants/answer/6324473) for
141
+ # custom grouping of items in a Shopping campaign.
132
142
# Corresponds to the JSON property `customLabel3`
133
143
# @return [String]
134
144
attr_accessor :custom_label3
135
145
136
- # Custom label 4 for custom grouping of items in a Shopping campaign.
146
+ # [Custom label 4](https://support.google.com/merchants/answer/6324473) for
147
+ # custom grouping of items in a Shopping campaign.
137
148
# Corresponds to the JSON property `customLabel4`
138
149
# @return [String]
139
150
attr_accessor :custom_label4
@@ -145,7 +156,7 @@ class Attributes
145
156
146
157
# The date time when an offer becomes visible in search results across Google’s
147
158
# YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
148
- # See [Disclosure date]( https://support.google.com/merchants/answer/13034208)
159
+ # See [Disclosure date](https://support.google.com/merchants/answer/13034208)
149
160
# for more information.
150
161
# Corresponds to the JSON property `disclosureDate`
151
162
# @return [String]
@@ -161,7 +172,8 @@ class Attributes
161
172
# @return [String]
162
173
attr_accessor :display_ads_link
163
174
164
- # Advertiser-specified recommendations.
175
+ # Advertiser-specified recommendations. For more information, see [Display ads
176
+ # attribute specification](https://support.google.com/merchants/answer/6069387).
165
177
# Corresponds to the JSON property `displayAdsSimilarIds`
166
178
# @return [Array<String>]
167
179
attr_accessor :display_ads_similar_ids
@@ -171,7 +183,8 @@ class Attributes
171
183
# @return [String]
172
184
attr_accessor :display_ads_title
173
185
174
- # Offer margin for dynamic remarketing campaigns.
186
+ # Offer margin for dynamic remarketing campaigns. For more information, see [
187
+ # Display ads attribute](https://support.google.com/merchants/answer/6069387).
175
188
# Corresponds to the JSON property `displayAdsValue`
176
189
# @return [Float]
177
190
attr_accessor :display_ads_value
@@ -182,7 +195,10 @@ class Attributes
182
195
attr_accessor :energy_efficiency_class
183
196
184
197
# The list of destinations to exclude for this target (corresponds to unchecked
185
- # check boxes in Merchant Center).
198
+ # check boxes in Merchant Center). For more information, see [Excluded
199
+ # destination](https://support.google.com/merchants/answer/6324486). Note: We
200
+ # recommend setting destinations on datasources level for most use cases. Use
201
+ # this field within products to only setup exceptions.
186
202
# Corresponds to the JSON property `excludedDestinations`
187
203
# @return [Array<String>]
188
204
attr_accessor :excluded_destinations
@@ -207,7 +223,8 @@ class Attributes
207
223
# @return [Array<Google::Apis::MerchantapiProductsV1beta::FreeShippingThreshold>]
208
224
attr_accessor :free_shipping_threshold
209
225
210
- # Target gender of the item.
226
+ # Target [gender](https://support.google.com/merchants/answer/6324479) of the
227
+ # item. For example, "male" or "female".
211
228
# Corresponds to the JSON property `gender`
212
229
# @return [String]
213
230
attr_accessor :gender
@@ -241,7 +258,10 @@ class Attributes
241
258
242
259
# The list of destinations to include for this target (corresponds to checked
243
260
# check boxes in Merchant Center). Default destinations are always included
244
- # unless provided in `excludedDestinations`.
261
+ # unless provided in `excludedDestinations`. For more information, see [Included
262
+ # destination](https://support.google.com/merchants/answer/7501026). Note: We
263
+ # recommend setting destinations on datasources level for most use cases. Use
264
+ # this field within products to only setup exceptions.
245
265
# Corresponds to the JSON property `includedDestinations`
246
266
# @return [Array<String>]
247
267
attr_accessor :included_destinations
@@ -251,8 +271,9 @@ class Attributes
251
271
# @return [Google::Apis::MerchantapiProductsV1beta::Installment]
252
272
attr_accessor :installment
253
273
254
- # Whether the item is a merchant-defined bundle. A bundle is a custom grouping
255
- # of different products sold by a merchant for a single price.
274
+ # Whether the item is a business-defined sub-API. A [sub-API] (https://support.
275
+ # google.com/merchants/answer/6324449) is a custom grouping of different
276
+ # products sold by a business for a single price.
256
277
# Corresponds to the JSON property `isBundle`
257
278
# @return [Boolean]
258
279
attr_accessor :is_bundle
@@ -276,7 +297,8 @@ class Attributes
276
297
# @return [String]
277
298
attr_accessor :link
278
299
279
- # Link template for merchant hosted local storefront.
300
+ # [Link template](https://support.google.com/merchants/answer/13871172) for
301
+ # business hosted local storefront.
280
302
# Corresponds to the JSON property `linkTemplate`
281
303
# @return [String]
282
304
attr_accessor :link_template
@@ -292,7 +314,8 @@ class Attributes
292
314
# @return [Array<Google::Apis::MerchantapiProductsV1beta::LoyaltyProgram>]
293
315
attr_accessor :loyalty_programs
294
316
295
- # The material of which the item is made.
317
+ # The [material](https://support.google.com/merchants/answer/6324410) of which
318
+ # the item is made. For example, "Leather" or "Cotton".
296
319
# Corresponds to the JSON property `material`
297
320
# @return [String]
298
321
attr_accessor :material
@@ -322,8 +345,8 @@ class Attributes
322
345
# @return [String]
323
346
attr_accessor :mobile_link
324
347
325
- # Link template for merchant hosted local storefront optimized for mobile
326
- # devices.
348
+ # [ Link template](https://support.google.com/merchants/answer/13870216) for
349
+ # business hosted local storefront optimized for mobile devices.
327
350
# Corresponds to the JSON property `mobileLinkTemplate`
328
351
# @return [String]
329
352
attr_accessor :mobile_link_template
@@ -334,12 +357,13 @@ class Attributes
334
357
# @return [String]
335
358
attr_accessor :mpn
336
359
337
- # The number of identical products in a merchant -defined multipack.
360
+ # The number of identical products in a business -defined multipack.
338
361
# Corresponds to the JSON property `multipack`
339
362
# @return [Fixnum]
340
363
attr_accessor :multipack
341
364
342
- # The item's pattern (for example, polka dots).
365
+ # The item's [pattern](https://support.google.com/merchants/answer/6324483). For
366
+ # example, polka dots.
343
367
# Corresponds to the JSON property `pattern`
344
368
# @return [String]
345
369
attr_accessor :pattern
@@ -350,12 +374,14 @@ class Attributes
350
374
# @return [String]
351
375
attr_accessor :pause
352
376
353
- # The pick up option for the item.
377
+ # The [pickup](https://support.google.com/merchants/answer/14634021) option for
378
+ # the item.
354
379
# Corresponds to the JSON property `pickupMethod`
355
380
# @return [String]
356
381
attr_accessor :pickup_method
357
382
358
- # Item store pickup timeline.
383
+ # Item store pickup timeline. For more information, see [Pickup SLA](https://
384
+ # support.google.com/merchants/answer/14635400).
359
385
# Corresponds to the JSON property `pickupSla`
360
386
# @return [String]
361
387
attr_accessor :pickup_sla
@@ -375,7 +401,8 @@ class Attributes
375
401
# @return [Google::Apis::MerchantapiProductsV1beta::ProductDimension]
376
402
attr_accessor :product_height
377
403
378
- # Bullet points describing the most relevant highlights of a product.
404
+ # Bullet points describing the most relevant [product highlights](https://
405
+ # support.google.com/merchants/answer/9216100).
379
406
# Corresponds to the JSON property `productHighlights`
380
407
# @return [Array<String>]
381
408
attr_accessor :product_highlights
@@ -386,7 +413,7 @@ class Attributes
386
413
attr_accessor :product_length
387
414
388
415
# Categories of the item (formatted as in [product data specification](https://
389
- # support.google.com/merchants/answer/188494#product_type )).
416
+ # support.google.com/merchants/answer/7052112#product_category )).
390
417
# Corresponds to the JSON property `productTypes`
391
418
# @return [Array<String>]
392
419
attr_accessor :product_types
@@ -456,28 +483,32 @@ class Attributes
456
483
# @return [Google::Apis::MerchantapiProductsV1beta::ShippingDimension]
457
484
attr_accessor :shipping_width
458
485
459
- # List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping
460
- # Ads destination. Countries from this list are removed from countries
461
- # configured in data source settings.
486
+ # List of country codes [(ISO 3166-1 alpha-2)](https://en.wikipedia.org/wiki/
487
+ # ISO_3166-1_alpha-2) to exclude the offer from Shopping Ads destination.
488
+ # Countries from this list are removed from countries configured in data source
489
+ # settings.
462
490
# Corresponds to the JSON property `shoppingAdsExcludedCountries`
463
491
# @return [Array<String>]
464
492
attr_accessor :shopping_ads_excluded_countries
465
493
466
494
# Size of the item. Only one value is allowed. For variants with different sizes,
467
- # insert a separate product for each size with the same `itemGroupId` value (
468
- # see [https://support.google.com/merchants/answer/6324492](size definition) ).
495
+ # insert a separate product for each size with the same `itemGroupId` value,
496
+ # see [Size]( https://support.google.com/merchants/answer/6324492).
469
497
# Corresponds to the JSON property `size`
470
498
# @return [String]
471
499
attr_accessor :size
472
500
473
- # System in which the size is specified. Recommended for apparel items.
501
+ # System in which the size is specified. Recommended for apparel items. For
502
+ # example, "US", "UK", "DE". For more information, see [Size system](https://
503
+ # support.google.com/merchants/answer/6324502).
474
504
# Corresponds to the JSON property `sizeSystem`
475
505
# @return [String]
476
506
attr_accessor :size_system
477
507
478
508
# The cut of the item. It can be used to represent combined size types for
479
- # apparel items. Maximum two of size types can be provided (see [https://support.
480
- # google.com/merchants/answer/6324497](size type)).
509
+ # apparel items. Maximum two of size types can be provided, see [Size type](
510
+ # https://support.google.com/merchants/answer/6324497). For example, "petite", "
511
+ # plus size".
481
512
# Corresponds to the JSON property `sizeTypes`
482
513
# @return [Array<String>]
483
514
attr_accessor :size_types
@@ -502,7 +533,8 @@ class Attributes
502
533
# @return [Array<Google::Apis::MerchantapiProductsV1beta::ProductSustainabilityIncentive>]
503
534
attr_accessor :sustainability_incentives
504
535
505
- # The tax category of the product.
536
+ # The [tax category](https://support.google.com/merchants/answer/7569847) of the
537
+ # product.
506
538
# Corresponds to the JSON property `taxCategory`
507
539
# @return [String]
508
540
attr_accessor :tax_category
@@ -1005,7 +1037,7 @@ class ItemLevelIssue
1005
1037
# @return [String]
1006
1038
attr_accessor :reporting_context
1007
1039
1008
- # Whether the issue can be resolved by the merchant .
1040
+ # Whether the issue can be resolved by the business .
1009
1041
# Corresponds to the JSON property `resolution`
1010
1042
# @return [String]
1011
1043
attr_accessor :resolution
@@ -1121,10 +1153,10 @@ class LoyaltyProgram
1121
1153
attr_accessor :price
1122
1154
1123
1155
# The label of the loyalty program. This is an internal label that uniquely
1124
- # identifies the relationship between a merchant entity and a loyalty program
1156
+ # identifies the relationship between a business entity and a loyalty program
1125
1157
# entity. The label must be provided so that the system can associate the assets
1126
- # below (for example, price and points) with a merchant . The corresponding
1127
- # program must be linked to the merchant account.
1158
+ # below (for example, price and points) with a business . The corresponding
1159
+ # program must be linked to the Merchant Center account.
1128
1160
# Corresponds to the JSON property `programLabel`
1129
1161
# @return [String]
1130
1162
attr_accessor :program_label
@@ -1399,13 +1431,14 @@ def update!(**args)
1399
1431
# This resource represents input data you submit for a product, not the
1400
1432
# processed product that you see in Merchant Center, in Shopping ads, or across
1401
1433
# Google surfaces. Product inputs, rules and supplemental data source data are
1402
- # combined to create the processed Product. Required product input attributes to
1403
- # pass data validation checks are primarily defined in the [Products Data
1404
- # Specification](https://support.google.com/merchants/answer/188494). The
1405
- # following attributes are required: feedLabel, contentLanguage and offerId.
1406
- # After inserting, updating, or deleting a product input, it may take several
1407
- # minutes before the processed product can be retrieved. All fields in the
1408
- # product input and its sub-messages match the English name of their
1434
+ # combined to create the processed Product. For more information, see [Manage
1435
+ # products](/merchant/api/guides/products/overview). Required product input
1436
+ # attributes to pass data validation checks are primarily defined in the [
1437
+ # Products Data Specification](https://support.google.com/merchants/answer/
1438
+ # 188494). The following attributes are required: feedLabel, contentLanguage and
1439
+ # offerId. After inserting, updating, or deleting a product input, it may take
1440
+ # several minutes before the processed product can be retrieved. All fields in
1441
+ # the product input and its sub-messages match the English name of their
1409
1442
# corresponding attribute in the [Products Data Specification](https://support.
1410
1443
# google.com/merchants/answer/188494) with [some exceptions](https://support.
1411
1444
# google.com/merchants/answer/7052112). The following reference documentation
@@ -1443,8 +1476,11 @@ class ProductInput
1443
1476
# @return [Array<Google::Apis::MerchantapiProductsV1beta::CustomAttribute>]
1444
1477
attr_accessor :custom_attributes
1445
1478
1446
- # Required. Immutable. The [feed label](https://developers.google.com/shopping-
1447
- # content/guides/products/feed-labels) for the product.
1479
+ # Required. Immutable. The label that lets you categorize and identify your
1480
+ # products. The maximum allowed characters are 20, and the supported characters
1481
+ # are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any
1482
+ # spaces. For more information, see [Using feed labels](//support.google.com/
1483
+ # merchants/answer/14994087).
1448
1484
# Corresponds to the JSON property `feedLabel`
1449
1485
# @return [String]
1450
1486
attr_accessor :feed_label
0 commit comments