google-apis-content_v2_1 0.32.0 → 0.33.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1316,7 +1316,8 @@ module Google
1316
1316
  attr_accessor :payments_manager
1317
1317
  alias_method :payments_manager?, :payments_manager
1318
1318
 
1319
- # Whether user is a reporting manager.
1319
+ # Whether user is a reporting manager. This role is equivalent to the
1320
+ # Performance and insights role in Merchant Center.
1320
1321
  # Corresponds to the JSON property `reportingManager`
1321
1322
  # @return [Boolean]
1322
1323
  attr_accessor :reporting_manager
@@ -1530,7 +1531,8 @@ module Google
1530
1531
  attr_accessor :action
1531
1532
 
1532
1533
  # Type of the link between the two accounts. Acceptable values are: - "`
1533
- # channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`"
1534
+ # channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`" - "`
1535
+ # localProductManager`"
1534
1536
  # Corresponds to the JSON property `linkType`
1535
1537
  # @return [String]
1536
1538
  attr_accessor :link_type
@@ -1542,7 +1544,7 @@ module Google
1542
1544
 
1543
1545
  # Provided services. Acceptable values are: - "`shoppingAdsProductManagement`" -
1544
1546
  # "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`
1545
- # paymentProcessing`"
1547
+ # paymentProcessing`" - "`localProductManagement`"
1546
1548
  # Corresponds to the JSON property `services`
1547
1549
  # @return [Array<String>]
1548
1550
  attr_accessor :services
@@ -2129,6 +2131,16 @@ module Google
2129
2131
  # @return [Google::Apis::ContentV2_1::BuiltInSimpleAction]
2130
2132
  attr_accessor :builtin_simple_action
2131
2133
 
2134
+ # Action that is implemented and performed in (your) third-party application.
2135
+ # The application needs to show an additional content and input form to the
2136
+ # merchant. They can start the action only when they provided all required
2137
+ # inputs. The application will request processing of the action by calling the [
2138
+ # triggeraction method](https://developers.google.com/shopping-content/reference/
2139
+ # rest/v2.1/merchantsupport/triggeraction).
2140
+ # Corresponds to the JSON property `builtinUserInputAction`
2141
+ # @return [Google::Apis::ContentV2_1::BuiltInUserInputAction]
2142
+ attr_accessor :builtin_user_input_action
2143
+
2132
2144
  # Label of the action button.
2133
2145
  # Corresponds to the JSON property `buttonLabel`
2134
2146
  # @return [String]
@@ -2167,6 +2179,7 @@ module Google
2167
2179
  # Update properties of this object
2168
2180
  def update!(**args)
2169
2181
  @builtin_simple_action = args[:builtin_simple_action] if args.key?(:builtin_simple_action)
2182
+ @builtin_user_input_action = args[:builtin_user_input_action] if args.key?(:builtin_user_input_action)
2170
2183
  @button_label = args[:button_label] if args.key?(:button_label)
2171
2184
  @external_action = args[:external_action] if args.key?(:external_action)
2172
2185
  @is_available = args[:is_available] if args.key?(:is_available)
@@ -2174,6 +2187,90 @@ module Google
2174
2187
  end
2175
2188
  end
2176
2189
 
2190
+ # Flow that can be selected for an action. When merchant selects a flow,
2191
+ # application should open a dialog with more information and input form.
2192
+ class ActionFlow
2193
+ include Google::Apis::Core::Hashable
2194
+
2195
+ # Label for the button to trigger the action from the action dialog. For example:
2196
+ # "Request review"
2197
+ # Corresponds to the JSON property `dialogButtonLabel`
2198
+ # @return [String]
2199
+ attr_accessor :dialog_button_label
2200
+
2201
+ # An important message that should be highlighted. Usually displayed as a banner.
2202
+ # Corresponds to the JSON property `dialogCallout`
2203
+ # @return [Google::Apis::ContentV2_1::Callout]
2204
+ attr_accessor :dialog_callout
2205
+
2206
+ # Block of text that may contain a tooltip with more information.
2207
+ # Corresponds to the JSON property `dialogMessage`
2208
+ # @return [Google::Apis::ContentV2_1::TextWithTooltip]
2209
+ attr_accessor :dialog_message
2210
+
2211
+ # Title of the request dialog. For example: "Before you request a review"
2212
+ # Corresponds to the JSON property `dialogTitle`
2213
+ # @return [String]
2214
+ attr_accessor :dialog_title
2215
+
2216
+ # Not for display but need to be sent back for the selected action flow.
2217
+ # Corresponds to the JSON property `id`
2218
+ # @return [String]
2219
+ attr_accessor :id
2220
+
2221
+ # A list of input fields.
2222
+ # Corresponds to the JSON property `inputs`
2223
+ # @return [Array<Google::Apis::ContentV2_1::InputField>]
2224
+ attr_accessor :inputs
2225
+
2226
+ # Text value describing the intent for the action flow. It can be used as an
2227
+ # input label if merchant needs to pick one of multiple flows. For example: "I
2228
+ # disagree with the issue"
2229
+ # Corresponds to the JSON property `label`
2230
+ # @return [String]
2231
+ attr_accessor :label
2232
+
2233
+ def initialize(**args)
2234
+ update!(**args)
2235
+ end
2236
+
2237
+ # Update properties of this object
2238
+ def update!(**args)
2239
+ @dialog_button_label = args[:dialog_button_label] if args.key?(:dialog_button_label)
2240
+ @dialog_callout = args[:dialog_callout] if args.key?(:dialog_callout)
2241
+ @dialog_message = args[:dialog_message] if args.key?(:dialog_message)
2242
+ @dialog_title = args[:dialog_title] if args.key?(:dialog_title)
2243
+ @id = args[:id] if args.key?(:id)
2244
+ @inputs = args[:inputs] if args.key?(:inputs)
2245
+ @label = args[:label] if args.key?(:label)
2246
+ end
2247
+ end
2248
+
2249
+ # Input provided by the merchant.
2250
+ class ActionInput
2251
+ include Google::Apis::Core::Hashable
2252
+
2253
+ # Required. Id of the selected action flow.
2254
+ # Corresponds to the JSON property `actionFlowId`
2255
+ # @return [String]
2256
+ attr_accessor :action_flow_id
2257
+
2258
+ # Required. Values for input fields.
2259
+ # Corresponds to the JSON property `inputValues`
2260
+ # @return [Array<Google::Apis::ContentV2_1::InputValue>]
2261
+ attr_accessor :input_values
2262
+
2263
+ def initialize(**args)
2264
+ update!(**args)
2265
+ end
2266
+
2267
+ # Update properties of this object
2268
+ def update!(**args)
2269
+ @action_flow_id = args[:action_flow_id] if args.key?(:action_flow_id)
2270
+ @input_values = args[:input_values] if args.key?(:input_values)
2271
+ end
2272
+ end
2273
+
2177
2274
  # A single reason why the action is not available.
2178
2275
  class ActionReason
2179
2276
  include Google::Apis::Core::Hashable
@@ -2326,7 +2423,7 @@ module Google
2326
2423
  include Google::Apis::Core::Hashable
2327
2424
 
2328
2425
  # Required. Lookback windows (in days) used for attribution in this source.
2329
- # Supported values are 7, 30, 60, 90.
2426
+ # Supported values are 7, 30, 40.
2330
2427
  # Corresponds to the JSON property `attributionLookbackWindowInDays`
2331
2428
  # @return [Fixnum]
2332
2429
  attr_accessor :attribution_lookback_window_in_days
@@ -2609,6 +2706,40 @@ module Google
2609
2706
  end
2610
2707
  end
2611
2708
 
2709
+ # Action that is implemented and performed in (your) third-party application.
2710
+ # The application needs to show an additional content and input form to the
2711
+ # merchant. They can start the action only when they provided all required
2712
+ # inputs. The application will request processing of the action by calling the [
2713
+ # triggeraction method](https://developers.google.com/shopping-content/reference/
2714
+ # rest/v2.1/merchantsupport/triggeraction).
2715
+ class BuiltInUserInputAction
2716
+ include Google::Apis::Core::Hashable
2717
+
2718
+ # Internal details. Not for display but need to be sent back when triggering the
2719
+ # action.
2720
+ # Corresponds to the JSON property `actionContext`
2721
+ # @return [String]
2722
+ attr_accessor :action_context
2723
+
2724
+ # Actions may provide multiple different flows. Merchant selects one that fits
2725
+ # best to their intent. Selecting the flow is the first step in user's
2726
+ # interaction with the action. It affects what input fields will be available
2727
+ # and required and also how the request will be processed.
2728
+ # Corresponds to the JSON property `flows`
2729
+ # @return [Array<Google::Apis::ContentV2_1::ActionFlow>]
2730
+ attr_accessor :flows
2731
+
2732
+ def initialize(**args)
2733
+ update!(**args)
2734
+ end
2735
+
2736
+ # Update properties of this object
2737
+ def update!(**args)
2738
+ @action_context = args[:action_context] if args.key?(:action_context)
2739
+ @flows = args[:flows] if args.key?(:flows)
2740
+ end
2741
+ end
2742
+
2612
2743
  #
2613
2744
  class BusinessDayConfig
2614
2745
  include Google::Apis::Core::Hashable
@@ -2707,6 +2838,33 @@ module Google
2707
2838
  end
2708
2839
  end
2709
2840
 
2841
+ # An important message that should be highlighted. Usually displayed as a banner.
2842
+ class Callout
2843
+ include Google::Apis::Core::Hashable
2844
+
2845
+ # Block of text that may contain a tooltip with more information.
2846
+ # Corresponds to the JSON property `fullMessage`
2847
+ # @return [Google::Apis::ContentV2_1::TextWithTooltip]
2848
+ attr_accessor :full_message
2849
+
2850
+ # Can be used to render messages with different severity in different styles.
2851
+ # Snippets off all types contain important information that should be displayed
2852
+ # to merchants.
2853
+ # Corresponds to the JSON property `styleHint`
2854
+ # @return [String]
2855
+ attr_accessor :style_hint
2856
+
2857
+ def initialize(**args)
2858
+ update!(**args)
2859
+ end
2860
+
2861
+ # Update properties of this object
2862
+ def update!(**args)
2863
+ @full_message = args[:full_message] if args.key?(:full_message)
2864
+ @style_hint = args[:style_hint] if args.key?(:style_hint)
2865
+ end
2866
+ end
2867
+
2710
2868
  # Request message for the CaptureOrder method.
2711
2869
  class CaptureOrderRequest
2712
2870
  include Google::Apis::Core::Hashable
@@ -3984,9 +4142,10 @@ module Google
3984
4142
  # @return [String]
3985
4143
  attr_accessor :country
3986
4144
 
3987
- # The list of destinations to exclude for this target (corresponds to cleared
3988
- # check boxes in Merchant Center). Products that are excluded from all
3989
- # destinations for more than 7 days are automatically deleted.
4145
+ # The list of [destinations to exclude](//support.google.com/merchants/answer/
4146
+ # 6324486) for this target (corresponds to cleared check boxes in Merchant
4147
+ # Center). Products that are excluded from all destinations for more than 7 days
4148
+ # are automatically deleted.
3990
4149
  # Corresponds to the JSON property `excludedDestinations`
3991
4150
  # @return [Array<String>]
3992
4151
  attr_accessor :excluded_destinations
@@ -3999,9 +4158,10 @@ module Google
3999
4158
  # @return [String]
4000
4159
  attr_accessor :feed_label
4001
4160
 
4002
- # The list of destinations to include for this target (corresponds to checked
4003
- # check boxes in Merchant Center). Default destinations are always included
4004
- # unless provided in `excludedDestinations`.
4161
+ # The list of [destinations to include](//support.google.com/merchants/answer/
4162
+ # 7501026) for this target (corresponds to checked check boxes in Merchant
4163
+ # Center). Default destinations are always included unless provided in `
4164
+ # excludedDestinations`.
4005
4165
  # Corresponds to the JSON property `includedDestinations`
4006
4166
  # @return [Array<String>]
4007
4167
  attr_accessor :included_destinations
@@ -4922,6 +5082,33 @@ module Google
4922
5082
  end
4923
5083
  end
4924
5084
 
5085
+ # Conditions to be met for a product to have free shipping.
5086
+ class FreeShippingThreshold
5087
+ include Google::Apis::Core::Hashable
5088
+
5089
+ # Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/
5090
+ # latest/common/main/en.xml) of the country to which an item will ship.
5091
+ # Corresponds to the JSON property `country`
5092
+ # @return [String]
5093
+ attr_accessor :country
5094
+
5095
+ # Required. The minimum product price for the shipping cost to become free.
5096
+ # Represented as a number.
5097
+ # Corresponds to the JSON property `priceThreshold`
5098
+ # @return [Google::Apis::ContentV2_1::Price]
5099
+ attr_accessor :price_threshold
5100
+
5101
+ def initialize(**args)
5102
+ update!(**args)
5103
+ end
5104
+
5105
+ # Update properties of this object
5106
+ def update!(**args)
5107
+ @country = args[:country] if args.key?(:country)
5108
+ @price_threshold = args[:price_threshold] if args.key?(:price_threshold)
5109
+ end
5110
+ end
5111
+
4925
5112
  # Response containing generated recommendations.
4926
5113
  class GenerateRecommendationsResponse
4927
5114
  include Google::Apis::Core::Hashable
@@ -5212,19 +5399,272 @@ module Google
5212
5399
  end
5213
5400
  end
5214
5401
 
