google-apis-merchantapi_accounts_v1beta 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,33 +22,6 @@ module Google
22
22
  module Apis
23
23
  module MerchantapiAccountsV1beta
24
24
 
25
- # Reference to a Terms of Service resource.
26
- class AcceptTermsOfService
27
- include Google::Apis::Core::Hashable
28
-
29
- # Required. The resource name of the terms of service version.
30
- # Corresponds to the JSON property `name`
31
- # @return [String]
32
- attr_accessor :name
33
-
34
- # Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is
35
- # either a country when the ToS applies specifically to that country or `001`
36
- # when it applies globally.
37
- # Corresponds to the JSON property `regionCode`
38
- # @return [String]
39
- attr_accessor :region_code
40
-
41
- def initialize(**args)
42
- update!(**args)
43
- end
44
-
45
- # Update properties of this object
46
- def update!(**args)
47
- @name = args[:name] if args.key?(:name)
48
- @region_code = args[:region_code] if args.key?(:region_code)
49
- end
50
- end
51
-
52
25
  # Describes the accepted terms of service.
53
26
  class Accepted
54
27
  include Google::Apis::Core::Hashable
@@ -89,7 +62,15 @@ module Google
89
62
  end
90
63
  end
91
64
 
92
- # An account.
65
+ # The `Account` message represents a merchant's account within Shopping Ads. It'
66
+ # s the primary entity for managing product data, settings, and interactions
67
+ # with Google's services and external providers. Accounts can operate as
68
+ # standalone entities or be part of a multi-client account (MCA) structure. In
69
+ # an MCA setup the parent account manages multiple sub-accounts. Establishing an
70
+ # account involves configuring attributes like the account name, time zone, and
71
+ # language preferences. The `Account` message is the parent entity for many
72
+ # other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo`
73
+ # and so on.
93
74
  class Account
94
75
  include Google::Apis::Core::Hashable
95
76
 
@@ -150,6 +131,19 @@ module Google
150
131
  end
151
132
  end
152
133
 
134
+ # `AccountAggregation` payload.
135
+ class AccountAggregation
136
+ include Google::Apis::Core::Hashable
137
+
138
+ def initialize(**args)
139
+ update!(**args)
140
+ end
141
+
142
+ # Update properties of this object
143
+ def update!(**args)
144
+ end
145
+ end
146
+
153
147
  # An [`AccountIssue`](https://support.google.com/merchants/answer/12153802?sjid=
154
148
  # 17798438912526418908-EU#account).
155
149
  class AccountIssue
@@ -202,52 +196,18 @@ module Google
202
196
  end
203
197
  end
204
198
 
205
- # The tax settings of a merchant account. All methods require the admin role.
206
- class AccountTax
207
- include Google::Apis::Core::Hashable
208
-
209
- # Output only. The ID of the account to which these account tax settings belong.
210
- # Corresponds to the JSON property `account`
211
- # @return [Fixnum]
212
- attr_accessor :account
213
-
214
- # Identifier. The name of the tax setting. Format: "`account_tax.name=accounts/`
215
- # account``"
216
- # Corresponds to the JSON property `name`
217
- # @return [String]
218
- attr_accessor :name
219
-
220
- # Tax rules. "Define the tax rules in each region. No tax will be presented if a
221
- # region has no rule."
222
- # Corresponds to the JSON property `taxRules`
223
- # @return [Array<Google::Apis::MerchantapiAccountsV1beta::TaxRule>]
224
- attr_accessor :tax_rules
225
-
226
- def initialize(**args)
227
- update!(**args)
228
- end
229
-
230
- # Update properties of this object
231
- def update!(**args)
232
- @account = args[:account] if args.key?(:account)
233
- @name = args[:name] if args.key?(:name)
234
- @tax_rules = args[:tax_rules] if args.key?(:tax_rules)
235
- end
236
- end
237
-
238
199
  # Additional instructions to add account services during creation of the account.
239
200
  class AddAccountService
240
201
  include Google::Apis::Core::Hashable
241
202
 
242
- # A generic empty message that you can re-use to avoid defining duplicated empty
243
- # messages in your APIs. A typical example is to use it as the request or the
244
- # response type of an API method. For instance: service Foo ` rpc Bar(google.
245
- # protobuf.Empty) returns (google.protobuf.Empty); `
203
+ # `AccountAggregation` payload.
246
204
  # Corresponds to the JSON property `accountAggregation`
247
- # @return [Google::Apis::MerchantapiAccountsV1beta::Empty]
205
+ # @return [Google::Apis::MerchantapiAccountsV1beta::AccountAggregation]
248
206
  attr_accessor :account_aggregation
249
207
 
250
- # Optional. The provider of the service. Format: `accounts/`account``
208
+ # Required. The provider of the service. Either the reference to an account such
209
+ # as `providers/123` or a well-known service provider (one of `providers/
210
+ # GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
251
211
  # Corresponds to the JSON property `provider`
252
212
  # @return [String]
253
213
  attr_accessor :provider
@@ -309,6 +269,48 @@ module Google
309
269
  end
310
270
  end
311
271
 