5215
- # Map of inapplicability details.
5216
- class InapplicabilityDetails
5402
+ # Input field that needs to be available to the merchant. If the field is marked
5403
+ # as required, then a value needs to be provided for a successful processing of
5404
+ # the request.
5405
+ class InputField
5406
+ include Google::Apis::Core::Hashable
5407
+
5408
+ # Checkbox input allows merchants to provide a boolean value. Corresponds to the
5409
+ # [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/
5410
+ # input.checkbox.html#input.checkbox). If merchant checks the box, the input
5411
+ # value for the field is `true`, otherwise it is `false`. This type of input is
5412
+ # often used as a confirmation that the merchant completed required steps before
5413
+ # they are allowed to start the action. In such a case, the input field is
5414
+ # marked as required and the button to trigger the action should stay disabled
5415
+ # until the merchant checks the box.
5416
+ # Corresponds to the JSON property `checkboxInput`
5417
+ # @return [Google::Apis::ContentV2_1::InputFieldCheckboxInput]
5418
+ attr_accessor :checkbox_input
5419
+
5420
+ # Choice input allows merchants to select one of the offered choices. Some
5421
+ # choices may be linked to additional input fields that should be displayed
5422
+ # under or next to the choice option. The value for the additional input field
5423
+ # needs to be provided only when the specific choice is selected by the merchant.
5424
+ # For example, additional input field can be hidden or disabled until the
5425
+ # merchant selects the specific choice.
5426
+ # Corresponds to the JSON property `choiceInput`
5427
+ # @return [Google::Apis::ContentV2_1::InputFieldChoiceInput]
5428
+ attr_accessor :choice_input
5429
+
5430
+ # Not for display but need to be sent back for the given input field.
5431
+ # Corresponds to the JSON property `id`
5432
+ # @return [String]
5433
+ attr_accessor :id
5434
+
5435
+ # Block of text that may contain a tooltip with more information.
5436
+ # Corresponds to the JSON property `label`
5437
+ # @return [Google::Apis::ContentV2_1::TextWithTooltip]
5438
+ attr_accessor :label
5439
+
5440
+ # Whether the field is required. The action button needs to stay disabled till
5441
+ # values for all required fields are provided.
5442
+ # Corresponds to the JSON property `required`
5443
+ # @return [Boolean]
5444
+ attr_accessor :required
5445
+ alias_method :required?, :required
5446
+
5447
+ # Text input allows merchants to provide a text value.
5448
+ # Corresponds to the JSON property `textInput`
5449
+ # @return [Google::Apis::ContentV2_1::InputFieldTextInput]
5450
+ attr_accessor :text_input
5451
+
5452
+ def initialize(**args)
5453
+ update!(**args)
5454
+ end
5455
+
5456
+ # Update properties of this object
5457
+ def update!(**args)
5458
+ @checkbox_input = args[:checkbox_input] if args.key?(:checkbox_input)
5459
+ @choice_input = args[:choice_input] if args.key?(:choice_input)
5460
+ @id = args[:id] if args.key?(:id)
5461
+ @label = args[:label] if args.key?(:label)
5462
+ @required = args[:required] if args.key?(:required)
5463
+ @text_input = args[:text_input] if args.key?(:text_input)
5464
+ end
5465
+ end
5466
+
5467
+ # Checkbox input allows merchants to provide a boolean value. Corresponds to the
5468
+ # [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/
5469
+ # input.checkbox.html#input.checkbox). If merchant checks the box, the input
5470
+ # value for the field is `true`, otherwise it is `false`. This type of input is
5471
+ # often used as a confirmation that the merchant completed required steps before
5472
+ # they are allowed to start the action. In such a case, the input field is
5473
+ # marked as required and the button to trigger the action should stay disabled
5474
+ # until the merchant checks the box.
5475
+ class InputFieldCheckboxInput
5217
5476
  include Google::Apis::Core::Hashable
5218
5477
 
5219
- # Count of this inapplicable reason code.
5220
- # Corresponds to the JSON property `inapplicableCount`
5221
- # @return [Fixnum]
5222
- attr_accessor :inapplicable_count
5478
+ def initialize(**args)
5479
+ update!(**args)
5480
+ end
5481
+
5482
+ # Update properties of this object
5483
+ def update!(**args)
5484
+ end
5485
+ end
5486
+
5487
+ # Choice input allows merchants to select one of the offered choices. Some
5488
+ # choices may be linked to additional input fields that should be displayed
5489
+ # under or next to the choice option. The value for the additional input field
5490
+ # needs to be provided only when the specific choice is selected by the merchant.
5491
+ # For example, additional input field can be hidden or disabled until the
5492
+ # merchant selects the specific choice.
5493
+ class InputFieldChoiceInput
5494
+ include Google::Apis::Core::Hashable
5495
+
5496
+ # A list of choices. Only one option can be selected.
5497
+ # Corresponds to the JSON property `options`
5498
+ # @return [Array<Google::Apis::ContentV2_1::InputFieldChoiceInputChoiceInputOption>]
5499
+ attr_accessor :options
5500
+
5501
+ def initialize(**args)
5502
+ update!(**args)
5503
+ end
5504
+
5505
+ # Update properties of this object
5506
+ def update!(**args)
5507
+ @options = args[:options] if args.key?(:options)
5508
+ end
5509
+ end
5510
+
5511
+ # A choice that merchant can select.
5512
+ class InputFieldChoiceInputChoiceInputOption
5513
+ include Google::Apis::Core::Hashable
5514
+
5515
+ # Input field that needs to be available to the merchant. If the field is marked
5516
+ # as required, then a value needs to be provided for a successful processing of
5517
+ # the request.
5518
+ # Corresponds to the JSON property `additionalInput`
5519
+ # @return [Google::Apis::ContentV2_1::InputField]
5520
+ attr_accessor :additional_input
5521
+
5522
+ # Not for display but need to be sent back for the selected choice option.
5523
+ # Corresponds to the JSON property `id`
5524
+ # @return [String]
5525
+ attr_accessor :id
5526
+
5527
+ # Block of text that may contain a tooltip with more information.
5528
+ # Corresponds to the JSON property `label`
5529
+ # @return [Google::Apis::ContentV2_1::TextWithTooltip]
5530
+ attr_accessor :label
5531
+
5532
+ def initialize(**args)
5533
+ update!(**args)
5534
+ end
5535
+
5536
+ # Update properties of this object
5537
+ def update!(**args)
5538
+ @additional_input = args[:additional_input] if args.key?(:additional_input)
5539
+ @id = args[:id] if args.key?(:id)
5540
+ @label = args[:label] if args.key?(:label)
5541
+ end
5542
+ end
5543
+
5544
+ # Text input allows merchants to provide a text value.
5545
+ class InputFieldTextInput
5546
+ include Google::Apis::Core::Hashable
5547
+
5548
+ # Block of text that may contain a tooltip with more information.
5549
+ # Corresponds to the JSON property `additionalInfo`
5550
+ # @return [Google::Apis::ContentV2_1::TextWithTooltip]
5551
+ attr_accessor :additional_info
5552
+
5553
+ # Text to be used as the [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.
5554
+ # html) for the input.
5555
+ # Corresponds to the JSON property `ariaLabel`
5556
+ # @return [String]
5557
+ attr_accessor :aria_label
5558
+
5559
+ # Information about the required format. If present, it should be shown close to
5560
+ # the input field to help merchants to provide a correct value. For example: "
5561
+ # VAT numbers should be in a format similar to SK9999999999"
5562
+ # Corresponds to the JSON property `formatInfo`
5563
+ # @return [String]
5564
+ attr_accessor :format_info
5565
+
5566
+ # Type of the text input
5567
+ # Corresponds to the JSON property `type`
5568
+ # @return [String]
5569
+ attr_accessor :type
5570
+
5571
+ def initialize(**args)
5572
+ update!(**args)
5573
+ end
5574
+
5575
+ # Update properties of this object
5576
+ def update!(**args)
5577
+ @additional_info = args[:additional_info] if args.key?(:additional_info)
5578
+ @aria_label = args[:aria_label] if args.key?(:aria_label)
5579
+ @format_info = args[:format_info] if args.key?(:format_info)
5580
+ @type = args[:type] if args.key?(:type)
5581
+ end
5582
+ end
5583
+
5584
+ # Input provided by the merchant for input field.
5585
+ class InputValue
5586
+ include Google::Apis::Core::Hashable
5587
+
5588
+ # Value for checkbox input field.
5589
+ # Corresponds to the JSON property `checkboxInputValue`
5590
+ # @return [Google::Apis::ContentV2_1::InputValueCheckboxInputValue]
5591
+ attr_accessor :checkbox_input_value
5592
+
5593
+ # Value for choice input field.
5594
+ # Corresponds to the JSON property `choiceInputValue`
5595
+ # @return [Google::Apis::ContentV2_1::InputValueChoiceInputValue]
5596
+ attr_accessor :choice_input_value
5597
+
5598
+ # Required. Id of the corresponding input field.
5599
+ # Corresponds to the JSON property `inputFieldId`
5600
+ # @return [String]
5601
+ attr_accessor :input_field_id
5602
+
5603
+ # Value for text input field.
5604
+ # Corresponds to the JSON property `textInputValue`
5605
+ # @return [Google::Apis::ContentV2_1::InputValueTextInputValue]
5606
+ attr_accessor :text_input_value
5607
+
5608
+ def initialize(**args)
5609
+ update!(**args)
5610
+ end
5611
+
5612
+ # Update properties of this object
5613
+ def update!(**args)
5614
+ @checkbox_input_value = args[:checkbox_input_value] if args.key?(:checkbox_input_value)
5615
+ @choice_input_value = args[:choice_input_value] if args.key?(:choice_input_value)
5616
+ @input_field_id = args[:input_field_id] if args.key?(:input_field_id)
5617
+ @text_input_value = args[:text_input_value] if args.key?(:text_input_value)
5618
+ end
5619
+ end
5620
+
5621
+ # Value for checkbox input field.
5622
+ class InputValueCheckboxInputValue
5623
+ include Google::Apis::Core::Hashable
5624
+
5625
+ # Required. True if the merchant checked the box field. False otherwise.
5626
+ # Corresponds to the JSON property `value`
5627
+ # @return [Boolean]
5628
+ attr_accessor :value
5629
+ alias_method :value?, :value
5630
+
5631
+ def initialize(**args)
5632
+ update!(**args)
5633
+ end
5634
+
5635
+ # Update properties of this object
5636
+ def update!(**args)
5637
+ @value = args[:value] if args.key?(:value)
5638
+ end
5639
+ end
5640
+
5641
+ # Value for choice input field.
5642
+ class InputValueChoiceInputValue
5643
+ include Google::Apis::Core::Hashable
5644
+
5645
+ # Required. Id of the option that was selected by the merchant.
5646
+ # Corresponds to the JSON property `choiceInputOptionId`
5647
+ # @return [String]
5648
+ attr_accessor :choice_input_option_id
5649
+
5650
+ def initialize(**args)
5651
+ update!(**args)
5652
+ end
5653
+
5654
+ # Update properties of this object
5655
+ def update!(**args)
5656
+ @choice_input_option_id = args[:choice_input_option_id] if args.key?(:choice_input_option_id)
5657
+ end
5658
+ end
5659
+
5660
+ # Value for text input field.
5661
+ class InputValueTextInputValue
5662
+ include Google::Apis::Core::Hashable
5223
5663
 
5224
- # Reason code this rule was not applicable.
5225
- # Corresponds to the JSON property `inapplicableReason`
5664
+ # Required. Text provided by the merchant.
5665
+ # Corresponds to the JSON property `value`
5226
5666
  # @return [String]
5227
- attr_accessor :inapplicable_reason
5667
+ attr_accessor :value
5228
5668
 
5229
5669
  def initialize(**args)
5230
5670
  update!(**args)
@@ -5232,8 +5672,7 @@ module Google
5232
5672
 
5233
5673
  # Update properties of this object
5234
5674
  def update!(**args)
5235
- @inapplicable_count = args[:inapplicable_count] if args.key?(:inapplicable_count)
5236
- @inapplicable_reason = args[:inapplicable_reason] if args.key?(:inapplicable_reason)
5675
+ @value = args[:value] if args.key?(:value)
5237
5676
  end
5238
5677
  end
5239
5678
 
@@ -5260,7 +5699,8 @@ module Google
5260
5699
  end
5261
5700
  end
5262
5701
 
5263
- #
5702
+ # Details of a monthly installment payment offering. [Learn more](https://
5703
+ # support.google.com/merchants/answer/6324474) about installments.
5264
5704
  class Installment
5265
5705
  include Google::Apis::Core::Hashable
5266
5706
 
@@ -5269,6 +5709,17 @@ module Google
5269
5709
  # @return [Google::Apis::ContentV2_1::Price]
5270
5710
  attr_accessor :amount
5271
5711
 
5712
+ # Optional. Type of installment payments. Supported values are: - "`finance`" - "
5713
+ # `lease`"
5714
+ # Corresponds to the JSON property `creditType`
5715
+ # @return [String]
5716
+ attr_accessor :credit_type
5717
+
5718
+ # Optional. The initial down payment amount the buyer has to pay.
5719
+ # Corresponds to the JSON property `downpayment`
5720
+ # @return [Google::Apis::ContentV2_1::Price]
5721
+ attr_accessor :downpayment
5722
+
5272
5723
  # The number of installments the buyer has to pay.
5273
5724
  # Corresponds to the JSON property `months`
5274
5725
  # @return [Fixnum]
@@ -5281,6 +5732,8 @@ module Google
5281
5732
  # Update properties of this object
5282
5733
  def update!(**args)
5283
5734
  @amount = args[:amount] if args.key?(:amount)
5735
+ @credit_type = args[:credit_type] if args.key?(:credit_type)
5736
+ @downpayment = args[:downpayment] if args.key?(:downpayment)
5284
5737
  @months = args[:months] if args.key?(:months)
5285
5738
  end
5286
5739
  end
@@ -5359,7 +5812,7 @@ module Google
5359
5812
  class LiaAboutPageSettings
5360
5813
  include Google::Apis::Core::Hashable
5361
5814
 
5362
- # The status of the verification process for the About page. Acceptable values
5815
+ # The status of the verification process for the About page. Supported values
5363
5816
  # are: - "`active`" - "`inactive`" - "`pending`"
5364
5817
  # Corresponds to the JSON property `status`
5365
5818
  # @return [String]
@@ -6245,20 +6698,14 @@ module Google
6245
6698
  end
6246
6699
  end
6247
6700
 
6248
- # Response message for the ListRepricingProductReports method.
6249
- class ListRepricingProductReportsResponse
6701
+ # Response message for the `ListReturnPolicyOnline` method.
6702
+ class ListReturnPolicyOnlineResponse
6250
6703
  include Google::Apis::Core::Hashable
6251
6704
 
6252
- # A token for retrieving the next page. Its absence means there is no subsequent
6253
- # page.
6254
- # Corresponds to the JSON property `nextPageToken`
6255
- # @return [String]
6256
- attr_accessor :next_page_token
6257
-
6258
- # Periodic reports for the given Repricing product.
6259
- # Corresponds to the JSON property `repricingProductReports`
6260
- # @return [Array<Google::Apis::ContentV2_1::RepricingProductReport>]
6261
- attr_accessor :repricing_product_reports
6705
+ # The retrieved return policies.
6706
+ # Corresponds to the JSON property `returnPolicies`
6707
+ # @return [Array<Google::Apis::ContentV2_1::ReturnPolicyOnline>]
6708
+ attr_accessor :return_policies
6262
6709
 
6263
6710
  def initialize(**args)
6264
6711
  update!(**args)
@@ -6266,92 +6713,20 @@ module Google
6266
6713
 
6267
6714
  # Update properties of this object
6268
6715
  def update!(**args)
6269
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6270
- @repricing_product_reports = args[:repricing_product_reports] if args.key?(:repricing_product_reports)
6716
+ @return_policies = args[:return_policies] if args.key?(:return_policies)
6271
6717
  end
6272
6718
  end
6273
6719
 
6274
- # Response message for the ListRepricingRuleReports method.
6275
- class ListRepricingRuleReportsResponse
6720
+ # Local inventory resource. For accepted attribute values, see the local product
6721
+ # inventory feed specification.
6722
+ class LocalInventory
6276
6723
  include Google::Apis::Core::Hashable