272
+ # Collection of information related to the [autofeed](https://support.google.com/
273
+ # merchants/answer/7538732) settings.
274
+ class AutofeedSettings
275
+ include Google::Apis::Core::Hashable
276
+
277
+ # Output only. Determines whether merchant is eligible for being enrolled into
278
+ # an autofeed.
279
+ # Corresponds to the JSON property `eligible`
280
+ # @return [Boolean]
281
+ attr_accessor :eligible
282
+ alias_method :eligible?, :eligible
283
+
284
+ # Required. Enables or disables product crawling through the autofeed for the
285
+ # given account. Autofeed accounts must meet [certain conditions](https://
286
+ # support.google.com/merchants/answer/7538732#
287
+ # Configure_automated_feeds_Standard_Experience), which can be checked through
288
+ # the `eligible` field. The account must **not** be a marketplace. When the
289
+ # autofeed is enabled for the first time, the products usually appear instantly.
290
+ # When re-enabling, it might take up to 24 hours for products to appear.
291
+ # Corresponds to the JSON property `enableProducts`
292
+ # @return [Boolean]
293
+ attr_accessor :enable_products
294
+ alias_method :enable_products?, :enable_products
295
+
296
+ # Identifier. The resource name of the autofeed settings. Format: `accounts/`
297
+ # account`/autofeedSettings`.
298
+ # Corresponds to the JSON property `name`
299
+ # @return [String]
300
+ attr_accessor :name
301
+
302
+ def initialize(**args)
303
+ update!(**args)
304
+ end
305
+
306
+ # Update properties of this object
307
+ def update!(**args)
308
+ @eligible = args[:eligible] if args.key?(:eligible)
309
+ @enable_products = args[:enable_products] if args.key?(:enable_products)
310
+ @name = args[:name] if args.key?(:name)
311
+ end
312
+ end
313
+
312
314
  # Business days of the warehouse.
313
315
  class BusinessDayConfig
314
316
  include Google::Apis::Core::Hashable
@@ -349,7 +351,7 @@ module Google
349
351
  # @return [String]
350
352
  attr_accessor :name
351
353
 
352
- # Optional. Whether the identity attributes may be used for promotions.
354
+ # Required. Whether the identity attributes may be used for promotions.
353
355
  # Corresponds to the JSON property `promotionsConsent`
354
356
  # @return [String]
355
357
  attr_accessor :promotions_consent
@@ -385,20 +387,22 @@ module Google
385
387
  end
386
388
  end
387
389
 
388
- # Collection of information related to a business.
390
+ # The `BusinessInfo` message contains essential information about a merchant's
391
+ # business. This message captures key business details such as physical address,
392
+ # customer service contacts, and region-specific identifiers.
389
393
  class BusinessInfo
390
394
  include Google::Apis::Core::Hashable
391
395
 
392
- # Represents a postal address, e.g. for postal delivery or payments addresses.
393
- # Given a postal address, a postal service can deliver items to a premise, P.O.
394
- # Box or similar. It is not intended to model geographical locations (roads,
395
- # towns, mountains). In typical usage an address would be created via user input
396
- # or from importing existing data, depending on the type of process. Advice on
397
- # address input / editing: - Use an internationalization-ready address widget
398
- # such as https://github.com/google/libaddressinput) - Users should not be
399
- # presented with UI elements for input or editing of fields outside countries
400
- # where that field is used. For more guidance on how to use this schema, please
401
- # see: https://support.google.com/business/answer/6397478
396
+ # Represents a postal address. For example for postal delivery or payments
397
+ # addresses. Given a postal address, a postal service can deliver items to a
398
+ # premise, P.O. Box or similar. It is not intended to model geographical
399
+ # locations (roads, towns, mountains). In typical usage an address would be
400
+ # created by user input or from importing existing data, depending on the type
401
+ # of process. Advice on address input / editing: - Use an internationalization-
402
+ # ready address widget such as https://github.com/google/libaddressinput) -
403
+ # Users should not be presented with UI elements for input or editing of fields
404
+ # outside countries where that field is used. For more guidance on how to use
405
+ # this schema, see: https://support.google.com/business/answer/6397478
402
406
  # Corresponds to the JSON property `address`
403
407
  # @return [Google::Apis::MerchantapiAccountsV1beta::PostalAddress]
404
408
  attr_accessor :address
@@ -408,6 +412,13 @@ module Google
408
412
  # @return [Google::Apis::MerchantapiAccountsV1beta::CustomerService]
409
413
  attr_accessor :customer_service
410
414
 
415
+ # Optional. The 10-digit [Korean business registration number](https://support.
416
+ # google.com/merchants/answer/9037766) separated with dashes in the format: XXX-
417
+ # XX-XXXXX.
418
+ # Corresponds to the JSON property `koreanBusinessRegistrationNumber`
419
+ # @return [String]
420
+ attr_accessor :korean_business_registration_number
421
+
411
422
  # Identifier. The resource name of the business info. Format: `accounts/`account`
412
423
  # /businessInfo`
413
424
  # Corresponds to the JSON property `name`