6277
6724
 
6278
- # A token for retrieving the next page. Its absence means there is no subsequent
6279
- # page.
6280
- # Corresponds to the JSON property `nextPageToken`
6725
+ # The availability of the product. For accepted attribute values, see the local
6726
+ # product inventory feed specification.
6727
+ # Corresponds to the JSON property `availability`
6281
6728
  # @return [String]
6282
- attr_accessor :next_page_token
6283
-
6284
- # Daily reports for the given Repricing rule.
6285
- # Corresponds to the JSON property `repricingRuleReports`
6286
- # @return [Array<Google::Apis::ContentV2_1::RepricingRuleReport>]
6287
- attr_accessor :repricing_rule_reports
6288
-
6289
- def initialize(**args)
6290
- update!(**args)
6291
- end
6292
-
6293
- # Update properties of this object
6294
- def update!(**args)
6295
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6296
- @repricing_rule_reports = args[:repricing_rule_reports] if args.key?(:repricing_rule_reports)
6297
- end
6298
- end
6299
-
6300
- # Response message for the `ListRepricingRules` method.
6301
- class ListRepricingRulesResponse
6302
- include Google::Apis::Core::Hashable
6303
-
6304
- # A token, which can be sent as `page_token` to retrieve the next page. If this
6305
- # field is omitted, there are no subsequent pages.
6306
- # Corresponds to the JSON property `nextPageToken`
6307
- # @return [String]
6308
- attr_accessor :next_page_token
6309
-
6310
- # The rules from the specified merchant.
6311
- # Corresponds to the JSON property `repricingRules`
6312
- # @return [Array<Google::Apis::ContentV2_1::RepricingRule>]
6313
- attr_accessor :repricing_rules
6314
-
6315
- def initialize(**args)
6316
- update!(**args)
6317
- end
6318
-
6319
- # Update properties of this object
6320
- def update!(**args)
6321
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6322
- @repricing_rules = args[:repricing_rules] if args.key?(:repricing_rules)
6323
- end
6324
- end
6325
-
6326
- # Response message for the `ListReturnPolicyOnline` method.
6327
- class ListReturnPolicyOnlineResponse
6328
- include Google::Apis::Core::Hashable
6329
-
6330
- # The retrieved return policies.
6331
- # Corresponds to the JSON property `returnPolicies`
6332
- # @return [Array<Google::Apis::ContentV2_1::ReturnPolicyOnline>]
6333
- attr_accessor :return_policies
6334
-
6335
- def initialize(**args)
6336
- update!(**args)
6337
- end
6338
-
6339
- # Update properties of this object
6340
- def update!(**args)
6341
- @return_policies = args[:return_policies] if args.key?(:return_policies)
6342
- end
6343
- end
6344
-
6345
- # Local inventory resource. For accepted attribute values, see the local product
6346
- # inventory feed specification.
6347
- class LocalInventory
6348
- include Google::Apis::Core::Hashable
6349
-
6350
- # The availability of the product. For accepted attribute values, see the local
6351
- # product inventory feed specification.
6352
- # Corresponds to the JSON property `availability`
6353
- # @return [String]
6354
- attr_accessor :availability
6729
+ attr_accessor :availability
6355
6730
 
6356
6731
  # A list of custom (merchant-provided) attributes. Can also be used to submit
6357
6732
  # any attribute of the feed specification in its generic form, for example, `` "
@@ -6573,26 +6948,48 @@ module Google
6573
6948
  end
6574
6949
  end
6575
6950
 
6576
- #
6577
- class LoyaltyPoints
6951
+ # Allows the setting up of loyalty program benefits (for example price or points)
6952
+ # . https://support.google.com/merchants/answer/12922446
6953
+ class LoyaltyProgram
6578
6954
  include Google::Apis::Core::Hashable
6579
6955
 
6580
- # Name of loyalty points program. It is recommended to limit the name to 12 full-
6581
- # width characters or 24 Roman characters.
6582
- # Corresponds to the JSON property `name`
6583
- # @return [String]
6584
- attr_accessor :name
6956
+ # Optional. The cashback that can be used for future purchases.
6957
+ # Corresponds to the JSON property `cashbackForFutureUse`
6958
+ # @return [Google::Apis::ContentV2_1::Price]
6959
+ attr_accessor :cashback_for_future_use
6585
6960
 
6586
- # The retailer's loyalty points in absolute value.
6587
- # Corresponds to the JSON property `pointsValue`
6961
+ # Optional. The amount of loyalty points earned on a purchase.
6962
+ # Corresponds to the JSON property `loyaltyPoints`
6588
6963
  # @return [Fixnum]
6589
- attr_accessor :points_value
6964
+ attr_accessor :loyalty_points
6590
6965
 
6591
- # The ratio of a point when converted to currency. Google assumes currency based
6592
- # on Merchant Center settings. If ratio is left out, it defaults to 1.0.
6593
- # Corresponds to the JSON property `ratio`
6594
- # @return [Float]
6595
- attr_accessor :ratio
6966
+ # Optional. A date range during which the item is eligible for member price. If
6967
+ # not specified, the member price is always applicable. The date range is
6968
+ # represented by a pair of ISO 8601 dates separated by a space, comma, or slash.
6969
+ # Corresponds to the JSON property `memberPriceEffectiveDate`
6970
+ # @return [String]
6971
+ attr_accessor :member_price_effective_date
6972
+
6973
+ # Optional. The price for members of the given tier (instant discount price).
6974
+ # Must be smaller or equal to the regular price.
6975
+ # Corresponds to the JSON property `price`
6976
+ # @return [Google::Apis::ContentV2_1::Price]
6977
+ attr_accessor :price
6978
+
6979
+ # Required. The label of the loyalty program. This is an internal label that
6980
+ # uniquely identifies the relationship between a merchant entity and a loyalty
6981
+ # program entity. It must be provided so that system can associate the assets
6982
+ # below (for example, price and points) with a merchant. The corresponding
6983
+ # program must be linked to the merchant account.
6984
+ # Corresponds to the JSON property `programLabel`
6985
+ # @return [String]
6986
+ attr_accessor :program_label
6987
+
6988
+ # Required. The label of the tier within the loyalty program. Must match one of
6989
+ # the labels within the program.
6990
+ # Corresponds to the JSON property `tierLabel`
6991
+ # @return [String]
6992
+ attr_accessor :tier_label
6596
6993
 
6597
6994
  def initialize(**args)
6598
6995
  update!(**args)
@@ -6600,9 +6997,12 @@ module Google
6600
6997
 
6601
6998
  # Update properties of this object
6602
6999
  def update!(**args)
6603
- @name = args[:name] if args.key?(:name)
6604
- @points_value = args[:points_value] if args.key?(:points_value)
6605
- @ratio = args[:ratio] if args.key?(:ratio)
7000
+ @cashback_for_future_use = args[:cashback_for_future_use] if args.key?(:cashback_for_future_use)
7001
+ @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points)
7002
+ @member_price_effective_date = args[:member_price_effective_date] if args.key?(:member_price_effective_date)
7003
+ @price = args[:price] if args.key?(:price)
7004
+ @program_label = args[:program_label] if args.key?(:program_label)
7005
+ @tier_label = args[:tier_label] if args.key?(:tier_label)
6606
7006
  end
6607
7007
  end
6608
7008
 
@@ -6818,21 +7218,25 @@ module Google
6818
7218
  class MethodQuota
6819
7219
  include Google::Apis::Core::Hashable
6820
7220
 
6821
- # The method name, for example `products.list`. Method name does not contain
6822
- # version because quota can be shared between different API versions of the same
6823
- # method.
7221
+ # Output only. The method name, for example `products.list`. Method name does
7222
+ # not contain version because quota can be shared between different API versions
7223
+ # of the same method.
6824
7224
  # Corresponds to the JSON property `method`
6825
7225
  # @return [String]
6826
7226
  attr_accessor :method_prop
6827
7227
 
6828
- # The current quota limit per day, meaning the maximum number of calls for the
6829
- # method.
7228
+ # Output only. The maximum number of calls allowed per day for the method.
6830
7229
  # Corresponds to the JSON property `quotaLimit`
6831
7230
  # @return [Fixnum]
6832
7231
  attr_accessor :quota_limit
6833
7232
 
6834
- # The current quota usage, meaning the number of calls already made to the
6835
- # method.
7233
+ # Output only. The maximum number of calls allowed per minute for the method.
7234
+ # Corresponds to the JSON property `quotaMinuteLimit`
7235
+ # @return [Fixnum]
7236
+ attr_accessor :quota_minute_limit
7237
+
7238
+ # Output only. The current quota usage, meaning the number of calls already made
7239
+ # to the method per day. Usage is reset every day at 12 PM midday UTC.
6836
7240
  # Corresponds to the JSON property `quotaUsage`
6837
7241
  # @return [Fixnum]
6838
7242
  attr_accessor :quota_usage
@@ -6845,6 +7249,7 @@ module Google
6845
7249
  def update!(**args)
6846
7250
  @method_prop = args[:method_prop] if args.key?(:method_prop)
6847
7251
  @quota_limit = args[:quota_limit] if args.key?(:quota_limit)
7252
+ @quota_minute_limit = args[:quota_minute_limit] if args.key?(:quota_minute_limit)
6848
7253
  @quota_usage = args[:quota_usage] if args.key?(:quota_usage)
6849
7254
  end
6850
7255
  end
@@ -6854,19 +7259,23 @@ module Google
6854
7259
  class Metrics
6855
7260
  include Google::Apis::Core::Hashable
6856
7261
 
6857
- # Average order size - the average number of items in an order. **This metric
6858
- # cannot be segmented by product dimensions and customer_country_code.**
7262
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7263
+ # starting from May 2024. Average order size - the average number of items in an
7264
+ # order. **This metric cannot be segmented by product dimensions and
7265
+ # customer_country_code.**
6859
7266
  # Corresponds to the JSON property `aos`
6860
7267
  # @return [Float]
6861
7268
  attr_accessor :aos
6862
7269
 
6863
- # Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000
6864
- # micros) - the average value (total price of items) of all placed orders. The
6865
- # currency of the returned value is stored in the currency_code segment. If this
6866
- # metric is selected, 'segments.currency_code' is automatically added to the
6867
- # SELECT clause in the search query (unless it is explicitly selected by the
6868
- # user) and the currency_code segment is populated in the response. **This
6869
- # metric cannot be segmented by product dimensions and customer_country_code.**
7270
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7271
+ # starting from May 2024. Average order value in micros (1 millionth of a
7272
+ # standard unit, 1 USD = 1000000 micros) - the average value (total price of
7273
+ # items) of all placed orders. The currency of the returned value is stored in
7274
+ # the currency_code segment. If this metric is selected, 'segments.currency_code'
7275
+ # is automatically added to the SELECT clause in the search query (unless it is
7276
+ # explicitly selected by the user) and the currency_code segment is populated in
7277
+ # the response. **This metric cannot be segmented by product dimensions and
7278
+ # customer_country_code.**
6870
7279
  # Corresponds to the JSON property `aovMicros`
6871
7280
  # @return [Float]
6872
7281
  attr_accessor :aov_micros
@@ -6877,15 +7286,15 @@ module Google
6877
7286
  attr_accessor :clicks
6878
7287
 
6879
7288
  # Number of conversions divided by the number of clicks, reported on the
6880
- # impression date. The metric is currently available only for the
6881
- # FREE_PRODUCT_LISTING program.
7289
+ # impression date. The metric is currently available only for the `
7290
+ # FREE_PRODUCT_LISTING` program.
6882
7291
  # Corresponds to the JSON property `conversionRate`
6883
7292
  # @return [Float]
6884
7293
  attr_accessor :conversion_rate
6885
7294
 
6886
7295
  # Value of conversions in micros (1 millionth of a standard unit, 1 USD =
6887
7296
  # 1000000 micros) attributed to the product, reported on the conversion date.
6888
- # The metric is currently available only for the FREE_PRODUCT_LISTING program.
7297
+ # The metric is currently available only for the `FREE_PRODUCT_LISTING` program.
6889
7298
  # The currency of the returned value is stored in the currency_code segment. If
6890
7299
  # this metric is selected, 'segments.currency_code' is automatically added to
6891
7300
  # the SELECT clause in the search query (unless it is explicitly selected by the
@@ -6898,7 +7307,7 @@ module Google
6898
7307
  # date. Depending on the attribution model, a conversion might be distributed
6899
7308
  # across multiple clicks, where each click gets its own credit assigned. This
6900
7309
  # metric is a sum of all such credits. The metric is currently available only
6901
- # for the FREE_PRODUCT_LISTING program.
7310
+ # for the `FREE_PRODUCT_LISTING` program.
6902
7311
  # Corresponds to the JSON property `conversions`
6903
7312
  # @return [Float]
6904
7313
  attr_accessor :conversions
@@ -6909,9 +7318,10 @@ module Google
6909
7318
  # @return [Float]
6910
7319
  attr_accessor :ctr
6911
7320
 
6912
- # Average number of days between an order being placed and the order being fully
6913
- # shipped, reported on the last shipment date. **This metric cannot be segmented
6914
- # by product dimensions and customer_country_code.**
7321
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7322
+ # starting from May 2024. Average number of days between an order being placed
7323
+ # and the order being fully shipped, reported on the last shipment date. **This
7324
+ # metric cannot be segmented by product dimensions and customer_country_code.**
6915
7325
  # Corresponds to the JSON property `daysToShip`
6916
7326
  # @return [Float]
6917
7327
  attr_accessor :days_to_ship
@@ -6921,116 +7331,136 @@ module Google
6921
7331
  # @return [Fixnum]
6922
7332
  attr_accessor :impressions
6923
7333
 
6924
- # Average number of days between an item being ordered and the item being **This
6925
- # metric cannot be segmented by customer_country_code.**
7334
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7335
+ # starting from May 2024. Average number of days between an item being ordered
7336
+ # and the item being **This metric cannot be segmented by customer_country_code.*
7337
+ # *
6926
7338
  # Corresponds to the JSON property `itemDaysToShip`
6927
7339
  # @return [Float]
6928
7340
  attr_accessor :item_days_to_ship
6929
7341
 
6930
- # Percentage of shipped items in relation to all finalized items (shipped or
6931
- # rejected by the merchant; unshipped items are not taken into account),
6932
- # reported on the order date. Item fill rate is lowered by merchant rejections. *
6933
- # *This metric cannot be segmented by customer_country_code.**
7342
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7343
+ # starting from May 2024. Percentage of shipped items in relation to all
7344
+ # finalized items (shipped or rejected by the merchant; unshipped items are not
7345
+ # taken into account), reported on the order date. Item fill rate is lowered by
7346
+ # merchant rejections. **This metric cannot be segmented by
7347
+ # customer_country_code.**
6934
7348
  # Corresponds to the JSON property `itemFillRate`
6935
7349
  # @return [Float]
6936
7350
  attr_accessor :item_fill_rate
6937
7351
 
6938
- # Total price of ordered items in micros (1 millionth of a standard unit, 1 USD =
6939
- # 1000000 micros). Excludes shipping, taxes (US only), and customer
6940
- # cancellations that happened within 30 minutes of placing the order. The
6941
- # currency of the returned value is stored in the currency_code segment. If this
6942
- # metric is selected, 'segments.currency_code' is automatically added to the
6943
- # SELECT clause in the search query (unless it is explicitly selected by the
6944
- # user) and the currency_code segment is populated in the response. **This
6945
- # metric cannot be segmented by customer_country_code.**
7352
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7353
+ # starting from May 2024. Total price of ordered items in micros (1 millionth of
7354
+ # a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only),
7355
+ # and customer cancellations that happened within 30 minutes of placing the
7356
+ # order. The currency of the returned value is stored in the currency_code
7357
+ # segment. If this metric is selected, 'segments.currency_code' is automatically
7358
+ # added to the SELECT clause in the search query (unless it is explicitly
7359
+ # selected by the user) and the currency_code segment is populated in the
7360
+ # response. **This metric cannot be segmented by customer_country_code.**
6946
7361
  # Corresponds to the JSON property `orderedItemSalesMicros`
6947
7362
  # @return [Fixnum]
6948
7363
  attr_accessor :ordered_item_sales_micros
6949
7364
 
6950
- # Number of ordered items. Excludes customer cancellations that happened within
6951
- # 30 minutes of placing the order. **This metric cannot be segmented by
6952
- # customer_country_code.**
7365
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7366
+ # starting from May 2024. Number of ordered items. Excludes customer
7367
+ # cancellations that happened within 30 minutes of placing the order. **This
7368
+ # metric cannot be segmented by customer_country_code.**
6953
7369
  # Corresponds to the JSON property `orderedItems`
6954
7370
  # @return [Fixnum]
6955
7371
  attr_accessor :ordered_items
6956
7372
 
6957
- # Number of placed orders. Excludes customer cancellations that happened within
6958
- # 30 minutes of placing the order. **This metric cannot be segmented by product
6959
- # dimensions and customer_country_code.**
7373
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7374
+ # starting from May 2024. Number of placed orders. Excludes customer
7375
+ # cancellations that happened within 30 minutes of placing the order. **This
7376
+ # metric cannot be segmented by product dimensions and customer_country_code.**
6960
7377
  # Corresponds to the JSON property `orders`
6961
7378
  # @return [Fixnum]
6962
7379
  attr_accessor :orders
6963
7380
 
6964
- # Number of ordered items canceled by the merchant, reported on the order date. *
6965
- # *This metric cannot be segmented by customer_country_code.**
7381
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7382
+ # starting from May 2024. Number of ordered items canceled by the merchant,
7383
+ # reported on the order date. **This metric cannot be segmented by
7384
+ # customer_country_code.**
6966
7385
  # Corresponds to the JSON property `rejectedItems`
6967
7386
  # @return [Fixnum]
6968
7387
  attr_accessor :rejected_items
6969
7388
 
6970
- # Total price of returned items divided by the total price of shipped items,
6971
- # reported on the order date. If this metric is selected, 'segments.
6972
- # currency_code' is automatically added to the SELECT clause in the search query
6973
- # (unless it is explicitly selected by the user) and the currency_code segment
6974
- # is populated in the response. **This metric cannot be segmented by
6975
- # customer_country_code.**
7389
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7390
+ # starting from May 2024. Total price of returned items divided by the total
7391
+ # price of shipped items, reported on the order date. If this metric is selected,
7392
+ # 'segments.currency_code' is automatically added to the SELECT clause in the
7393
+ # search query (unless it is explicitly selected by the user) and the
7394
+ # currency_code segment is populated in the response. **This metric cannot be
7395
+ # segmented by customer_country_code.**
6976
7396
  # Corresponds to the JSON property `returnRate`
6977
7397
  # @return [Float]
6978
7398
  attr_accessor :return_rate
6979
7399
 
6980
- # Number of ordered items sent back for return, reported on the date when the
6981
- # merchant accepted the return. **This metric cannot be segmented by
6982
- # customer_country_code.**
7400
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7401
+ # starting from May 2024. Number of ordered items sent back for return, reported
7402
+ # on the date when the merchant accepted the return. **This metric cannot be
7403
+ # segmented by customer_country_code.**
6983
7404
  # Corresponds to the JSON property `returnedItems`
6984
7405
  # @return [Fixnum]
6985
7406
  attr_accessor :returned_items
6986
7407
 
6987
- # Total price of ordered items sent back for return in micros (1 millionth of a
6988
- # standard unit, 1 USD = 1000000 micros), reported on the date when the merchant
6989
- # accepted the return. The currency of the returned value is stored in the
6990
- # currency_code segment. If this metric is selected, 'segments.currency_code' is
6991
- # automatically added to the SELECT clause in the search query (unless it is
6992
- # explicitly selected by the user) and the currency_code segment is populated in
6993
- # the response. **This metric cannot be segmented by customer_country_code.**
7408
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7409
+ # starting from May 2024. Total price of ordered items sent back for return in
7410
+ # micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on
7411
+ # the date when the merchant accepted the return. The currency of the returned
7412
+ # value is stored in the currency_code segment. If this metric is selected, '
7413
+ # segments.currency_code' is automatically added to the SELECT clause in the
7414
+ # search query (unless it is explicitly selected by the user) and the
7415
+ # currency_code segment is populated in the response. **This metric cannot be
7416
+ # segmented by customer_country_code.**
6994
7417
  # Corresponds to the JSON property `returnsMicros`
6995
7418
  # @return [Fixnum]
6996
7419
  attr_accessor :returns_micros
6997
7420
 
6998
- # Total price of shipped items in micros (1 millionth of a standard unit, 1 USD =
6999
- # 1000000 micros), reported on the order date. Excludes shipping and taxes (US
7000
- # only). The currency of the returned value is stored in the currency_code
7001
- # segment. If this metric is selected, 'segments.currency_code' is automatically
7002
- # added to the SELECT clause in the search query (unless it is explicitly
7003
- # selected by the user) and the currency_code segment is populated in the
7004
- # response. **This metric cannot be segmented by customer_country_code.**
7421
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7422
+ # starting from May 2024. Total price of shipped items in micros (1 millionth of
7423
+ # a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes
7424
+ # shipping and taxes (US only). The currency of the returned value is stored in
7425
+ # the currency_code segment. If this metric is selected, 'segments.currency_code'
7426
+ # is automatically added to the SELECT clause in the search query (unless it is
7427
+ # explicitly selected by the user) and the currency_code segment is populated in
7428
+ # the response. **This metric cannot be segmented by customer_country_code.**
7005
7429
  # Corresponds to the JSON property `shippedItemSalesMicros`
7006
7430
  # @return [Fixnum]
7007
7431
  attr_accessor :shipped_item_sales_micros
7008
7432
 
7009
- # Number of shipped items, reported on the shipment date. **This metric cannot
7010
- # be segmented by customer_country_code.**
7433
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7434
+ # starting from May 2024. Number of shipped items, reported on the shipment date.
7435
+ # **This metric cannot be segmented by customer_country_code.**
7011
7436
  # Corresponds to the JSON property `shippedItems`
7012
7437
  # @return [Fixnum]
7013
7438
  attr_accessor :shipped_items
7014
7439
 
7015
- # Number of fully shipped orders, reported on the last shipment date. **This
7016
- # metric cannot be segmented by product dimensions and customer_country_code.**
7440
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7441
+ # starting from May 2024. Number of fully shipped orders, reported on the last
7442
+ # shipment date. **This metric cannot be segmented by product dimensions and
7443
+ # customer_country_code.**
7017
7444
  # Corresponds to the JSON property `shippedOrders`
7018
7445
  # @return [Fixnum]
7019
7446
  attr_accessor :shipped_orders
7020
7447
 
7021
- # Number of ordered items not shipped up until the end of the queried day. If a
7022
- # multi-day period is specified in the search query, the returned value is the
7023
- # average number of unshipped items over the days in the queried period. **This
7024
- # metric cannot be segmented by customer_country_code.**
7448
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7449
+ # starting from May 2024. Number of ordered items not shipped up until the end
7450
+ # of the queried day. If a multi-day period is specified in the search query,
7451
+ # the returned value is the average number of unshipped items over the days in
7452
+ # the queried period. **This metric cannot be segmented by customer_country_code.
7453
+ # **
7025
7454
  # Corresponds to the JSON property `unshippedItems`
7026
7455
  # @return [Float]
7027
7456
  attr_accessor :unshipped_items
7028
7457
 
7029
- # Number of orders not shipped or partially shipped up until the end of the
7030
- # queried day. If a multi-day period is specified in the search query, the
7031
- # returned value is the average number of unshipped orders over the days in the
7032
- # queried period. **This metric cannot be segmented by product dimensions and
7033
- # customer_country_code.**
7458
+ # *Deprecated*: This field is no longer supported and retrieving it returns 0
7459
+ # starting from May 2024. Number of orders not shipped or partially shipped up
7460
+ # until the end of the queried day. If a multi-day period is specified in the
7461
+ # search query, the returned value is the average number of unshipped orders
7462
+ # over the days in the queried period. **This metric cannot be segmented by
7463
+ # product dimensions and customer_country_code.**
7034
7464
  # Corresponds to the JSON property `unshippedOrders`
7035
7465
  # @return [Float]
7036
7466
  attr_accessor :unshipped_orders
@@ -11879,6 +12309,38 @@ module Google
11879
12309
  # @return [String]
11880
12310
  attr_accessor :kind
11881
12311
 
12312
+ # Output only. The matching status of POS store and Google Business Profile
12313
+ # store. Possible values are: - "`matched`": The POS store is successfully
12314
+ # matched with the Google Business Profile store. - "`failed`": The POS store is
12315
+ # not matched with the Google Business Profile store. See matching_status_hint
12316
+ # for further details. Note that there is up to 48 hours propagation delay for
12317
+ # changes in Merchant Center (e.g. creation of new account, accounts linking)
12318
+ # and Google Business Profile (e.g. store address update) which may affect the
12319
+ # matching status. In such cases, after a delay call [pos.list](https://
12320
+ # developers.google.com/shopping-content/reference/rest/v2.1/pos/list) to
12321
+ # retrieve the updated matching status.
12322
+ # Corresponds to the JSON property `matchingStatus`
12323
+ # @return [String]
12324
+ attr_accessor :matching_status
12325
+
12326
+ # Output only. The hint of why the matching has failed. This is only set when
12327
+ # matching_status=failed. Possible values are: - "`linked-store-not-found`":
12328
+ # There aren't any Google Business Profile stores available for matching.
12329
+ # Connect your Merchant Center account with the Google Business Profile account.
12330
+ # Or add a new Google Business Profile store corresponding to the POS store. - "`
12331
+ # store-match-not-found`": The provided POS store couldn't be matched to any of
12332
+ # the connected Google Business Profile stores. Merchant Center account is
12333
+ # connected correctly and stores are available on Google Business Profile, but
12334
+ # POS store location address does not match with Google Business Profile stores'
12335
+ # addresses. Update POS store address or Google Business Profile store address
12336
+ # to match correctly. - "`store-match-unverified`": The provided POS store
12337
+ # couldn't be matched to any of the connected Google Business Profile stores, as
12338
+ # the matched Google Business Profile store is unverified. Go through the Google
12339
+ # Business Profile verification process to match correctly.
12340
+ # Corresponds to the JSON property `matchingStatusHint`
12341
+ # @return [String]
12342
+ attr_accessor :matching_status_hint
12343
+
11882
12344
  # The store phone number.
11883
12345
  # Corresponds to the JSON property `phoneNumber`
11884
12346
  # @return [String]
@@ -11917,6 +12379,8 @@ module Google
11917
12379
  def update!(**args)
11918
12380
  @gcid_category = args[:gcid_category] if args.key?(:gcid_category)
11919
12381
  @kind = args[:kind] if args.key?(:kind)
12382
+ @matching_status = args[:matching_status] if args.key?(:matching_status)
12383
+ @matching_status_hint = args[:matching_status_hint] if args.key?(:matching_status_hint)
11920
12384
  @phone_number = args[:phone_number] if args.key?(:phone_number)
11921
12385
  @place_id = args[:place_id] if args.key?(:place_id)
11922
12386
  @store_address = args[:store_address] if args.key?(:store_address)
@@ -12081,6 +12545,11 @@ module Google
12081
12545
  class PriceInsights
12082
12546
  include Google::Apis::Core::Hashable
12083
12547
 
12548
+ # The predicted effectiveness of applying the price suggestion, bucketed.
12549
+ # Corresponds to the JSON property `effectiveness`
12550
+ # @return [String]
12551
+ attr_accessor :effectiveness
12552
+
12084
12553
  # The predicted change in clicks as a fraction after introducing the suggested
12085
12554
  # price compared to current active price. For example, 0.05 is a 5% predicted
12086
12555
  # increase in clicks.
@@ -12142,6 +12611,7 @@ module Google
12142
12611
 
12143
12612
  # Update properties of this object
12144
12613
  def update!(**args)
12614
+ @effectiveness = args[:effectiveness] if args.key?(:effectiveness)
12145
12615
  @predicted_clicks_change_fraction = args[:predicted_clicks_change_fraction] if args.key?(:predicted_clicks_change_fraction)
12146
12616
  @predicted_conversions_change_fraction = args[:predicted_conversions_change_fraction] if args.key?(:predicted_conversions_change_fraction)
12147
12617
  @predicted_gross_profit_change_fraction = args[:predicted_gross_profit_change_fraction] if args.key?(:predicted_gross_profit_change_fraction)
@@ -12198,6 +12668,14 @@ module Google
12198
12668
  # @return [String]
12199
12669
  attr_accessor :age_group
12200
12670
 
12671
+ # A safeguard in the [Automated Discounts](//support.google.com/merchants/answer/
12672
+ # 10295759) and [Dynamic Promotions](//support.google.com/merchants/answer/
12673
+ # 13949249) projects, ensuring that discounts on merchants' offers do not fall
12674
+ # below this value, thereby preserving the offer's value and profitability.
12675
+ # Corresponds to the JSON property `autoPricingMinPrice`
12676
+ # @return [Google::Apis::ContentV2_1::Price]
12677
+ attr_accessor :auto_pricing_min_price
12678
+
12201
12679
  # Availability status of the item.
12202
12680
  # Corresponds to the JSON property `availability`
12203
12681
  # @return [String]
@@ -12334,9 +12812,10 @@ module Google
12334
12812
  # @return [String]
12335
12813
  attr_accessor :energy_efficiency_class
12336
12814
 