@@ -444,6 +455,7 @@ module Google
444
455
  def update!(**args)
445
456
  @address = args[:address] if args.key?(:address)
446
457
  @customer_service = args[:customer_service] if args.key?(:customer_service)
458
+ @korean_business_registration_number = args[:korean_business_registration_number] if args.key?(:korean_business_registration_number)
447
459
  @name = args[:name] if args.key?(:name)
448
460
  @phone = args[:phone] if args.key?(:phone)
449
461
  @phone_verification_state = args[:phone_verification_state] if args.key?(:phone_verification_state)
@@ -451,7 +463,10 @@ module Google
451
463
  end
452
464
 
453
465
  # A list of carrier rates that can be referred to by `main_table` or `
454
- # single_value`.
466
+ # single_value`. Supported carrier services are defined in https://support.
467
+ # google.com/merchants/answer/12577710?ref_topic=12570808&sjid=
468
+ # 10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-
469
+ # uk-and-us-only.
455
470
  class CarrierRate
456
471
  include Google::Apis::Core::Hashable
457
472
 
@@ -506,12 +521,21 @@ module Google
506
521
  class ClaimHomepageRequest
507
522
  include Google::Apis::Core::Hashable
508
523
 
524
+ # Optional. When set to `true`, this option removes any existing claim on the
525
+ # requested website and replaces it with a claim from the account that makes the
526
+ # request.
527
+ # Corresponds to the JSON property `overwrite`
528
+ # @return [Boolean]
529
+ attr_accessor :overwrite
530
+ alias_method :overwrite?, :overwrite
531
+
509
532
  def initialize(**args)
510
533
  update!(**args)
511
534
  end
512
535
 
513
536
  # Update properties of this object
514
537
  def update!(**args)
538
+ @overwrite = args[:overwrite] if args.key?(:overwrite)
515
539
  end
516
540
  end
517
541
 
@@ -519,18 +543,25 @@ module Google
519
543
  class CreateAndConfigureAccountRequest
520
544
  include Google::Apis::Core::Hashable
521
545
 
522
- # Reference to a Terms of Service resource.
523
- # Corresponds to the JSON property `acceptTermsOfService`
524
- # @return [Google::Apis::MerchantapiAccountsV1beta::AcceptTermsOfService]
525
- attr_accessor :accept_terms_of_service
526
-
527
- # An account.
546
+ # The `Account` message represents a merchant's account within Shopping Ads. It'
547
+ # s the primary entity for managing product data, settings, and interactions
548
+ # with Google's services and external providers. Accounts can operate as
549
+ # standalone entities or be part of a multi-client account (MCA) structure. In
550
+ # an MCA setup the parent account manages multiple sub-accounts. Establishing an
551
+ # account involves configuring attributes like the account name, time zone, and
552
+ # language preferences. The `Account` message is the parent entity for many
553
+ # other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo`
554
+ # and so on.
528
555
  # Corresponds to the JSON property `account`
529
556
  # @return [Google::Apis::MerchantapiAccountsV1beta::Account]
530
557
  attr_accessor :account
531
558
 
532
- # Optional. If specified, an account service between the account to be created
533
- # and the provider account is initialized as part of the creation.
559
+ # Required. An account service between the account to be created and the
560
+ # provider account is initialized as part of the creation. At least one such
561
+ # service needs to be provided. Currently exactly one of these needs to be `
562
+ # account_aggregation`, which means you can only create sub accounts, not
563
+ # standalone account through this method. Additional `account_management` or `
564
+ # product_management` services may be provided.
534
565
  # Corresponds to the JSON property `service`
535
566
  # @return [Array<Google::Apis::MerchantapiAccountsV1beta::AddAccountService>]
536
567
  attr_accessor :service
@@ -546,7 +577,6 @@ module Google
546
577
 
547
578
  # Update properties of this object
548
579
  def update!(**args)
549
- @accept_terms_of_service = args[:accept_terms_of_service] if args.key?(:accept_terms_of_service)
550
580
  @account = args[:account] if args.key?(:account)
551
581
  @service = args[:service] if args.key?(:service)
552
582
  @users = args[:users] if args.key?(:users)
@@ -563,7 +593,10 @@ module Google
563
593
  # @return [String]
564
594
  attr_accessor :parent
565
595
 
566
- # A [user](https://support.google.com/merchants/answer/12160472).
596
+ # The `User` message represents a user associated with a Merchant Center account.
597
+ # It is used to manage user permissions and access rights within the account.
598
+ # For more information, see [Frequently asked questions about people and access
599
+ # levels](//support.google.com/merchants/answer/12160472).
567
600
  # Corresponds to the JSON property `user`
568
601
  # @return [Google::Apis::MerchantapiAccountsV1beta::User]
569
602
  attr_accessor :user
@@ -759,7 +792,8 @@ module Google
759
792
 
760
793
  # Maximum number of business days spent before an order is shipped. 0 means same
761
794
  # day shipped, 1 means next day shipped. Must be greater than or equal to `