12337
- # The list of destinations to exclude for this target (corresponds to cleared
12338
- # check boxes in Merchant Center). Products that are excluded from all
12339
- # destinations for more than 7 days are automatically deleted.
12815
+ # The list of [destinations to exclude](//support.google.com/merchants/answer/
12816
+ # 6324486) for this target (corresponds to cleared check boxes in Merchant
12817
+ # Center). Products that are excluded from all destinations for more than 7 days
12818
+ # are automatically deleted.
12340
12819
  # Corresponds to the JSON property `excludedDestinations`
12341
12820
  # @return [Array<String>]
12342
12821
  attr_accessor :excluded_destinations
@@ -12362,6 +12841,11 @@ module Google
12362
12841
  # @return [String]
12363
12842
  attr_accessor :feed_label
12364
12843
 
12844
+ # Optional. Conditions to be met for a product to have free shipping.
12845
+ # Corresponds to the JSON property `freeShippingThreshold`
12846
+ # @return [Array<Google::Apis::ContentV2_1::FreeShippingThreshold>]
12847
+ attr_accessor :free_shipping_threshold
12848
+
12365
12849
  # Target gender of the item.
12366
12850
  # Corresponds to the JSON property `gender`
12367
12851
  # @return [String]
@@ -12401,14 +12885,16 @@ module Google
12401
12885
  # @return [String]
12402
12886
  attr_accessor :image_link
12403
12887
 
12404
- # The list of destinations to include for this target (corresponds to checked
12405
- # check boxes in Merchant Center). Default destinations are always included
12406
- # unless provided in `excludedDestinations`.
12888
+ # The list of [destinations to include](//support.google.com/merchants/answer/
12889
+ # 7501026) for this target (corresponds to checked check boxes in Merchant
12890
+ # Center). Default destinations are always included unless provided in `
12891
+ # excludedDestinations`.
12407
12892
  # Corresponds to the JSON property `includedDestinations`
12408
12893
  # @return [Array<String>]
12409
12894
  attr_accessor :included_destinations
12410
12895
 
12411
- # Number and amount of installments to pay for an item.
12896
+ # Details of a monthly installment payment offering. [Learn more](https://
12897
+ # support.google.com/merchants/answer/6324474) about installments.
12412
12898
  # Corresponds to the JSON property `installment`
12413
12899
  # @return [Google::Apis::ContentV2_1::Installment]
12414
12900
  attr_accessor :installment
@@ -12448,10 +12934,18 @@ module Google
12448
12934
  # @return [String]
12449
12935
  attr_accessor :link_template
12450
12936
 
12451
- # Loyalty points that users receive after purchasing the item. Japan only.
12452
- # Corresponds to the JSON property `loyaltyPoints`
12453
- # @return [Google::Apis::ContentV2_1::LoyaltyPoints]
12454
- attr_accessor :loyalty_points
12937
+ # Allows the setting up of loyalty program benefits (for example price or points)
12938
+ # . https://support.google.com/merchants/answer/12922446
12939
+ # Corresponds to the JSON property `loyaltyProgram`
12940
+ # @return [Google::Apis::ContentV2_1::LoyaltyProgram]
12941
+ attr_accessor :loyalty_program
12942
+
12943
+ # Optional. A list of loyalty program information that is used to surface
12944
+ # loyalty benefits (for example, better pricing, points, etc) to the user of
12945
+ # this item.
12946
+ # Corresponds to the JSON property `loyaltyPrograms`
12947
+ # @return [Array<Google::Apis::ContentV2_1::LoyaltyProgram>]
12948
+ attr_accessor :loyalty_programs
12455
12949
 
12456
12950
  # The material of which the item is made.
12457
12951
  # Corresponds to the JSON property `material`
@@ -12651,12 +13145,25 @@ module Google
12651
13145
  # @return [Array<String>]
12652
13146
  attr_accessor :sizes
12653
13147
 
12654
- # The source of the offer, that is, how the offer was created. Acceptable values
12655
- # are: - "`api`" - "`crawl`" - "`feed`"
13148
+ # Output only. The source of the offer, that is, how the offer was created.
13149
+ # Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
12656
13150
  # Corresponds to the JSON property `source`
12657
13151
  # @return [String]
12658
13152
  attr_accessor :source
12659
13153
 
13154
+ # Structured description, for algorithmically (AI)-generated descriptions. See [
13155
+ # description](https://support.google.com/merchants/answer/6324468#When_to_use)
13156
+ # for more information.
13157
+ # Corresponds to the JSON property `structuredDescription`
13158
+ # @return [Google::Apis::ContentV2_1::ProductStructuredDescription]
13159
+ attr_accessor :structured_description
13160
+
13161
+ # Structured title, for algorithmically (AI)-generated titles. See [title](https:
13162
+ # //support.google.com/merchants/answer/6324415#Whentouse) for more information.
13163
+ # Corresponds to the JSON property `structuredTitle`
13164
+ # @return [Google::Apis::ContentV2_1::ProductStructuredTitle]
13165
+ attr_accessor :structured_title
13166
+
12660
13167
  # Number of periods (months or years) and amount of payment per period for an
12661
13168
  # item with an associated subscription contract.
12662
13169
  # Corresponds to the JSON property `subscriptionCost`
@@ -12718,6 +13225,7 @@ module Google
12718
13225
  @ads_redirect = args[:ads_redirect] if args.key?(:ads_redirect)
12719
13226
  @adult = args[:adult] if args.key?(:adult)
12720
13227
  @age_group = args[:age_group] if args.key?(:age_group)
13228
+ @auto_pricing_min_price = args[:auto_pricing_min_price] if args.key?(:auto_pricing_min_price)
12721
13229
  @availability = args[:availability] if args.key?(:availability)
12722
13230
  @availability_date = args[:availability_date] if args.key?(:availability_date)
12723
13231
  @brand = args[:brand] if args.key?(:brand)
@@ -12747,6 +13255,7 @@ module Google
12747
13255
  @expiration_date = args[:expiration_date] if args.key?(:expiration_date)
12748
13256
  @external_seller_id = args[:external_seller_id] if args.key?(:external_seller_id)
12749
13257
  @feed_label = args[:feed_label] if args.key?(:feed_label)
13258
+ @free_shipping_threshold = args[:free_shipping_threshold] if args.key?(:free_shipping_threshold)
12750
13259
  @gender = args[:gender] if args.key?(:gender)
12751
13260
  @google_product_category = args[:google_product_category] if args.key?(:google_product_category)
12752
13261
  @gtin = args[:gtin] if args.key?(:gtin)
@@ -12761,7 +13270,8 @@ module Google
12761
13270
  @lifestyle_image_links = args[:lifestyle_image_links] if args.key?(:lifestyle_image_links)
12762
13271
  @link = args[:link] if args.key?(:link)
12763
13272
  @link_template = args[:link_template] if args.key?(:link_template)
12764
- @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points)
13273
+ @loyalty_program = args[:loyalty_program] if args.key?(:loyalty_program)
13274
+ @loyalty_programs = args[:loyalty_programs] if args.key?(:loyalty_programs)
12765
13275
  @material = args[:material] if args.key?(:material)
12766
13276
  @max_energy_efficiency_class = args[:max_energy_efficiency_class] if args.key?(:max_energy_efficiency_class)
12767
13277
  @max_handling_time = args[:max_handling_time] if args.key?(:max_handling_time)
@@ -12799,6 +13309,8 @@ module Google
12799
13309
  @size_type = args[:size_type] if args.key?(:size_type)
12800
13310
  @sizes = args[:sizes] if args.key?(:sizes)
12801
13311
  @source = args[:source] if args.key?(:source)
13312
+ @structured_description = args[:structured_description] if args.key?(:structured_description)
13313
+ @structured_title = args[:structured_title] if args.key?(:structured_title)
12802
13314
  @subscription_cost = args[:subscription_cost] if args.key?(:subscription_cost)
12803
13315
  @target_country = args[:target_country] if args.key?(:target_country)
12804
13316
  @tax_category = args[:tax_category] if args.key?(:tax_category)
@@ -12866,6 +13378,12 @@ module Google
12866
13378
  # @return [String]
12867
13379
  attr_accessor :certification_name
12868
13380
 
13381
+ # The certification value (also known as class, level or grade), for example "A+"
13382
+ # , "C", "gold". Maximum length is 2000 characters.
13383
+ # Corresponds to the JSON property `certificationValue`
13384
+ # @return [String]
13385
+ attr_accessor :certification_value
13386
+
12869
13387
  def initialize(**args)
12870
13388
  update!(**args)
12871
13389
  end
@@ -12875,6 +13393,7 @@ module Google
12875
13393
  @certification_authority = args[:certification_authority] if args.key?(:certification_authority)
12876
13394
  @certification_code = args[:certification_code] if args.key?(:certification_code)
12877
13395
  @certification_name = args[:certification_name] if args.key?(:certification_name)
13396
+ @certification_value = args[:certification_value] if args.key?(:certification_value)
12878
13397
  end
12879
13398
  end
12880
13399
 
@@ -13160,10 +13679,11 @@ module Google
13160
13679
  # question` - the tooltip shows helpful information, can use the '?' as an icon.
13161
13680
  # * `tooltip-style-info` - the tooltip adds additional information fitting to
13162
13681
  # the context, can use the 'i' as an icon. * `content-moderation` - marks the
13163
- # paragraph that explains how the issue was identified. * `new-element` -
13164
- # Present for new elements added to the pre-rendered content in the future. To
13165
- # make sure that a new content element does not break your style, you can hide
13166
- # everything with this class.
13682
+ # paragraph that explains how the issue was identified. * `list-intro` - marks
13683
+ # the paragraph that contains an intro for a list. This paragraph will be always
13684
+ # followed by a list. * `new-element` - Present for new elements added to the
13685
+ # pre-rendered content in the future. To make sure that a new content element
13686
+ # does not break your style, you can hide everything with this class.
13167
13687
  # Corresponds to the JSON property `prerenderedContent`
13168
13688
  # @return [String]
13169
13689
  attr_accessor :prerendered_content
@@ -13577,6 +14097,61 @@ module Google
13577
14097
  end
13578
14098
  end
13579
14099
 
14100
+ # Structured description, for algorithmically (AI)-generated descriptions. See [
14101
+ # description](https://support.google.com/merchants/answer/6324468#When_to_use)
14102
+ # for more information.
14103
+ class ProductStructuredDescription
14104
+ include Google::Apis::Core::Hashable
14105
+
14106
+ # Required. The description text. Maximum length is 5000 characters.
14107
+ # Corresponds to the JSON property `content`
14108
+ # @return [String]
14109
+ attr_accessor :content
14110
+
14111
+ # Optional. The digital source type. Acceptable values are: - "`
14112
+ # trained_algorithmic_media`" - "`default`"
14113
+ # Corresponds to the JSON property `digitalSourceType`
14114
+ # @return [String]
14115
+ attr_accessor :digital_source_type
14116
+
14117
+ def initialize(**args)
14118
+ update!(**args)
14119
+ end
14120
+
14121
+ # Update properties of this object
14122
+ def update!(**args)
14123
+ @content = args[:content] if args.key?(:content)
14124
+ @digital_source_type = args[:digital_source_type] if args.key?(:digital_source_type)
14125
+ end
14126
+ end
14127
+
14128
+ # Structured title, for algorithmically (AI)-generated titles. See [title](https:
14129
+ # //support.google.com/merchants/answer/6324415#Whentouse) for more information.
14130
+ class ProductStructuredTitle
14131
+ include Google::Apis::Core::Hashable
14132
+
14133
+ # Required. The title text. Maximum length is 150 characters.
14134
+ # Corresponds to the JSON property `content`
14135
+ # @return [String]
14136
+ attr_accessor :content
14137
+
14138
+ # Optional. The digital source type. Acceptable values are: - "`
14139
+ # trained_algorithmic_media`" - "`default`"
14140
+ # Corresponds to the JSON property `digitalSourceType`
14141
+ # @return [String]
14142
+ attr_accessor :digital_source_type
14143
+
14144
+ def initialize(**args)
14145
+ update!(**args)
14146
+ end
14147
+
14148
+ # Update properties of this object
14149
+ def update!(**args)
14150
+ @content = args[:content] if args.key?(:content)
14151
+ @digital_source_type = args[:digital_source_type] if args.key?(:digital_source_type)
14152
+ end
14153
+ end
14154
+
13580
14155
  #
13581
14156
  class ProductSubscriptionCost
13582
14157
  include Google::Apis::Core::Hashable
@@ -13586,7 +14161,7 @@ module Google
13586
14161
  # @return [Google::Apis::ContentV2_1::Price]
13587
14162
  attr_accessor :amount
13588
14163
 
13589
- # The type of subscription period.
14164
+ # The type of subscription period. - "`month`" - "`year`"
13590
14165
  # Corresponds to the JSON property `period`
13591
14166
  # @return [String]
13592
14167
  attr_accessor :period
@@ -13766,6 +14341,19 @@ module Google
13766
14341
  # @return [String]
13767
14342
  attr_accessor :channel
13768
14343
 
14344
+ # Estimated performance potential compared to highest performing products of the
14345
+ # merchant.
14346
+ # Corresponds to the JSON property `clickPotential`
14347
+ # @return [String]
14348
+ attr_accessor :click_potential
14349
+
14350
+ # Rank of the product based on its click potential. A product with `
14351
+ # click_potential_rank` 1 has the highest click potential among the merchant's
14352
+ # products that fulfill the search query conditions.
14353
+ # Corresponds to the JSON property `clickPotentialRank`
14354
+ # @return [Fixnum]
14355
+ attr_accessor :click_potential_rank
14356
+
13769
14357
  # Condition of the product.
13770
14358
  # Corresponds to the JSON property `condition`
13771
14359
  # @return [String]
@@ -13888,6 +14476,8 @@ module Google
13888
14476
  @category_l4 = args[:category_l4] if args.key?(:category_l4)
13889
14477
  @category_l5 = args[:category_l5] if args.key?(:category_l5)
13890
14478
  @channel = args[:channel] if args.key?(:channel)
14479
+ @click_potential = args[:click_potential] if args.key?(:click_potential)
14480
+ @click_potential_rank = args[:click_potential_rank] if args.key?(:click_potential_rank)
13891
14481
  @condition = args[:condition] if args.key?(:condition)
13892
14482
  @creation_time = args[:creation_time] if args.key?(:creation_time)
13893
14483
  @currency_code = args[:currency_code] if args.key?(:currency_code)
@@ -14460,11 +15050,11 @@ module Google
14460
15050
  # @return [Fixnum]
14461
15051
  attr_accessor :get_this_quantity_discounted
14462
15052
 
14463
- # Required. Output only. The REST promotion ID to uniquely identify the
14464
- # promotion. Content API methods that operate on promotions take this as their `
14465
- # promotionId` parameter. The REST ID for a promotion is of the form channel:
14466
- # contentLanguage:targetCountry:promotionId The `channel` field has a value of `"
14467
- # online"`, `"in_store"`, or `"online_in_store"`.
15053
+ # Output only. The REST promotion ID to uniquely identify the promotion. Content
15054
+ # API methods that operate on promotions take this as their `promotionId`
15055
+ # parameter. The REST ID for a promotion is of the form channel:contentLanguage:
15056
+ # targetCountry:promotionId The `channel` field has a value of `"online"`, `"
15057
+ # in_store"`, or `"online_in_store"`.
14468
15058
  # Corresponds to the JSON property `id`
14469
15059
  # @return [String]
14470
15060
  attr_accessor :id
@@ -15442,6 +16032,13 @@ module Google
15442
16032
  # @return [String]
15443
16033
  attr_accessor :content_option
15444
16034
 
16035
+ # Optional. How actions with user input form should be handled. If not provided,
16036
+ # actions will be returned as links that points merchant to Merchant Center
16037
+ # where they can request the action.
16038
+ # Corresponds to the JSON property `userInputActionOption`
16039
+ # @return [String]
16040
+ attr_accessor :user_input_action_option
16041
+
15445
16042
  def initialize(**args)
15446
16043
  update!(**args)
15447
16044
  end
@@ -15449,6 +16046,7 @@ module Google
15449
16046
  # Update properties of this object
15450
16047
  def update!(**args)
15451
16048
  @content_option = args[:content_option] if args.key?(:content_option)
16049
+ @user_input_action_option = args[:user_input_action_option] if args.key?(:user_input_action_option)
15452
16050
  end
15453
16051
  end
15454
16052
 
@@ -15492,6 +16090,13 @@ module Google
15492
16090
  # @return [String]
15493
16091
  attr_accessor :content_option
15494
16092
 
16093
+ # Optional. How actions with user input form should be handled. If not provided,
16094
+ # actions will be returned as links that points merchant to Merchant Center
16095
+ # where they can request the action.
16096
+ # Corresponds to the JSON property `userInputActionOption`
16097
+ # @return [String]
16098
+ attr_accessor :user_input_action_option
16099
+
15495
16100
  def initialize(**args)
15496
16101
  update!(**args)
15497
16102
  end
@@ -15499,6 +16104,7 @@ module Google
15499
16104
  # Update properties of this object
15500
16105
  def update!(**args)
15501
16106
  @content_option = args[:content_option] if args.key?(:content_option)
16107
+ @user_input_action_option = args[:user_input_action_option] if args.key?(:user_input_action_option)
15502
16108
  end
15503
16109
  end
15504
16110
 
@@ -15639,6 +16245,20 @@ module Google
15639
16245
  # @return [Google::Apis::ContentV2_1::Segments]
15640
16246
  attr_accessor :segments
15641
16247
 
16248
+ # Topic trends fields requested by the merchant in the query. Field values are
16249
+ # only set if the merchant queries `TopicTrendsView`. Forecast data can be
16250
+ # queried up to 13 weeks by passing a future date in the `date` field.
16251
+ # Historical data is measured daily, and forecasted data is projected weekly.
16252
+ # All data points are normalized based on the highest data points returned in
16253
+ # the response. If you make separate queries with different date ranges, you
16254
+ # might see different values for the same date in each response. The recommended
16255
+ # way to get a trend score of a topic is `last7_days_search_interest / last`$day`
16256
+ # _days_search_interest - 1`. You can view trends for up to eight topics at a
16257
+ # time.
16258
+ # Corresponds to the JSON property `topicTrends`
16259
+ # @return [Google::Apis::ContentV2_1::TopicTrends]
16260
+ attr_accessor :topic_trends
16261
+
15642
16262
  def initialize(**args)
15643
16263
  update!(**args)
15644
16264
  end
@@ -15654,79 +16274,60 @@ module Google
15654
16274
  @product_cluster = args[:product_cluster] if args.key?(:product_cluster)
15655
16275
  @product_view = args[:product_view] if args.key?(:product_view)
15656
16276
  @segments = args[:segments] if args.key?(:segments)
16277
+ @topic_trends = args[:topic_trends] if args.key?(:topic_trends)
15657
16278
  end
15658
16279
  end
15659
16280
 
15660
- # Resource that represents a daily Repricing product report. Each report
15661
- # contains stats for a single type of Repricing rule for a single product on a
15662
- # given day. If there are multiple rules of the same type for the product on
15663
- # that day, the report lists all the rules by rule ids, combines the stats, and
15664
- # paginates the results by date. To retrieve the stats of a particular rule,
15665
- # provide the rule_id in the request.
15666
- class RepricingProductReport
16281
+ # Request message for the RequestPhoneVerification method.
16282
+ class RequestPhoneVerificationRequest
15667
16283
  include Google::Apis::Core::Hashable
15668
16284
 
15669
- # Total count of Repricer applications. This value captures how many times the
15670
- # rule of this type was applied to this product during this reporting period.
15671
- # Corresponds to the JSON property `applicationCount`
15672
- # @return [Fixnum]
15673
- attr_accessor :application_count
15674
-
15675
- # Stats specific to buybox winning rules for product report.
15676
- # Corresponds to the JSON property `buyboxWinningProductStats`
15677
- # @return [Google::Apis::ContentV2_1::RepricingProductReportBuyboxWinningProductStats]
15678
- attr_accessor :buybox_winning_product_stats
15679
-
15680
- # Represents a whole or partial calendar date, such as a birthday. The time of
15681
- # day and time zone are either specified elsewhere or are insignificant. The
15682
- # date is relative to the Gregorian Calendar. This can represent one of the
15683
- # following: * A full date, with non-zero year, month, and day values. * A month
15684
- # and day, with a zero year (for example, an anniversary). * A year on its own,
15685
- # with a zero month and a zero day. * A year and month, with a zero day (for
15686
- # example, a credit card expiration date). Related types: * google.type.
15687
- # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
15688
- # Corresponds to the JSON property `date`
15689
- # @return [Google::Apis::ContentV2_1::Date]
15690
- attr_accessor :date
16285
+ # Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) (for
16286
+ # example, en-US). Language code is used to provide localized `SMS` and `
16287
+ # PHONE_CALL`. Default language used is en-US if not provided.
16288
+ # Corresponds to the JSON property `languageCode`
16289
+ # @return [String]
16290
+ attr_accessor :language_code
15691
16291
 
15692
- # The price represented as a number and currency.
15693
- # Corresponds to the JSON property `highWatermark`
15694
- # @return [Google::Apis::ContentV2_1::PriceAmount]
15695
- attr_accessor :high_watermark
16292
+ # Phone number to be verified.
16293
+ # Corresponds to the JSON property `phoneNumber`
16294
+ # @return [String]
16295
+ attr_accessor :phone_number
15696
16296
 
15697
- # List of all reasons the rule did not apply to the product during the specified
15698
- # reporting period.
15699
- # Corresponds to the JSON property `inapplicabilityDetails`
15700
- # @return [Array<Google::Apis::ContentV2_1::InapplicabilityDetails>]
15701
- attr_accessor :inapplicability_details
16297
+ # Required. Two letter country code for the phone number, for example `CA` for
16298
+ # Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/
16299
+ # ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned
16300
+ # codes.
16301
+ # Corresponds to the JSON property `phoneRegionCode`
16302
+ # @return [String]
16303
+ attr_accessor :phone_region_code
15702
16304
 
15703
- # The price represented as a number and currency.
15704
- # Corresponds to the JSON property `lowWatermark`
15705
- # @return [Google::Apis::ContentV2_1::PriceAmount]
15706
- attr_accessor :low_watermark
16305
+ # Verification method to receive verification code.
16306
+ # Corresponds to the JSON property `phoneVerificationMethod`
16307
+ # @return [String]
16308
+ attr_accessor :phone_verification_method
15707
16309
 
15708
- # Total unit count of impacted products ordered while the rule was active on the
15709
- # date of the report. This count includes all orders that were started while the
15710
- # rule was active, even if the rule was no longer active when the order was
15711
- # completed.
15712
- # Corresponds to the JSON property `orderItemCount`
15713
- # @return [Fixnum]
15714
- attr_accessor :order_item_count
16310
+ def initialize(**args)
16311
+ update!(**args)
16312
+ end
15715
16313
 
15716
- # Ids of the Repricing rule for this report.
15717
- # Corresponds to the JSON property `ruleIds`
15718
- # @return [Array<String>]
15719
- attr_accessor :rule_ids
16314
+ # Update properties of this object
16315
+ def update!(**args)
16316
+ @language_code = args[:language_code] if args.key?(:language_code)
16317
+ @phone_number = args[:phone_number] if args.key?(:phone_number)
16318
+ @phone_region_code = args[:phone_region_code] if args.key?(:phone_region_code)
16319
+ @phone_verification_method = args[:phone_verification_method] if args.key?(:phone_verification_method)
16320
+ end
16321
+ end
15720
16322
 
15721
- # The price represented as a number and currency.
15722
- # Corresponds to the JSON property `totalGmv`
15723
- # @return [Google::Apis::ContentV2_1::PriceAmount]
15724
- attr_accessor :total_gmv
16323
+ # Response message for the RequestPhoneVerification method.
16324
+ class RequestPhoneVerificationResponse
16325
+ include Google::Apis::Core::Hashable
15725
16326
 
15726
- # Type of the rule.
15727
- # Corresponds to the JSON property `type`
16327
+ # The verification ID to use in subsequent calls to `verifyphonenumber`.
16328
+ # Corresponds to the JSON property `verificationId`
15728
16329
  # @return [String]
15729
- attr_accessor :type
16330
+ attr_accessor :verification_id
15730
16331
 
15731
16332
  def initialize(**args)
15732
16333
  update!(**args)
@@ -15734,572 +16335,36 @@ module Google
15734
16335
 
15735
16336
  # Update properties of this object
15736
16337
  def update!(**args)
15737
- @application_count = args[:application_count] if args.key?(:application_count)
15738
- @buybox_winning_product_stats = args[:buybox_winning_product_stats] if args.key?(:buybox_winning_product_stats)
15739
- @date = args[:date] if args.key?(:date)
15740
- @high_watermark = args[:high_watermark] if args.key?(:high_watermark)
15741
- @inapplicability_details = args[:inapplicability_details] if args.key?(:inapplicability_details)
15742
- @low_watermark = args[:low_watermark] if args.key?(:low_watermark)
15743
- @order_item_count = args[:order_item_count] if args.key?(:order_item_count)
15744
- @rule_ids = args[:rule_ids] if args.key?(:rule_ids)
15745
- @total_gmv = args[:total_gmv] if args.key?(:total_gmv)
15746
- @type = args[:type] if args.key?(:type)
16338
+ @verification_id = args[:verification_id] if args.key?(:verification_id)
15747
16339
  end
15748
16340
  end
15749
16341
 
15750
- # Stats specific to buybox winning rules for product report.
15751
- class RepricingProductReportBuyboxWinningProductStats
16342
+ # Request message for the RequestReviewProgram method.
16343
+ class RequestReviewBuyOnGoogleProgramRequest
15752
16344
  include Google::Apis::Core::Hashable
15753
16345
 
15754
- # Number of times this product won the buybox with these rules during this time
15755
- # period.
15756
- # Corresponds to the JSON property `buyboxWinsCount`
15757
- # @return [Fixnum]
15758
- attr_accessor :buybox_wins_count
15759
-
15760
16346
  def initialize(**args)
15761
16347
  update!(**args)
15762
16348
  end
15763
16349
 
15764
16350
  # Update properties of this object
15765
16351
  def update!(**args)
15766
- @buybox_wins_count = args[:buybox_wins_count] if args.key?(:buybox_wins_count)
15767
16352
  end
15768
16353
  end
15769
16354
 
15770
- # *Deprecated*: New merchants can't start using this resource. Represents a
15771
- # repricing rule. A repricing rule is used by shopping serving to adjust
15772
- # transactable offer prices if conditions are met.
15773
- class RepricingRule
16355
+ # Request message for the RequestReviewFreeListings Program method.
16356
+ class RequestReviewFreeListingsRequest
15774
16357
  include Google::Apis::Core::Hashable
15775
16358
 
15776
- # A repricing rule that changes the sale price based on cost of goods sale.
15777
- # Corresponds to the JSON property `cogsBasedRule`
15778
- # @return [Google::Apis::ContentV2_1::RepricingRuleCostOfGoodsSaleRule]
15779
- attr_accessor :cogs_based_rule
15780
-
15781
- # Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/
15782
- # tags/latest/common/main/en.xml) (for example, "US").
15783
- # Corresponds to the JSON property `countryCode`
16359
+ # The code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
16360
+ # of the country for which review is to be requested.
16361
+ # Corresponds to the JSON property `regionCode`
15784
16362
  # @return [String]
15785
- attr_accessor :country_code
16363
+ attr_accessor :region_code
15786
16364
 