762
- # min_handling_days`.
795
+ # min_handling_days`. 'min_handling_days' and 'max_handling_days' should be
796
+ # either set or not set at the same time.
763
797
  # Corresponds to the JSON property `maxHandlingDays`
764
798
  # @return [Fixnum]
765
799
  attr_accessor :max_handling_days
@@ -772,7 +806,8 @@ module Google
772
806
  attr_accessor :max_transit_days
773
807
 
774
808
  # Minimum number of business days spent before an order is shipped. 0 means same
775
- # day shipped, 1 means next day shipped.
809
+ # day shipped, 1 means next day shipped. 'min_handling_days' and '
810
+ # max_handling_days' should be either set or not set at the same time.
776
811
  # Corresponds to the JSON property `minHandlingDays`
777
812
  # @return [Fixnum]
778
813
  attr_accessor :min_handling_days
@@ -1002,7 +1037,12 @@ module Google
1002
1037
  end
1003
1038
  end
1004
1039
 
1005
- # A store's homepage.
1040
+ # The `Homepage` message represents a merchant's store homepage within the
1041
+ # system. A merchant's homepage is the primary domain where customers interact
1042
+ # with their store. The homepage can be claimed and verified as a proof of
1043
+ # ownership and allows the merchant to unlock features that require a verified
1044
+ # website. For more information, see [Understanding online store URL
1045
+ # verification](//support.google.com/merchants/answer/176793).
1006
1046
  class Homepage
1007
1047
  include Google::Apis::Core::Hashable
1008
1048
 
@@ -1105,36 +1145,6 @@ module Google
1105
1145
  end
1106
1146
  end
1107
1147
 
1108
- # Represents a time interval, encoded as a Timestamp start (inclusive) and a
1109
- # Timestamp end (exclusive). The start must be less than or equal to the end.
1110
- # When the start equals the end, the interval is empty (matches no time). When
1111
- # both start and end are unspecified, the interval matches any time.
1112
- class Interval
1113
- include Google::Apis::Core::Hashable
1114
-
1115
- # Optional. Exclusive end of the interval. If specified, a Timestamp matching
1116
- # this interval will have to be before the end.
1117
- # Corresponds to the JSON property `endTime`
1118
- # @return [String]
1119
- attr_accessor :end_time
1120
-
1121
- # Optional. Inclusive start of the interval. If specified, a Timestamp matching
1122
- # this interval will have to be the same or after the start.
1123
- # Corresponds to the JSON property `startTime`
1124
- # @return [String]
1125
- attr_accessor :start_time
1126
-
1127
- def initialize(**args)
1128
- update!(**args)
1129
- end
1130
-
1131
- # Update properties of this object
1132
- def update!(**args)
1133
- @end_time = args[:end_time] if args.key?(:end_time)
1134
- @start_time = args[:start_time] if args.key?(:start_time)
1135
- end
1136
- end
1137
-
1138
1148
  # Response message for the `ListAccountIssues` method.
1139
1149
  class ListAccountIssuesResponse
1140
1150
  include Google::Apis::Core::Hashable
@@ -1161,32 +1171,6 @@ module Google
1161
1171
  end
1162
1172
  end
1163
1173
 
1164
- # Response to account tax list request This method can only be called on a multi-
1165
- # client account, otherwise it'll return an error.
1166
- class ListAccountTaxResponse
1167
- include Google::Apis::Core::Hashable
1168
-
1169
- # Page of accounttax settings
1170
- # Corresponds to the JSON property `accountTaxes`
1171
- # @return [Array<Google::Apis::MerchantapiAccountsV1beta::AccountTax>]
1172
- attr_accessor :account_taxes
1173
-
1174
- # The token for the retrieval of the next page of account tax settings.
1175
- # Corresponds to the JSON property `nextPageToken`
1176
- # @return [String]
1177
- attr_accessor :next_page_token
1178
-
1179
- def initialize(**args)
1180
- update!(**args)
1181
- end
1182
-
1183
- # Update properties of this object
1184
- def update!(**args)
1185
- @account_taxes = args[:account_taxes] if args.key?(:account_taxes)
1186
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1187
- end
1188
- end
1189
-
1190
1174
  # Response message for the `ListAccounts` method.
1191
1175
  class ListAccountsResponse
1192
1176
  include Google::Apis::Core::Hashable
@@ -1482,8 +1466,8 @@ module Google
1482
1466
  attr_accessor :accept_exchange
1483
1467
  alias_method :accept_exchange?, :accept_exchange
1484
1468
 
1485
- # The countries of sale where the return policy applies. The values must be a
1486
- # valid 2 letter ISO 3166 code.
1469
+ # Required. Immutable. The countries of sale where the return policy applies.
1470
+ # The values must be a valid 2 letter ISO 3166 code.
1487
1471
  # Corresponds to the JSON property `countries`
1488
1472
  # @return [Array<String>]
1489
1473
  attr_accessor :countries
@@ -1494,13 +1478,13 @@ module Google
1494
1478
  # @return [Array<String>]
1495
1479
  attr_accessor :item_conditions
1496
1480
 
1497
- # This field represents the unique user-defined label of the return policy. It
1498
- # is important to note that the same label cannot be used in different return
1499
- # policies for the same country. Unless a product specifies a specific label
1500
- # attribute, policies will be automatically labeled as 'default'. To assign a
1501
- # custom return policy to certain product groups, follow the instructions
1502
- # provided in the [Return policy label] (https://support.google.com/merchants/
1503
- # answer/9445425). The label can contain up to 50 characters.
1481
+ # Required. Immutable. This field represents the unique user-defined label of
1482
+ # the return policy. It is important to note that the same label cannot be used
1483
+ # in different return policies for the same country. Unless a product specifies
1484
+ # a specific label attribute, policies will be automatically labeled as 'default'
1485
+ # . To assign a custom return policy to certain product groups, follow the
1486
+ # instructions provided in the [Return policy label] (https://support.google.com/
1487
+ # merchants/answer/9445425). The label can contain up to 50 characters.
1504
1488
  # Corresponds to the JSON property `label`
1505
1489
  # @return [String]
1506
1490
  attr_accessor :label
@@ -1538,8 +1522,8 @@ module Google
1538
1522
  # @return [String]
1539
1523
  attr_accessor :return_policy_id
1540
1524
 
1541
- # The return policy uri. This can used by Google to do a sanity check for the
1542
- # policy. It must be a valid URL.
1525
+ # Required. The return policy uri. This can used by Google to do a sanity check
1526
+ # for the policy. It must be a valid URL.
1543
1527
  # Corresponds to the JSON property `returnPolicyUri`
1544
1528
  # @return [String]
1545
1529
  attr_accessor :return_policy_uri
@@ -1591,9 +1575,9 @@ module Google
1591
1575
  # The phone number, represented as a leading plus sign ('+'), followed by a
1592
1576
  # phone number that uses a relaxed ITU E.164 format consisting of the country
1593
1577
  # calling code (1 to 3 digits) and the subscriber number, with no additional
1594
- # spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555)
1595
- # 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in
1596
- # practice not all countries respect that, so we relax that restriction here.
1578
+ # spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (
1579
+ # 555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but
1580
+ # in practice not all countries respect that, so we relax that restriction here.
1597
1581
  # National-only numbers are not allowed. References: - https://www.itu.int/rec/T-
1598
1582
  # REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.
1599
1583
  # wikipedia.org/wiki/List_of_country_calling_codes
@@ -1614,12 +1598,12 @@ module Google
1614
1598
 
1615
1599
  # An object representing a short code, which is a phone number that is typically
1616
1600
  # much shorter than regular phone numbers and can be used to address messages in
1617
- # MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see
1618
- # how many minutes you have remaining on your plan."). Short codes are
1601
+ # MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611
1602
+ # to see how many minutes you have remaining on your plan."). Short codes are
1619
1603
  # restricted to a region and are not internationally dialable, which means the
1620
1604
  # same short code can exist in different regions, with different usage and
1621
- # pricing, even if those regions share the same country calling code (e.g. US
1622
- # and CA).
1605
+ # pricing, even if those regions share the same country calling code (For
1606
+ # example: US and CA).
1623
1607
  # Corresponds to the JSON property `shortCode`
1624
1608
  # @return [Google::Apis::MerchantapiAccountsV1beta::ShortCode]
1625
1609
  attr_accessor :short_code
@@ -1663,35 +1647,36 @@ module Google
1663
1647
  end
1664
1648
  end
1665
1649
 
1666
- # Represents a postal address, e.g. for postal delivery or payments addresses.
1667
- # Given a postal address, a postal service can deliver items to a premise, P.O.
1668
- # Box or similar. It is not intended to model geographical locations (roads,
1669
- # towns, mountains). In typical usage an address would be created via user input
1670
- # or from importing existing data, depending on the type of process. Advice on
1671
- # address input / editing: - Use an internationalization-ready address widget
1672
- # such as https://github.com/google/libaddressinput) - Users should not be
1673
- # presented with UI elements for input or editing of fields outside countries
1674
- # where that field is used. For more guidance on how to use this schema, please
1675
- # see: https://support.google.com/business/answer/6397478
1650
+ # Represents a postal address. For example for postal delivery or payments
1651
+ # addresses. Given a postal address, a postal service can deliver items to a
1652
+ # premise, P.O. Box or similar. It is not intended to model geographical
1653
+ # locations (roads, towns, mountains). In typical usage an address would be
1654
+ # created by user input or from importing existing data, depending on the type
1655
+ # of process. Advice on address input / editing: - Use an internationalization-
1656
+ # ready address widget such as https://github.com/google/libaddressinput) -
1657
+ # Users should not be presented with UI elements for input or editing of fields
1658
+ # outside countries where that field is used. For more guidance on how to use
1659
+ # this schema, see: https://support.google.com/business/answer/6397478
1676
1660
  class PostalAddress
1677
1661
  include Google::Apis::Core::Hashable
1678
1662
 
1679
1663
  # Unstructured address lines describing the lower levels of an address. Because
1680
1664
  # values in address_lines do not have type information and may sometimes contain