15787
- # Required. Time period when the rule should take effect.
15788
- # Corresponds to the JSON property `effectiveTimePeriod`
15789
- # @return [Google::Apis::ContentV2_1::RepricingRuleEffectiveTime]
15790
- attr_accessor :effective_time_period
15791
-
15792
- # Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is
15793
- # selected, only the repricing_rule_id attribute on the product feed is used to
15794
- # specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only
15795
- # the *_matcher fields are used to filter the offers for offer-rule mapping. If
15796
- # the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom
15797
- # filter matcher to be eligible for a rule. Size limit: the sum of the number of
15798
- # entries in all the matchers should not exceed 20. For example, there can be 15
15799
- # product ids and 5 brands, but not 10 product ids and 11 brands.
15800
- # Corresponds to the JSON property `eligibleOfferMatcher`
15801
- # @return [Google::Apis::ContentV2_1::RepricingRuleEligibleOfferMatcher]
15802
- attr_accessor :eligible_offer_matcher
15803
-
15804
- # Required. Immutable. The two-letter ISO 639-1 language code associated with
15805
- # the repricing rule.
15806
- # Corresponds to the JSON property `languageCode`
15807
- # @return [String]
15808
- attr_accessor :language_code
15809
-
15810
- # Output only. Immutable. Merchant that owns the repricing rule.
15811
- # Corresponds to the JSON property `merchantId`
15812
- # @return [Fixnum]
15813
- attr_accessor :merchant_id
15814
-
15815
- # Represents whether a rule is paused. A paused rule will behave like a non-
15816
- # paused rule within CRUD operations, with the major difference that a paused
15817
- # rule will not be evaluated and will have no effect on offers.
15818
- # Corresponds to the JSON property `paused`
15819
- # @return [Boolean]
15820
- attr_accessor :paused
15821
- alias_method :paused?, :paused
15822
-
15823
- # Definition of a rule restriction. At least one of the following needs to be
15824
- # true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3)
15825
- # floor.percentage_delta exists If floor.price_delta and floor.percentage_delta
15826
- # are both set on a rule, the highest value will be chosen by the Repricer. In
15827
- # other words, for a product with a price of $50, if the `floor.percentage_delta`
15828
- # is "-10" and the floor.price_delta is "-12", the offer price will only be
15829
- # lowered $5 (10% lower than the original offer price).
15830
- # Corresponds to the JSON property `restriction`
15831
- # @return [Google::Apis::ContentV2_1::RepricingRuleRestriction]
15832
- attr_accessor :restriction
15833
-
15834
- # Output only. Immutable. The ID to uniquely identify each repricing rule.
15835
- # Corresponds to the JSON property `ruleId`
15836
- # @return [String]
15837
- attr_accessor :rule_id
15838
-
15839
- # Definition of stats based rule.
15840
- # Corresponds to the JSON property `statsBasedRule`
15841
- # @return [Google::Apis::ContentV2_1::RepricingRuleStatsBasedRule]
15842
- attr_accessor :stats_based_rule
15843
-
15844
- # The title for the rule.
15845
- # Corresponds to the JSON property `title`
15846
- # @return [String]
15847
- attr_accessor :title
15848
-
15849
- # Required. Immutable. The type of the rule.
15850
- # Corresponds to the JSON property `type`
15851
- # @return [String]
15852
- attr_accessor :type
15853
-
15854
- def initialize(**args)
15855
- update!(**args)
15856
- end
15857
-
15858
- # Update properties of this object
15859
- def update!(**args)
15860
- @cogs_based_rule = args[:cogs_based_rule] if args.key?(:cogs_based_rule)
15861
- @country_code = args[:country_code] if args.key?(:country_code)
15862
- @effective_time_period = args[:effective_time_period] if args.key?(:effective_time_period)
15863
- @eligible_offer_matcher = args[:eligible_offer_matcher] if args.key?(:eligible_offer_matcher)
15864
- @language_code = args[:language_code] if args.key?(:language_code)
15865
- @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
15866
- @paused = args[:paused] if args.key?(:paused)
15867
- @restriction = args[:restriction] if args.key?(:restriction)
15868
- @rule_id = args[:rule_id] if args.key?(:rule_id)
15869
- @stats_based_rule = args[:stats_based_rule] if args.key?(:stats_based_rule)
15870
- @title = args[:title] if args.key?(:title)
15871
- @type = args[:type] if args.key?(:type)
15872
- end
15873
- end
15874
-
15875
- # A repricing rule that changes the sale price based on cost of goods sale.
15876
- class RepricingRuleCostOfGoodsSaleRule
15877
- include Google::Apis::Core::Hashable
15878
-
15879
- # The percent change against the COGS. Ex: 20 would mean to set the adjusted
15880
- # price 1.2X of the COGS data.
15881
- # Corresponds to the JSON property `percentageDelta`
15882
- # @return [Fixnum]
15883
- attr_accessor :percentage_delta
15884
-
15885
- # The price delta against the COGS. For example, 2 means $2 more of the COGS.
15886
- # Corresponds to the JSON property `priceDelta`
15887
- # @return [String]
15888
- attr_accessor :price_delta
15889
-
15890
- def initialize(**args)
15891
- update!(**args)
15892
- end
15893
-
15894
- # Update properties of this object
15895
- def update!(**args)
15896
- @percentage_delta = args[:percentage_delta] if args.key?(:percentage_delta)
15897
- @price_delta = args[:price_delta] if args.key?(:price_delta)
15898
- end
15899
- end
15900
-
15901
- #
15902
- class RepricingRuleEffectiveTime
15903
- include Google::Apis::Core::Hashable
15904
-
15905
- # A list of fixed time periods combined with OR. The maximum number of entries
15906
- # is limited to 5.
15907
- # Corresponds to the JSON property `fixedTimePeriods`
15908
- # @return [Array<Google::Apis::ContentV2_1::RepricingRuleEffectiveTimeFixedTimePeriod>]
15909
- attr_accessor :fixed_time_periods
15910
-
15911
- def initialize(**args)
15912
- update!(**args)
15913
- end
15914
-
15915
- # Update properties of this object
15916
- def update!(**args)
15917
- @fixed_time_periods = args[:fixed_time_periods] if args.key?(:fixed_time_periods)
15918
- end
15919
- end
15920
-
15921
- # Definition of a fixed time period.
15922
- class RepricingRuleEffectiveTimeFixedTimePeriod
15923
- include Google::Apis::Core::Hashable
15924
-
15925
- # The end time (exclusive) of the period. It can only be hour granularity.
15926
- # Corresponds to the JSON property `endTime`
15927
- # @return [String]
15928
- attr_accessor :end_time
15929
-
15930
- # The start time (inclusive) of the period. It can only be hour granularity.
15931
- # Corresponds to the JSON property `startTime`
15932
- # @return [String]
15933
- attr_accessor :start_time
15934
-
15935
- def initialize(**args)
15936
- update!(**args)
15937
- end
15938
-
15939
- # Update properties of this object
15940
- def update!(**args)
15941
- @end_time = args[:end_time] if args.key?(:end_time)
15942
- @start_time = args[:start_time] if args.key?(:start_time)
15943
- end
15944
- end
15945
-
15946
- # Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is
15947
- # selected, only the repricing_rule_id attribute on the product feed is used to
15948
- # specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only
15949
- # the *_matcher fields are used to filter the offers for offer-rule mapping. If
15950
- # the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom
15951
- # filter matcher to be eligible for a rule. Size limit: the sum of the number of
15952
- # entries in all the matchers should not exceed 20. For example, there can be 15
15953
- # product ids and 5 brands, but not 10 product ids and 11 brands.
15954
- class RepricingRuleEligibleOfferMatcher
15955
- include Google::Apis::Core::Hashable
15956
-
15957
- # Matcher by string attributes.
15958
- # Corresponds to the JSON property `brandMatcher`
15959
- # @return [Google::Apis::ContentV2_1::RepricingRuleEligibleOfferMatcherStringMatcher]
15960
- attr_accessor :brand_matcher
15961
-
15962
- # Matcher by string attributes.
15963
- # Corresponds to the JSON property `itemGroupIdMatcher`
15964
- # @return [Google::Apis::ContentV2_1::RepricingRuleEligibleOfferMatcherStringMatcher]
15965
- attr_accessor :item_group_id_matcher
15966
-
15967
- # Determines whether to use the custom matchers or the product feed attribute "
15968
- # repricing_rule_id" to specify offer-rule mapping.
15969
- # Corresponds to the JSON property `matcherOption`
15970
- # @return [String]
15971
- attr_accessor :matcher_option
15972
-
15973
- # Matcher by string attributes.
15974
- # Corresponds to the JSON property `offerIdMatcher`
15975
- # @return [Google::Apis::ContentV2_1::RepricingRuleEligibleOfferMatcherStringMatcher]
15976
- attr_accessor :offer_id_matcher
15977
-
15978
- # When true, the rule won't be applied to offers with active promotions.
15979
- # Corresponds to the JSON property `skipWhenOnPromotion`
15980
- # @return [Boolean]
15981
- attr_accessor :skip_when_on_promotion
15982
- alias_method :skip_when_on_promotion?, :skip_when_on_promotion
15983
-
15984
- def initialize(**args)
15985
- update!(**args)
15986
- end
15987
-
15988
- # Update properties of this object
15989
- def update!(**args)
15990
- @brand_matcher = args[:brand_matcher] if args.key?(:brand_matcher)
15991
- @item_group_id_matcher = args[:item_group_id_matcher] if args.key?(:item_group_id_matcher)
15992
- @matcher_option = args[:matcher_option] if args.key?(:matcher_option)
15993
- @offer_id_matcher = args[:offer_id_matcher] if args.key?(:offer_id_matcher)
15994
- @skip_when_on_promotion = args[:skip_when_on_promotion] if args.key?(:skip_when_on_promotion)
15995
- end
15996
- end
15997
-
15998
- # Matcher by string attributes.
15999
- class RepricingRuleEligibleOfferMatcherStringMatcher
16000
- include Google::Apis::Core::Hashable
16001
-
16002
- # String attributes, as long as such attribute of an offer is one of the string
16003
- # attribute values, the offer is considered as passing the matcher. The string
16004
- # matcher checks an offer for inclusivity in the string attributes, not equality.
16005
- # Only literal string matching is supported, no regular expressions.
16006
- # Corresponds to the JSON property `strAttributes`
16007
- # @return [Array<String>]
16008
- attr_accessor :str_attributes
16009
-
16010
- def initialize(**args)
16011
- update!(**args)
16012
- end
16013
-
16014
- # Update properties of this object
16015
- def update!(**args)
16016
- @str_attributes = args[:str_attributes] if args.key?(:str_attributes)
16017
- end
16018
- end
16019
-
16020
- # Resource that represents a daily Repricing rule report. Next ID: 11
16021
- class RepricingRuleReport
16022
- include Google::Apis::Core::Hashable
16023
-
16024
- # Stats specific to buybox winning rules for rule report.
16025
- # Corresponds to the JSON property `buyboxWinningRuleStats`
16026
- # @return [Google::Apis::ContentV2_1::RepricingRuleReportBuyboxWinningRuleStats]
16027
- attr_accessor :buybox_winning_rule_stats
16028
-
16029
- # Represents a whole or partial calendar date, such as a birthday. The time of
16030
- # day and time zone are either specified elsewhere or are insignificant. The
16031
- # date is relative to the Gregorian Calendar. This can represent one of the
16032
- # following: * A full date, with non-zero year, month, and day values. * A month
16033
- # and day, with a zero year (for example, an anniversary). * A year on its own,
16034
- # with a zero month and a zero day. * A year and month, with a zero day (for
16035
- # example, a credit card expiration date). Related types: * google.type.
16036
- # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
16037
- # Corresponds to the JSON property `date`
16038
- # @return [Google::Apis::ContentV2_1::Date]
16039
- attr_accessor :date
16040
-
16041
- # List of product ids that are impacted by this rule during this reporting
16042
- # period. Out of stock products and products not searched for by customers are
16043
- # examples of non-impacted products.
16044
- # Corresponds to the JSON property `impactedProducts`
16045
- # @return [Array<String>]
16046
- attr_accessor :impacted_products
16047
-
16048
- # List of all reasons the rule did not apply to the inapplicable products during
16049
- # the specified reporting period.
16050
- # Corresponds to the JSON property `inapplicabilityDetails`
16051
- # @return [Array<Google::Apis::ContentV2_1::InapplicabilityDetails>]
16052
- attr_accessor :inapplicability_details
16053
-
16054
- # List of product ids that are inapplicable to this rule during this reporting
16055
- # period. To get the inapplicable reason for a specific product, see
16056
- # RepricingProductReport.
16057
- # Corresponds to the JSON property `inapplicableProducts`
16058
- # @return [Array<String>]
16059
- attr_accessor :inapplicable_products
16060
-
16061
- # Total unit count of impacted products ordered while the rule was active on the
16062
- # date of the report. This count includes all orders that were started while the
16063
- # rule was active, even if the rule was no longer active when the order was
16064
- # completed.
16065
- # Corresponds to the JSON property `orderItemCount`
16066
- # @return [Fixnum]
16067
- attr_accessor :order_item_count
16068
-
16069
- # Id of the Repricing rule for this report.
16070
- # Corresponds to the JSON property `ruleId`
16071
- # @return [String]
16072
- attr_accessor :rule_id
16073
-
16074
- # The price represented as a number and currency.
16075
- # Corresponds to the JSON property `totalGmv`
16076
- # @return [Google::Apis::ContentV2_1::PriceAmount]
16077
- attr_accessor :total_gmv
16078
-
16079
- # Type of the rule.
16080
- # Corresponds to the JSON property `type`
16081
- # @return [String]
16082
- attr_accessor :type
16083
-
16084
- def initialize(**args)
16085
- update!(**args)
16086
- end
16087
-
16088
- # Update properties of this object
16089
- def update!(**args)
16090
- @buybox_winning_rule_stats = args[:buybox_winning_rule_stats] if args.key?(:buybox_winning_rule_stats)
16091
- @date = args[:date] if args.key?(:date)
16092
- @impacted_products = args[:impacted_products] if args.key?(:impacted_products)
16093
- @inapplicability_details = args[:inapplicability_details] if args.key?(:inapplicability_details)
16094
- @inapplicable_products = args[:inapplicable_products] if args.key?(:inapplicable_products)
16095
- @order_item_count = args[:order_item_count] if args.key?(:order_item_count)
16096
- @rule_id = args[:rule_id] if args.key?(:rule_id)
16097
- @total_gmv = args[:total_gmv] if args.key?(:total_gmv)
16098
- @type = args[:type] if args.key?(:type)
16099
- end
16100
- end
16101
-
16102
- # Stats specific to buybox winning rules for rule report.
16103
- class RepricingRuleReportBuyboxWinningRuleStats
16104
- include Google::Apis::Core::Hashable
16105
-
16106
- # Number of unique products that won the buybox with this rule during this
16107
- # period of time.
16108
- # Corresponds to the JSON property `buyboxWonProductCount`
16109
- # @return [Fixnum]
16110
- attr_accessor :buybox_won_product_count
16111
-
16112
- def initialize(**args)
16113
- update!(**args)
16114
- end
16115
-
16116
- # Update properties of this object
16117
- def update!(**args)
16118
- @buybox_won_product_count = args[:buybox_won_product_count] if args.key?(:buybox_won_product_count)
16119
- end
16120
- end
16121
-
16122
- # Definition of a rule restriction. At least one of the following needs to be
16123
- # true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3)
16124
- # floor.percentage_delta exists If floor.price_delta and floor.percentage_delta
16125
- # are both set on a rule, the highest value will be chosen by the Repricer. In
16126
- # other words, for a product with a price of $50, if the `floor.percentage_delta`
16127
- # is "-10" and the floor.price_delta is "-12", the offer price will only be
16128
- # lowered $5 (10% lower than the original offer price).
16129
- class RepricingRuleRestriction
16130
- include Google::Apis::Core::Hashable
16131
-
16132
- # Definition of a boundary.
16133
- # Corresponds to the JSON property `floor`
16134
- # @return [Google::Apis::ContentV2_1::RepricingRuleRestrictionBoundary]
16135
- attr_accessor :floor
16136
-
16137
- # If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of
16138
- # the rule. If use_auto_pricing_min_price is true, then only offers with `
16139
- # AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment,
16140
- # even if a floor value is set on the rule. Also, if use_auto_pricing_min_price
16141
- # is true, the floor restriction will be ignored.
16142
- # Corresponds to the JSON property `useAutoPricingMinPrice`
16143
- # @return [Boolean]
16144
- attr_accessor :use_auto_pricing_min_price
16145
- alias_method :use_auto_pricing_min_price?, :use_auto_pricing_min_price
16146
-
16147
- def initialize(**args)
16148
- update!(**args)
16149
- end
16150
-
16151
- # Update properties of this object
16152
- def update!(**args)
16153
- @floor = args[:floor] if args.key?(:floor)
16154
- @use_auto_pricing_min_price = args[:use_auto_pricing_min_price] if args.key?(:use_auto_pricing_min_price)
16155
- end
16156
- end
16157
-
16158
- # Definition of a boundary.
16159
- class RepricingRuleRestrictionBoundary
16160
- include Google::Apis::Core::Hashable
16161
-
16162
- # The percentage delta relative to the offer selling price. This field is signed.
16163
- # It must be negative in floor. When it is used in floor, it should be > -100.
16164
- # For example, if an offer is selling at $10 and this field is -30 in floor, the
16165
- # repricing rule only applies if the calculated new price is >= $7.
16166
- # Corresponds to the JSON property `percentageDelta`
16167
- # @return [Fixnum]
16168
- attr_accessor :percentage_delta
16169
-
16170
- # The price micros relative to the offer selling price. This field is signed. It
16171
- # must be negative in floor. For example, if an offer is selling at $10 and this
16172
- # field is -$2 in floor, the repricing rule only applies if the calculated new
16173
- # price is >= $8.
16174
- # Corresponds to the JSON property `priceDelta`
16175
- # @return [String]
16176
- attr_accessor :price_delta
16177
-
16178
- def initialize(**args)
16179
- update!(**args)
16180
- end
16181
-
16182
- # Update properties of this object
16183
- def update!(**args)
16184
- @percentage_delta = args[:percentage_delta] if args.key?(:percentage_delta)
16185
- @price_delta = args[:price_delta] if args.key?(:price_delta)
16186
- end
16187
- end
16188
-
16189
- # Definition of stats based rule.
16190
- class RepricingRuleStatsBasedRule
16191
- include Google::Apis::Core::Hashable
16192
-
16193
- # The percent change against the price target. Valid from 0 to 100 inclusively.
16194
- # Corresponds to the JSON property `percentageDelta`
16195
- # @return [Fixnum]
16196
- attr_accessor :percentage_delta
16197
-
16198
- # The price delta against the above price target. A positive value means the
16199
- # price should be adjusted to be above statistical measure, and a negative value
16200
- # means below. Currency code must not be included.
16201
- # Corresponds to the JSON property `priceDelta`
16202
- # @return [String]
16203
- attr_accessor :price_delta
16204
-
16205
- def initialize(**args)
16206
- update!(**args)
16207
- end
16208
-
16209
- # Update properties of this object
16210
- def update!(**args)
16211
- @percentage_delta = args[:percentage_delta] if args.key?(:percentage_delta)
16212
- @price_delta = args[:price_delta] if args.key?(:price_delta)
16213
- end
16214
- end
16215
-
16216
- # Request message for the RequestPhoneVerification method.
16217
- class RequestPhoneVerificationRequest
16218
- include Google::Apis::Core::Hashable
16219
-
16220
- # Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) (for
16221
- # example, en-US). Language code is used to provide localized `SMS` and `
16222
- # PHONE_CALL`. Default language used is en-US if not provided.
16223
- # Corresponds to the JSON property `languageCode`
16224
- # @return [String]
16225
- attr_accessor :language_code
16226
-
16227
- # Phone number to be verified.
16228
- # Corresponds to the JSON property `phoneNumber`
16229
- # @return [String]
16230
- attr_accessor :phone_number
16231
-
16232
- # Required. Two letter country code for the phone number, for example `CA` for
16233
- # Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/
16234
- # ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned
16235
- # codes.
16236
- # Corresponds to the JSON property `phoneRegionCode`
16237
- # @return [String]
16238
- attr_accessor :phone_region_code
16239
-
16240
- # Verification method to receive verification code.
16241
- # Corresponds to the JSON property `phoneVerificationMethod`
16242
- # @return [String]
16243
- attr_accessor :phone_verification_method
16244
-
16245
- def initialize(**args)
16246
- update!(**args)
16247
- end
16248
-
16249
- # Update properties of this object
16250
- def update!(**args)
16251
- @language_code = args[:language_code] if args.key?(:language_code)
16252
- @phone_number = args[:phone_number] if args.key?(:phone_number)
16253
- @phone_region_code = args[:phone_region_code] if args.key?(:phone_region_code)
16254
- @phone_verification_method = args[:phone_verification_method] if args.key?(:phone_verification_method)
16255
- end
16256
- end
16257
-
16258
- # Response message for the RequestPhoneVerification method.
16259
- class RequestPhoneVerificationResponse
16260
- include Google::Apis::Core::Hashable
16261
-
16262
- # The verification ID to use in subsequent calls to `verifyphonenumber`.
16263
- # Corresponds to the JSON property `verificationId`
16264
- # @return [String]
16265
- attr_accessor :verification_id
16266
-
16267
- def initialize(**args)
16268
- update!(**args)
16269
- end
16270
-
16271
- # Update properties of this object
16272
- def update!(**args)
16273
- @verification_id = args[:verification_id] if args.key?(:verification_id)
16274
- end
16275
- end
16276
-
16277
- # Request message for the RequestReviewProgram method.
16278
- class RequestReviewBuyOnGoogleProgramRequest
16279
- include Google::Apis::Core::Hashable
16280
-
16281
- def initialize(**args)
16282
- update!(**args)
16283
- end
16284
-
16285
- # Update properties of this object
16286
- def update!(**args)
16287
- end
16288
- end
16289
-
16290
- # Request message for the RequestReviewFreeListings Program method.
16291
- class RequestReviewFreeListingsRequest
16292
- include Google::Apis::Core::Hashable
16293
-
16294
- # The code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
16295
- # of the country for which review is to be requested.
16296
- # Corresponds to the JSON property `regionCode`
16297
- # @return [String]
16298
- attr_accessor :region_code
16299
-
16300
- def initialize(**args)
16301
- update!(**args)
16302
- end
16365
+ def initialize(**args)
16366
+ update!(**args)
16367
+ end
16303
16368
 