1681
- # multiple values in a single field (e.g. "Austin, TX"), it is important that
1682
- # the line order is clear. The order of address lines should be "envelope order"
1683
- # for the country/region of the address. In places where this can vary (e.g.
1684
- # Japan), address_language is used to make it explicit (e.g. "ja" for large-to-
1685
- # small ordering and "ja-Latn" or "en" for small-to-large). This way, the most
1686
- # specific line of an address can be selected based on the language. The minimum
1687
- # permitted structural representation of an address consists of a region_code
1688
- # with all remaining information placed in the address_lines. It would be
1689
- # possible to format such an address very approximately without geocoding, but
1690
- # no semantic reasoning could be made about any of the address components until
1691
- # it was at least partially resolved. Creating an address only containing a
1692
- # region_code and address_lines, and then geocoding is the recommended way to
1693
- # handle completely unstructured addresses (as opposed to guessing which parts
1694
- # of the address should be localities or administrative areas).
1665
+ # multiple values in a single field (For example "Austin, TX"), it is important
1666
+ # that the line order is clear. The order of address lines should be "envelope
1667
+ # order" for the country/region of the address. In places where this can vary (
1668
+ # For example Japan), address_language is used to make it explicit (For example "
1669
+ # ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large).
1670
+ # This way, the most specific line of an address can be selected based on the
1671
+ # language. The minimum permitted structural representation of an address
1672
+ # consists of a region_code with all remaining information placed in the
1673
+ # address_lines. It would be possible to format such an address very
1674
+ # approximately without geocoding, but no semantic reasoning could be made about
1675
+ # any of the address components until it was at least partially resolved.
1676
+ # Creating an address only containing a region_code and address_lines, and then
1677
+ # geocoding is the recommended way to handle completely unstructured addresses (
1678
+ # as opposed to guessing which parts of the address should be localities or
1679
+ # administrative areas).
1695
1680
  # Corresponds to the JSON property `addressLines`
1696
1681
  # @return [Array<String>]
1697
1682
  attr_accessor :address_lines
@@ -1699,9 +1684,9 @@ module Google
1699
1684
  # Optional. Highest administrative subdivision which is used for postal
1700
1685
  # addresses of a country or region. For example, this can be a state, a province,
1701
1686
  # an oblast, or a prefecture. Specifically, for Spain this is the province and
1702
- # not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many
1703
- # countries don't use an administrative area in postal addresses. E.g. in
1704
- # Switzerland this should be left unpopulated.
1687
+ # not the autonomous community (For example "Barcelona" and not "Catalonia").
1688
+ # Many countries don't use an administrative area in postal addresses. For
1689
+ # example in Switzerland this should be left unpopulated.
1705
1690
  # Corresponds to the JSON property `administrativeArea`
1706
1691
  # @return [String]
1707
1692
  attr_accessor :administrative_area
@@ -1733,8 +1718,8 @@ module Google
1733
1718
 
1734
1719
  # Optional. Postal code of the address. Not all countries use or require postal
1735
1720
  # codes to be present, but where they are used, they may trigger additional
1736
- # validation with other parts of the address (e.g. state/zip validation in the U.
1737
- # S.A.).
1721
+ # validation with other parts of the address (For example state/zip validation
1722
+ # in the U.S.A.).
1738
1723
  # Corresponds to the JSON property `postalCode`
1739
1724
  # @return [String]
1740
1725
  attr_accessor :postal_code
@@ -1763,9 +1748,9 @@ module Google
1763
1748
 
1764
1749
  # Optional. Additional, country-specific, sorting code. This is not used in most
1765
1750
  # regions. Where it is used, the value is either a string like "CEDEX",
1766
- # optionally followed by a number (e.g. "CEDEX 7"), or just a number alone,
1767
- # representing the "sector code" (Jamaica), "delivery area indicator" (Malawi)
1768
- # or "post office indicator" (e.g. Côte d'Ivoire).
1751
+ # optionally followed by a number (For example "CEDEX 7"), or just a number
1752
+ # alone, representing the "sector code" (Jamaica), "delivery area indicator" (
1753
+ # Malawi) or "post office indicator" (For example Côte d'Ivoire).
1769
1754
  # Corresponds to the JSON property `sortingCode`
1770
1755
  # @return [String]
1771
1756
  attr_accessor :sorting_code
@@ -1944,6 +1929,12 @@ module Google
1944
1929
  # @return [Array<Google::Apis::MerchantapiAccountsV1beta::ProductChange>]
1945
1930
  attr_accessor :changes
1946
1931
 
1932
+ # The product expiration time. This field will not bet set if the notification
1933
+ # is sent for a product deletion event.
1934
+ # Corresponds to the JSON property `expirationTime`
1935
+ # @return [String]
1936
+ attr_accessor :expiration_time
1937
+
1947
1938
  # The account that manages the merchant's account. can be the same as merchant
1948
1939
  # id if it is standalone account. Format : `accounts/`service_provider_id``
1949
1940
  # Corresponds to the JSON property `managingAccount`
@@ -1975,6 +1966,7 @@ module Google
1975
1966
  @account = args[:account] if args.key?(:account)
1976
1967
  @attribute = args[:attribute] if args.key?(:attribute)
1977
1968
  @changes = args[:changes] if args.key?(:changes)
1969
+ @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
1978
1970
  @managing_account = args[:managing_account] if args.key?(:managing_account)
1979
1971
  @resource = args[:resource] if args.key?(:resource)
1980
1972
  @resource_id = args[:resource_id] if args.key?(:resource_id)
@@ -2254,7 +2246,7 @@ module Google
2254
2246
  # @return [Google::Apis::MerchantapiAccountsV1beta::Price]
2255
2247
  attr_accessor :fixed_fee
2256
2248
 
2257
- # Type of return shipping fee.
2249
+ # Required. Type of return shipping fee.
2258
2250
  # Corresponds to the JSON property `type`
2259
2251
  # @return [String]
2260
2252
  attr_accessor :type
@@ -2376,8 +2368,8 @@ module Google
2376
2368
  end
2377
2369
  end
2378
2370
 
2379
- # The merchant account's [shipping setting]((https://support.google.com/
2380
- # merchants/answer/6069284).
2371
+ # The merchant account's [shipping setting](https://support.google.com/merchants/
2372
+ # answer/6069284).
2381
2373
  class ShippingSettings
2382
2374
  include Google::Apis::Core::Hashable
2383
2375
 
@@ -2426,17 +2418,17 @@ module Google
2426
2418
 
2427
2419
  # An object representing a short code, which is a phone number that is typically
2428
2420
  # much shorter than regular phone numbers and can be used to address messages in
2429
- # MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see
2430
- # how many minutes you have remaining on your plan."). Short codes are
2421
+ # MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611
2422
+ # to see how many minutes you have remaining on your plan."). Short codes are
2431
2423
  # restricted to a region and are not internationally dialable, which means the
2432
2424
  # same short code can exist in different regions, with different usage and
2433
- # pricing, even if those regions share the same country calling code (e.g. US
2434
- # and CA).
2425
+ # pricing, even if those regions share the same country calling code (For
2426
+ # example: US and CA).
2435
2427
  class ShortCode
2436
2428
  include Google::Apis::Core::Hashable
2437
2429
 
2438
2430
  # Required. The short code digits, without a leading plus ('+') or country
2439
- # calling code, e.g. "611".
2431
+ # calling code. For example "611".
2440
2432
  # Corresponds to the JSON property `number`
2441
2433
  # @return [String]
2442
2434
  attr_accessor :number
@@ -2568,103 +2560,14 @@ module Google
2568
2560
  end
2569
2561
  end
2570
2562
 