16304
16369
  # Update properties of this object
16305
16370
  def update!(**args)
@@ -17253,8 +17318,8 @@ module Google
17253
17318
  class SearchRequest
17254
17319
  include Google::Apis::Core::Hashable
17255
17320
 
17256
- # Number of ReportRows to retrieve in a single page. Defaults to the maximum of
17257
- # 1000. Values above 1000 are coerced to 1000.
17321
+ # Number of ReportRows to retrieve in a single page. Defaults to 1000. Values
17322
+ # above 5000 are coerced to 5000.
17258
17323
  # Corresponds to the JSON property `pageSize`
17259
17324
  # @return [Fixnum]
17260
17325
  attr_accessor :page_size
@@ -18995,6 +19060,37 @@ module Google
18995
19060
  end
18996
19061
  end
18997
19062
 
19063
+ # Block of text that may contain a tooltip with more information.
19064
+ class TextWithTooltip
19065
+ include Google::Apis::Core::Hashable
19066
+
19067
+ # Value of the tooltip as a simple text.
19068
+ # Corresponds to the JSON property `simpleTooltipValue`
19069
+ # @return [String]
19070
+ attr_accessor :simple_tooltip_value
19071
+
19072
+ # Value of the message as a simple text.
19073
+ # Corresponds to the JSON property `simpleValue`
19074
+ # @return [String]
19075
+ attr_accessor :simple_value
19076
+
19077
+ # The suggested type of an icon for tooltip, if a tooltip is present.
19078
+ # Corresponds to the JSON property `tooltipIconStyle`
19079
+ # @return [String]
19080
+ attr_accessor :tooltip_icon_style
19081
+
19082
+ def initialize(**args)
19083
+ update!(**args)
19084
+ end
19085
+
19086
+ # Update properties of this object
19087
+ def update!(**args)
19088
+ @simple_tooltip_value = args[:simple_tooltip_value] if args.key?(:simple_tooltip_value)
19089
+ @simple_value = args[:simple_value] if args.key?(:simple_value)
19090
+ @tooltip_icon_style = args[:tooltip_icon_style] if args.key?(:tooltip_icon_style)
19091
+ end
19092
+ end
19093
+
18998
19094
  # A message that represents a time period.
18999
19095
  class TimePeriod
19000
19096
  include Google::Apis::Core::Hashable
@@ -19046,6 +19142,99 @@ module Google
19046
19142
  end
19047
19143
  end
19048
19144
 
19145
+ # Topic trends fields requested by the merchant in the query. Field values are
19146
+ # only set if the merchant queries `TopicTrendsView`. Forecast data can be
19147
+ # queried up to 13 weeks by passing a future date in the `date` field.
19148
+ # Historical data is measured daily, and forecasted data is projected weekly.
19149
+ # All data points are normalized based on the highest data points returned in
19150
+ # the response. If you make separate queries with different date ranges, you
19151
+ # might see different values for the same date in each response. The recommended
19152
+ # way to get a trend score of a topic is `last7_days_search_interest / last`$day`
19153
+ # _days_search_interest - 1`. You can view trends for up to eight topics at a
19154
+ # time.
19155
+ class TopicTrends
19156
+ include Google::Apis::Core::Hashable
19157
+
19158
+ # Country trends are calculated for. Must be a two-letter country code (ISO 3166-
19159
+ # 1-alpha-2 code), for example, `“US”`.
19160
+ # Corresponds to the JSON property `customerCountryCode`
19161
+ # @return [String]
19162
+ attr_accessor :customer_country_code
19163
+
19164
+ # Represents a whole or partial calendar date, such as a birthday. The time of
19165
+ # day and time zone are either specified elsewhere or are insignificant. The
19166
+ # date is relative to the Gregorian Calendar. This can represent one of the
19167
+ # following: * A full date, with non-zero year, month, and day values. * A month
19168
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
19169
+ # with a zero month and a zero day. * A year and month, with a zero day (for
19170
+ # example, a credit card expiration date). Related types: * google.type.
19171
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
19172
+ # Corresponds to the JSON property `date`
19173
+ # @return [Google::Apis::ContentV2_1::Date]
19174
+ attr_accessor :date
19175
+
19176
+ # Search interest in the last 120 days, with the same normalization as
19177
+ # search_interest. This field is only present for a past date.
19178
+ # Corresponds to the JSON property `last120DaysSearchInterest`
19179
+ # @return [Float]
19180
+ attr_accessor :last120_days_search_interest
19181
+
19182
+ # Search interest in the last 30 days, with the same normalization as
19183
+ # search_interest. This field is only present for a past date.
19184
+ # Corresponds to the JSON property `last30DaysSearchInterest`
19185
+ # @return [Float]
19186
+ attr_accessor :last30_days_search_interest
19187
+
19188
+ # Search interest in the last 7 days, with the same normalization as
19189
+ # search_interest. This field is only present for a past date.
19190
+ # Corresponds to the JSON property `last7DaysSearchInterest`
19191
+ # @return [Float]
19192
+ attr_accessor :last7_days_search_interest
19193
+
19194
+ # Search interest in the last 90 days, with the same normalization as
19195
+ # search_interest. This field is only present for a past date.
19196
+ # Corresponds to the JSON property `last90DaysSearchInterest`
19197
+ # @return [Float]
19198
+ attr_accessor :last90_days_search_interest
19199
+
19200
+ # Estimated search interest in the next 7 days, with the same normalization as
19201
+ # search_interest. This field is only present for a future date.
19202
+ # Corresponds to the JSON property `next7DaysSearchInterest`
19203
+ # @return [Float]
19204
+ attr_accessor :next7_days_search_interest
19205
+
19206
+ # Daily search interest, normalized to the time and country to make comparisons
19207
+ # easier, with 100 representing peak popularity (from 0 to 100) for the
19208
+ # requested time period and location.
19209
+ # Corresponds to the JSON property `searchInterest`
19210
+ # @return [Float]
19211
+ attr_accessor :search_interest
19212
+
19213
+ # Google-provided topic trends are calculated for. Only top eight topics are
19214
+ # returned. Topic is what shoppers are searching for on Google, grouped by the
19215
+ # same concept.
19216
+ # Corresponds to the JSON property `topic`
19217
+ # @return [String]
19218
+ attr_accessor :topic
19219
+
19220
+ def initialize(**args)
19221
+ update!(**args)
19222
+ end
19223
+
19224
+ # Update properties of this object
19225
+ def update!(**args)
19226
+ @customer_country_code = args[:customer_country_code] if args.key?(:customer_country_code)
19227
+ @date = args[:date] if args.key?(:date)
19228
+ @last120_days_search_interest = args[:last120_days_search_interest] if args.key?(:last120_days_search_interest)
19229
+ @last30_days_search_interest = args[:last30_days_search_interest] if args.key?(:last30_days_search_interest)
19230
+ @last7_days_search_interest = args[:last7_days_search_interest] if args.key?(:last7_days_search_interest)
19231
+ @last90_days_search_interest = args[:last90_days_search_interest] if args.key?(:last90_days_search_interest)
19232
+ @next7_days_search_interest = args[:next7_days_search_interest] if args.key?(:next7_days_search_interest)
19233
+ @search_interest = args[:search_interest] if args.key?(:search_interest)
19234
+ @topic = args[:topic] if args.key?(:topic)
19235
+ end
19236
+ end
19237
+
19049
19238
  #
19050
19239
  class TransitTable
19051
19240
  include Google::Apis::Core::Hashable
@@ -19125,6 +19314,52 @@ module Google
19125
19314
  end
19126
19315
  end
19127
19316
 
19317
+ # The payload for the triggered action.
19318
+ class TriggerActionPayload
19319
+ include Google::Apis::Core::Hashable
19320
+
19321
+ # Required. The context from the selected action. The value is obtained from
19322
+ # rendered issues and needs to be sent back to identify the action that is being
19323
+ # triggered.
19324
+ # Corresponds to the JSON property `actionContext`
19325
+ # @return [String]
19326
+ attr_accessor :action_context
19327
+
19328
+ # Input provided by the merchant.
19329
+ # Corresponds to the JSON property `actionInput`
19330
+ # @return [Google::Apis::ContentV2_1::ActionInput]
19331
+ attr_accessor :action_input
19332
+
19333
+ def initialize(**args)
19334
+ update!(**args)
19335
+ end
19336
+
19337
+ # Update properties of this object
19338
+ def update!(**args)
19339
+ @action_context = args[:action_context] if args.key?(:action_context)
19340
+ @action_input = args[:action_input] if args.key?(:action_input)
19341
+ end
19342
+ end
19343
+
19344
+ # Response informing about the started action.
19345
+ class TriggerActionResponse
19346
+ include Google::Apis::Core::Hashable
19347
+
19348
+ # The message for merchant.
19349
+ # Corresponds to the JSON property `message`
19350
+ # @return [String]
19351
+ attr_accessor :message
19352
+
19353
+ def initialize(**args)
19354
+ update!(**args)
19355
+ end
19356
+
19357
+ # Update properties of this object
19358
+ def update!(**args)
19359
+ @message = args[:message] if args.key?(:message)
19360
+ end
19361
+ end
19362
+
19128
19363
  # Request message for the UndeleteConversionSource method.
19129
19364
  class UndeleteConversionSourceRequest
19130
19365
  include Google::Apis::Core::Hashable