2571
- # A range of postal codes that defines the area.
2572
- class TaxPostalCodeRange
2573
- include Google::Apis::Core::Hashable
2574
-
2575
- # The end of the postal code range. Will be the same as start if not specified.
2576
- # Corresponds to the JSON property `end`
2577
- # @return [String]
2578
- attr_accessor :end
2579
-
2580
- # Required. The start of the postal code range, which is also the smallest in
2581
- # the range.
2582
- # Corresponds to the JSON property `start`
2583
- # @return [String]
2584
- attr_accessor :start
2585
-
2586
- def initialize(**args)
2587
- update!(**args)
2588
- end
2589
-
2590
- # Update properties of this object
2591
- def update!(**args)
2592
- @end = args[:end] if args.key?(:end)
2593
- @start = args[:start] if args.key?(:start)
2594
- end
2595
- end
2596
-
2597
- # Primary type convension percent micro : 100% = 1 000 000 and 1% = 10 000
2598
- # cannot be negative. Information about tax nexus and related parameters
2599
- # applicable to orders delivered to the area covered by a single tax admin.
2600
- # Nexus is created when a merchant is doing business in an area administered by
2601
- # tax admin (only US states are supported for nexus configuration). If merchant
2602
- # has nexus in a US state, merchant needs to pay tax to all tax authorities
2603
- # associated with the shipping destination. Next Id : 8
2604
- class TaxRule
2605
- include Google::Apis::Core::Hashable
2606
-
2607
- # Represents a time interval, encoded as a Timestamp start (inclusive) and a
2608
- # Timestamp end (exclusive). The start must be less than or equal to the end.
2609
- # When the start equals the end, the interval is empty (matches no time). When
2610
- # both start and end are unspecified, the interval matches any time.
2611
- # Corresponds to the JSON property `effectiveTimePeriod`
2612
- # @return [Google::Apis::MerchantapiAccountsV1beta::Interval]
2613
- attr_accessor :effective_time_period
2614
-
2615
- # The admin_id or criteria_id of the region in which this rule is applicable.
2616
- # Corresponds to the JSON property `locationId`
2617
- # @return [Fixnum]
2618
- attr_accessor :location_id
2619
-
2620
- # A range of postal codes that defines the area.
2621
- # Corresponds to the JSON property `postCodeRange`
2622
- # @return [Google::Apis::MerchantapiAccountsV1beta::TaxPostalCodeRange]
2623
- attr_accessor :post_code_range
2624
-
2625
- # Region code in which this rule is applicable
2626
- # Corresponds to the JSON property `regionCode`
2627
- # @return [String]
2628
- attr_accessor :region_code
2629
-
2630
- # A fixed rate specified in micros, where 100% = 1_000_000. Suitable for origin-
2631
- # based states.
2632
- # Corresponds to the JSON property `selfSpecifiedRateMicros`
2633
- # @return [Fixnum]
2634
- attr_accessor :self_specified_rate_micros
2635
-
2636
- # If set, shipping charge is taxed (at the same rate as product) when delivering
2637
- # to this admin's area. Can only be set on US states without category.
2638
- # Corresponds to the JSON property `shippingTaxed`
2639
- # @return [Boolean]
2640
- attr_accessor :shipping_taxed
2641
- alias_method :shipping_taxed?, :shipping_taxed
2642
-
2643
- # Rate that depends on delivery location: if merchant has a nexus in
2644
- # corresponding US state, rates from authorities with jurisdiction over delivery
2645
- # area are added up.
2646
- # Corresponds to the JSON property `useGoogleRate`
2647
- # @return [Boolean]
2648
- attr_accessor :use_google_rate
2649
- alias_method :use_google_rate?, :use_google_rate
2650
-
2651
- def initialize(**args)
2652
- update!(**args)
2653
- end
2654
-
2655
- # Update properties of this object
2656
- def update!(**args)
2657
- @effective_time_period = args[:effective_time_period] if args.key?(:effective_time_period)
2658
- @location_id = args[:location_id] if args.key?(:location_id)
2659
- @post_code_range = args[:post_code_range] if args.key?(:post_code_range)
2660
- @region_code = args[:region_code] if args.key?(:region_code)
2661
- @self_specified_rate_micros = args[:self_specified_rate_micros] if args.key?(:self_specified_rate_micros)
2662
- @shipping_taxed = args[:shipping_taxed] if args.key?(:shipping_taxed)
2663
- @use_google_rate = args[:use_google_rate] if args.key?(:use_google_rate)
2664
- end
2665
- end
2666
-
2667
- # A `TermsOfService`.
2563
+ # The `TermsOfService` message represents a specific version of the terms of
2564
+ # service that merchants must accept to access certain features or services (see
2565
+ # https://support.google.com/merchants/answer/160173). This message is important
2566
+ # for the onboarding process, ensuring that merchants agree to the necessary
2567
+ # legal agreements for using the service. Merchants can retrieve the latest
2568
+ # terms of service for a given `kind` and `region` through `
2569
+ # RetrieveLatestTermsOfService`, and accept them as required through `
2570
+ # AcceptTermsOfService`.
2668
2571
  class TermsOfService
2669
2572
  include Google::Apis::Core::Hashable
2670
2573
 
@@ -2784,12 +2687,12 @@ module Google
2784
2687
  class TimeZone
2785
2688
  include Google::Apis::Core::Hashable
2786
2689
 
2787
- # IANA Time Zone Database time zone, e.g. "America/New_York".
2690
+ # IANA Time Zone Database time zone. For example "America/New_York".
2788
2691
  # Corresponds to the JSON property `id`
2789
2692
  # @return [String]
2790
2693
  attr_accessor :id
2791
2694
 
2792
- # Optional. IANA Time Zone Database version number, e.g. "2019a".
2695
+ # Optional. IANA Time Zone Database version number. For example "2019a".
2793
2696
  # Corresponds to the JSON property `version`
2794
2697
  # @return [String]
2795
2698
  attr_accessor :version
@@ -2905,7 +2808,10 @@ module Google
2905
2808
  end
2906
2809
  end
2907
2810
 
2908
- # A [user](https://support.google.com/merchants/answer/12160472).
2811
+ # The `User` message represents a user associated with a Merchant Center account.
2812
+ # It is used to manage user permissions and access rights within the account.
2813
+ # For more information, see [Frequently asked questions about people and access
2814
+ # levels](//support.google.com/merchants/answer/12160472).
2909
2815
  class User
2910
2816
  include Google::Apis::Core::Hashable
2911
2817
 
@@ -2989,7 +2895,7 @@ module Google
2989
2895
  end
2990
2896
  end
2991
2897
 
2992
- # A fulfillment warehouse, which stores and handles inventory. Next tag: 7
2898
+ # A fulfillment warehouse, which stores and handles inventory.
2993
2899
  class Warehouse
2994
2900
  include Google::Apis::Core::Hashable
2995
2901
 
@@ -3042,7 +2948,9 @@ module Google
3042
2948
  class WarehouseBasedDeliveryTime
3043
2949
  include Google::Apis::Core::Hashable
3044
2950
 
3045
- # Required. Carrier, such as `"UPS"` or `"Fedex"`.
2951
+ # Required. Carrier, such as `"UPS"` or `"Fedex"`. [supported carriers](https://
2952
+ # support.google.com/merchants/answer/7050921#zippy=%2Ccarrier-rates-au-de-uk-
2953
+ # and-us-only)
3046
2954
  # Corresponds to the JSON property `carrier`
3047
2955
  # @return [String]
3048
2956
  attr_accessor :carrier