google-apis-merchantapi_accounts_v1beta 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/google/apis/merchantapi_accounts_v1beta/classes.rb +215 -309
- data/lib/google/apis/merchantapi_accounts_v1beta/gem_version.rb +3 -3
- data/lib/google/apis/merchantapi_accounts_v1beta/representations.rb +25 -91
- data/lib/google/apis/merchantapi_accounts_v1beta/service.rb +66 -87
- metadata +4 -4
@@ -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
|
-
#
|
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,16 @@ 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
|
-
#
|
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::
|
205
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountAggregation]
|
248
206
|
attr_accessor :account_aggregation
|
249
207
|
|
250
|
-
#
|
208
|
+
# Required. The provider of the service. Format: `accounts/`account``
|
251
209
|
# Corresponds to the JSON property `provider`
|
252
210
|
# @return [String]
|
253
211
|
attr_accessor :provider
|
@@ -309,6 +267,48 @@ module Google
|
|
309
267
|
end
|
310
268
|
end
|
311
269
|
|
270
|
+
# Collection of information related to the [autofeed](https://support.google.com/
|
271
|
+
# merchants/answer/7538732) settings.
|
272
|
+
class AutofeedSettings
|
273
|
+
include Google::Apis::Core::Hashable
|
274
|
+
|
275
|
+
# Output only. Determines whether merchant is eligible for being enrolled into
|
276
|
+
# an autofeed.
|
277
|
+
# Corresponds to the JSON property `eligible`
|
278
|
+
# @return [Boolean]
|
279
|
+
attr_accessor :eligible
|
280
|
+
alias_method :eligible?, :eligible
|
281
|
+
|
282
|
+
# Required. Enables or disables product crawling through the autofeed for the
|
283
|
+
# given account. Autofeed accounts must meet [certain conditions](https://
|
284
|
+
# support.google.com/merchants/answer/7538732#
|
285
|
+
# Configure_automated_feeds_Standard_Experience), which can be checked through
|
286
|
+
# the `eligible` field. The account must **not** be a marketplace. When the
|
287
|
+
# autofeed is enabled for the first time, the products usually appear instantly.
|
288
|
+
# When re-enabling, it might take up to 24 hours for products to appear.
|
289
|
+
# Corresponds to the JSON property `enableProducts`
|
290
|
+
# @return [Boolean]
|
291
|
+
attr_accessor :enable_products
|
292
|
+
alias_method :enable_products?, :enable_products
|
293
|
+
|
294
|
+
# Identifier. The resource name of the autofeed settings. Format: `accounts/`
|
295
|
+
# account`/autofeedSettings`.
|
296
|
+
# Corresponds to the JSON property `name`
|
297
|
+
# @return [String]
|
298
|
+
attr_accessor :name
|
299
|
+
|
300
|
+
def initialize(**args)
|
301
|
+
update!(**args)
|
302
|
+
end
|
303
|
+
|
304
|
+
# Update properties of this object
|
305
|
+
def update!(**args)
|
306
|
+
@eligible = args[:eligible] if args.key?(:eligible)
|
307
|
+
@enable_products = args[:enable_products] if args.key?(:enable_products)
|
308
|
+
@name = args[:name] if args.key?(:name)
|
309
|
+
end
|
310
|
+
end
|
311
|
+
|
312
312
|
# Business days of the warehouse.
|
313
313
|
class BusinessDayConfig
|
314
314
|
include Google::Apis::Core::Hashable
|
@@ -349,7 +349,7 @@ module Google
|
|
349
349
|
# @return [String]
|
350
350
|
attr_accessor :name
|
351
351
|
|
352
|
-
#
|
352
|
+
# Required. Whether the identity attributes may be used for promotions.
|
353
353
|
# Corresponds to the JSON property `promotionsConsent`
|
354
354
|
# @return [String]
|
355
355
|
attr_accessor :promotions_consent
|
@@ -385,20 +385,22 @@ module Google
|
|
385
385
|
end
|
386
386
|
end
|
387
387
|
|
388
|
-
#
|
388
|
+
# The `BusinessInfo` message contains essential information about a merchant's
|
389
|
+
# business. This message captures key business details such as physical address,
|
390
|
+
# customer service contacts, and region-specific identifiers.
|
389
391
|
class BusinessInfo
|
390
392
|
include Google::Apis::Core::Hashable
|
391
393
|
|
392
|
-
# Represents a postal address
|
393
|
-
# Given a postal address, a postal service can deliver items to a
|
394
|
-
# Box or similar. It is not intended to model geographical
|
395
|
-
# towns, mountains). In typical usage an address would be
|
396
|
-
# or from importing existing data, depending on the type
|
397
|
-
# address input / editing: - Use an internationalization-
|
398
|
-
# such as https://github.com/google/libaddressinput) -
|
399
|
-
# presented with UI elements for input or editing of fields
|
400
|
-
# where that field is used. For more guidance on how to use
|
401
|
-
# see: https://support.google.com/business/answer/6397478
|
394
|
+
# Represents a postal address. For example for postal delivery or payments
|
395
|
+
# addresses. Given a postal address, a postal service can deliver items to a
|
396
|
+
# premise, P.O. Box or similar. It is not intended to model geographical
|
397
|
+
# locations (roads, towns, mountains). In typical usage an address would be
|
398
|
+
# created by user input or from importing existing data, depending on the type
|
399
|
+
# of process. Advice on address input / editing: - Use an internationalization-
|
400
|
+
# ready address widget such as https://github.com/google/libaddressinput) -
|
401
|
+
# Users should not be presented with UI elements for input or editing of fields
|
402
|
+
# outside countries where that field is used. For more guidance on how to use
|
403
|
+
# this schema, see: https://support.google.com/business/answer/6397478
|
402
404
|
# Corresponds to the JSON property `address`
|
403
405
|
# @return [Google::Apis::MerchantapiAccountsV1beta::PostalAddress]
|
404
406
|
attr_accessor :address
|
@@ -408,6 +410,13 @@ module Google
|
|
408
410
|
# @return [Google::Apis::MerchantapiAccountsV1beta::CustomerService]
|
409
411
|
attr_accessor :customer_service
|
410
412
|
|
413
|
+
# Optional. The 10-digit [Korean business registration number](https://support.
|
414
|
+
# google.com/merchants/answer/9037766) separated with dashes in the format: XXX-
|
415
|
+
# XX-XXXXX.
|
416
|
+
# Corresponds to the JSON property `koreanBusinessRegistrationNumber`
|
417
|
+
# @return [String]
|
418
|
+
attr_accessor :korean_business_registration_number
|
419
|
+
|
411
420
|
# Identifier. The resource name of the business info. Format: `accounts/`account`
|
412
421
|
# /businessInfo`
|
413
422
|
# Corresponds to the JSON property `name`
|
@@ -444,6 +453,7 @@ module Google
|
|
444
453
|
def update!(**args)
|
445
454
|
@address = args[:address] if args.key?(:address)
|
446
455
|
@customer_service = args[:customer_service] if args.key?(:customer_service)
|
456
|
+
@korean_business_registration_number = args[:korean_business_registration_number] if args.key?(:korean_business_registration_number)
|
447
457
|
@name = args[:name] if args.key?(:name)
|
448
458
|
@phone = args[:phone] if args.key?(:phone)
|
449
459
|
@phone_verification_state = args[:phone_verification_state] if args.key?(:phone_verification_state)
|
@@ -451,7 +461,10 @@ module Google
|
|
451
461
|
end
|
452
462
|
|
453
463
|
# A list of carrier rates that can be referred to by `main_table` or `
|
454
|
-
# single_value`.
|
464
|
+
# single_value`. Supported carrier services are defined in https://support.
|
465
|
+
# google.com/merchants/answer/12577710?ref_topic=12570808&sjid=
|
466
|
+
# 10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-
|
467
|
+
# uk-and-us-only.
|
455
468
|
class CarrierRate
|
456
469
|
include Google::Apis::Core::Hashable
|
457
470
|
|
@@ -506,12 +519,21 @@ module Google
|
|
506
519
|
class ClaimHomepageRequest
|
507
520
|
include Google::Apis::Core::Hashable
|
508
521
|
|
522
|
+
# Optional. When set to `true`, this option removes any existing claim on the
|
523
|
+
# requested website and replaces it with a claim from the account that makes the
|
524
|
+
# request.
|
525
|
+
# Corresponds to the JSON property `overwrite`
|
526
|
+
# @return [Boolean]
|
527
|
+
attr_accessor :overwrite
|
528
|
+
alias_method :overwrite?, :overwrite
|
529
|
+
|
509
530
|
def initialize(**args)
|
510
531
|
update!(**args)
|
511
532
|
end
|
512
533
|
|
513
534
|
# Update properties of this object
|
514
535
|
def update!(**args)
|
536
|
+
@overwrite = args[:overwrite] if args.key?(:overwrite)
|
515
537
|
end
|
516
538
|
end
|
517
539
|
|
@@ -519,18 +541,25 @@ module Google
|
|
519
541
|
class CreateAndConfigureAccountRequest
|
520
542
|
include Google::Apis::Core::Hashable
|
521
543
|
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
|
526
|
-
|
527
|
-
#
|
544
|
+
# The `Account` message represents a merchant's account within Shopping Ads. It'
|
545
|
+
# s the primary entity for managing product data, settings, and interactions
|
546
|
+
# with Google's services and external providers. Accounts can operate as
|
547
|
+
# standalone entities or be part of a multi-client account (MCA) structure. In
|
548
|
+
# an MCA setup the parent account manages multiple sub-accounts. Establishing an
|
549
|
+
# account involves configuring attributes like the account name, time zone, and
|
550
|
+
# language preferences. The `Account` message is the parent entity for many
|
551
|
+
# other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo`
|
552
|
+
# and so on.
|
528
553
|
# Corresponds to the JSON property `account`
|
529
554
|
# @return [Google::Apis::MerchantapiAccountsV1beta::Account]
|
530
555
|
attr_accessor :account
|
531
556
|
|
532
|
-
#
|
533
|
-
#
|
557
|
+
# Required. An account service between the account to be created and the
|
558
|
+
# provider account is initialized as part of the creation. At least one such
|
559
|
+
# service needs to be provided. Currently exactly one of these needs to be `
|
560
|
+
# account_aggregation`, which means you can only create sub accounts, not
|
561
|
+
# standalone account through this method. Additional `account_management` or `
|
562
|
+
# product_management` services may be provided.
|
534
563
|
# Corresponds to the JSON property `service`
|
535
564
|
# @return [Array<Google::Apis::MerchantapiAccountsV1beta::AddAccountService>]
|
536
565
|
attr_accessor :service
|
@@ -546,7 +575,6 @@ module Google
|
|
546
575
|
|
547
576
|
# Update properties of this object
|
548
577
|
def update!(**args)
|
549
|
-
@accept_terms_of_service = args[:accept_terms_of_service] if args.key?(:accept_terms_of_service)
|
550
578
|
@account = args[:account] if args.key?(:account)
|
551
579
|
@service = args[:service] if args.key?(:service)
|
552
580
|
@users = args[:users] if args.key?(:users)
|
@@ -563,7 +591,10 @@ module Google
|
|
563
591
|
# @return [String]
|
564
592
|
attr_accessor :parent
|
565
593
|
|
566
|
-
#
|
594
|
+
# The `User` message represents a user associated with a Merchant Center account.
|
595
|
+
# It is used to manage user permissions and access rights within the account.
|
596
|
+
# For more information, see [Frequently asked questions about people and access
|
597
|
+
# levels](//support.google.com/merchants/answer/12160472).
|
567
598
|
# Corresponds to the JSON property `user`
|
568
599
|
# @return [Google::Apis::MerchantapiAccountsV1beta::User]
|
569
600
|
attr_accessor :user
|
@@ -759,7 +790,8 @@ module Google
|
|
759
790
|
|
760
791
|
# Maximum number of business days spent before an order is shipped. 0 means same
|
761
792
|
# day shipped, 1 means next day shipped. Must be greater than or equal to `
|
762
|
-
# min_handling_days`.
|
793
|
+
# min_handling_days`. 'min_handling_days' and 'max_handling_days' should be
|
794
|
+
# either set or not set at the same time.
|
763
795
|
# Corresponds to the JSON property `maxHandlingDays`
|
764
796
|
# @return [Fixnum]
|
765
797
|
attr_accessor :max_handling_days
|
@@ -772,7 +804,8 @@ module Google
|
|
772
804
|
attr_accessor :max_transit_days
|
773
805
|
|
774
806
|
# Minimum number of business days spent before an order is shipped. 0 means same
|
775
|
-
# day shipped, 1 means next day shipped.
|
807
|
+
# day shipped, 1 means next day shipped. 'min_handling_days' and '
|
808
|
+
# max_handling_days' should be either set or not set at the same time.
|
776
809
|
# Corresponds to the JSON property `minHandlingDays`
|
777
810
|
# @return [Fixnum]
|
778
811
|
attr_accessor :min_handling_days
|
@@ -1002,7 +1035,12 @@ module Google
|
|
1002
1035
|
end
|
1003
1036
|
end
|
1004
1037
|
|
1005
|
-
#
|
1038
|
+
# The `Homepage` message represents a merchant's store homepage within the
|
1039
|
+
# system. A merchant's homepage is the primary domain where customers interact
|
1040
|
+
# with their store. The homepage can be claimed and verified as a proof of
|
1041
|
+
# ownership and allows the merchant to unlock features that require a verified
|
1042
|
+
# website. For more information, see [Understanding online store URL
|
1043
|
+
# verification](//support.google.com/merchants/answer/176793).
|
1006
1044
|
class Homepage
|
1007
1045
|
include Google::Apis::Core::Hashable
|
1008
1046
|
|
@@ -1105,36 +1143,6 @@ module Google
|
|
1105
1143
|
end
|
1106
1144
|
end
|
1107
1145
|
|
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
1146
|
# Response message for the `ListAccountIssues` method.
|
1139
1147
|
class ListAccountIssuesResponse
|
1140
1148
|
include Google::Apis::Core::Hashable
|
@@ -1161,32 +1169,6 @@ module Google
|
|
1161
1169
|
end
|
1162
1170
|
end
|
1163
1171
|
|
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
1172
|
# Response message for the `ListAccounts` method.
|
1191
1173
|
class ListAccountsResponse
|
1192
1174
|
include Google::Apis::Core::Hashable
|
@@ -1482,8 +1464,8 @@ module Google
|
|
1482
1464
|
attr_accessor :accept_exchange
|
1483
1465
|
alias_method :accept_exchange?, :accept_exchange
|
1484
1466
|
|
1485
|
-
# The countries of sale where the return policy applies.
|
1486
|
-
# valid 2 letter ISO 3166 code.
|
1467
|
+
# Required. Immutable. The countries of sale where the return policy applies.
|
1468
|
+
# The values must be a valid 2 letter ISO 3166 code.
|
1487
1469
|
# Corresponds to the JSON property `countries`
|
1488
1470
|
# @return [Array<String>]
|
1489
1471
|
attr_accessor :countries
|
@@ -1494,13 +1476,13 @@ module Google
|
|
1494
1476
|
# @return [Array<String>]
|
1495
1477
|
attr_accessor :item_conditions
|
1496
1478
|
|
1497
|
-
# This field represents the unique user-defined label of
|
1498
|
-
# is important to note that the same label cannot be used
|
1499
|
-
# policies for the same country. Unless a product specifies
|
1500
|
-
# attribute, policies will be automatically labeled as 'default'
|
1501
|
-
# custom return policy to certain product groups, follow the
|
1502
|
-
# provided in the [Return policy label] (https://support.google.com/
|
1503
|
-
# answer/9445425). The label can contain up to 50 characters.
|
1479
|
+
# Required. Immutable. This field represents the unique user-defined label of
|
1480
|
+
# the return policy. It is important to note that the same label cannot be used
|
1481
|
+
# in different return policies for the same country. Unless a product specifies
|
1482
|
+
# a specific label attribute, policies will be automatically labeled as 'default'
|
1483
|
+
# . To assign a custom return policy to certain product groups, follow the
|
1484
|
+
# instructions provided in the [Return policy label] (https://support.google.com/
|
1485
|
+
# merchants/answer/9445425). The label can contain up to 50 characters.
|
1504
1486
|
# Corresponds to the JSON property `label`
|
1505
1487
|
# @return [String]
|
1506
1488
|
attr_accessor :label
|
@@ -1538,8 +1520,8 @@ module Google
|
|
1538
1520
|
# @return [String]
|
1539
1521
|
attr_accessor :return_policy_id
|
1540
1522
|
|
1541
|
-
# The return policy uri. This can used by Google to do a sanity check
|
1542
|
-
# policy. It must be a valid URL.
|
1523
|
+
# Required. The return policy uri. This can used by Google to do a sanity check
|
1524
|
+
# for the policy. It must be a valid URL.
|
1543
1525
|
# Corresponds to the JSON property `returnPolicyUri`
|
1544
1526
|
# @return [String]
|
1545
1527
|
attr_accessor :return_policy_uri
|
@@ -1591,9 +1573,9 @@ module Google
|
|
1591
1573
|
# The phone number, represented as a leading plus sign ('+'), followed by a
|
1592
1574
|
# phone number that uses a relaxed ITU E.164 format consisting of the country
|
1593
1575
|
# calling code (1 to 3 digits) and the subscriber number, with no additional
|
1594
|
-
# spaces or formatting
|
1595
|
-
# 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but
|
1596
|
-
# practice not all countries respect that, so we relax that restriction here.
|
1576
|
+
# spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (
|
1577
|
+
# 555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but
|
1578
|
+
# in practice not all countries respect that, so we relax that restriction here.
|
1597
1579
|
# National-only numbers are not allowed. References: - https://www.itu.int/rec/T-
|
1598
1580
|
# REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.
|
1599
1581
|
# wikipedia.org/wiki/List_of_country_calling_codes
|
@@ -1614,12 +1596,12 @@ module Google
|
|
1614
1596
|
|
1615
1597
|
# An object representing a short code, which is a phone number that is typically
|
1616
1598
|
# 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 (
|
1618
|
-
# how many minutes you have remaining on your plan."). Short codes are
|
1599
|
+
# MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611
|
1600
|
+
# to see how many minutes you have remaining on your plan."). Short codes are
|
1619
1601
|
# restricted to a region and are not internationally dialable, which means the
|
1620
1602
|
# same short code can exist in different regions, with different usage and
|
1621
|
-
# pricing, even if those regions share the same country calling code (
|
1622
|
-
# and CA).
|
1603
|
+
# pricing, even if those regions share the same country calling code (For
|
1604
|
+
# example: US and CA).
|
1623
1605
|
# Corresponds to the JSON property `shortCode`
|
1624
1606
|
# @return [Google::Apis::MerchantapiAccountsV1beta::ShortCode]
|
1625
1607
|
attr_accessor :short_code
|
@@ -1663,35 +1645,36 @@ module Google
|
|
1663
1645
|
end
|
1664
1646
|
end
|
1665
1647
|
|
1666
|
-
# Represents a postal address
|
1667
|
-
# Given a postal address, a postal service can deliver items to a
|
1668
|
-
# Box or similar. It is not intended to model geographical
|
1669
|
-
# towns, mountains). In typical usage an address would be
|
1670
|
-
# or from importing existing data, depending on the type
|
1671
|
-
# address input / editing: - Use an internationalization-
|
1672
|
-
# such as https://github.com/google/libaddressinput) -
|
1673
|
-
# presented with UI elements for input or editing of fields
|
1674
|
-
# where that field is used. For more guidance on how to use
|
1675
|
-
# see: https://support.google.com/business/answer/6397478
|
1648
|
+
# Represents a postal address. For example for postal delivery or payments
|
1649
|
+
# addresses. Given a postal address, a postal service can deliver items to a
|
1650
|
+
# premise, P.O. Box or similar. It is not intended to model geographical
|
1651
|
+
# locations (roads, towns, mountains). In typical usage an address would be
|
1652
|
+
# created by user input or from importing existing data, depending on the type
|
1653
|
+
# of process. Advice on address input / editing: - Use an internationalization-
|
1654
|
+
# ready address widget such as https://github.com/google/libaddressinput) -
|
1655
|
+
# Users should not be presented with UI elements for input or editing of fields
|
1656
|
+
# outside countries where that field is used. For more guidance on how to use
|
1657
|
+
# this schema, see: https://support.google.com/business/answer/6397478
|
1676
1658
|
class PostalAddress
|
1677
1659
|
include Google::Apis::Core::Hashable
|
1678
1660
|
|
1679
1661
|
# Unstructured address lines describing the lower levels of an address. Because
|
1680
1662
|
# values in address_lines do not have type information and may sometimes contain
|
1681
|
-
# multiple values in a single field (
|
1682
|
-
# the line order is clear. The order of address lines should be "envelope
|
1683
|
-
# for the country/region of the address. In places where this can vary (
|
1684
|
-
# Japan), address_language is used to make it explicit (
|
1685
|
-
# small ordering and "ja-Latn" or "en" for small-to-large).
|
1686
|
-
# specific line of an address can be selected based on the
|
1687
|
-
# permitted structural representation of an address
|
1688
|
-
# with all remaining information placed in the
|
1689
|
-
# possible to format such an address very
|
1690
|
-
# no semantic reasoning could be made about
|
1691
|
-
# it was at least partially resolved.
|
1692
|
-
# region_code and address_lines, and then
|
1693
|
-
# handle completely unstructured addresses (
|
1694
|
-
# of the address should be localities or
|
1663
|
+
# multiple values in a single field (For example "Austin, TX"), it is important
|
1664
|
+
# that the line order is clear. The order of address lines should be "envelope
|
1665
|
+
# order" for the country/region of the address. In places where this can vary (
|
1666
|
+
# For example Japan), address_language is used to make it explicit (For example "
|
1667
|
+
# ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large).
|
1668
|
+
# This way, the most specific line of an address can be selected based on the
|
1669
|
+
# language. The minimum permitted structural representation of an address
|
1670
|
+
# consists of a region_code with all remaining information placed in the
|
1671
|
+
# address_lines. It would be possible to format such an address very
|
1672
|
+
# approximately without geocoding, but no semantic reasoning could be made about
|
1673
|
+
# any of the address components until it was at least partially resolved.
|
1674
|
+
# Creating an address only containing a region_code and address_lines, and then
|
1675
|
+
# geocoding is the recommended way to handle completely unstructured addresses (
|
1676
|
+
# as opposed to guessing which parts of the address should be localities or
|
1677
|
+
# administrative areas).
|
1695
1678
|
# Corresponds to the JSON property `addressLines`
|
1696
1679
|
# @return [Array<String>]
|
1697
1680
|
attr_accessor :address_lines
|
@@ -1699,9 +1682,9 @@ module Google
|
|
1699
1682
|
# Optional. Highest administrative subdivision which is used for postal
|
1700
1683
|
# addresses of a country or region. For example, this can be a state, a province,
|
1701
1684
|
# an oblast, or a prefecture. Specifically, for Spain this is the province and
|
1702
|
-
# not the autonomous community (
|
1703
|
-
# countries don't use an administrative area in postal addresses.
|
1704
|
-
# Switzerland this should be left unpopulated.
|
1685
|
+
# not the autonomous community (For example "Barcelona" and not "Catalonia").
|
1686
|
+
# Many countries don't use an administrative area in postal addresses. For
|
1687
|
+
# example in Switzerland this should be left unpopulated.
|
1705
1688
|
# Corresponds to the JSON property `administrativeArea`
|
1706
1689
|
# @return [String]
|
1707
1690
|
attr_accessor :administrative_area
|
@@ -1733,8 +1716,8 @@ module Google
|
|
1733
1716
|
|
1734
1717
|
# Optional. Postal code of the address. Not all countries use or require postal
|
1735
1718
|
# codes to be present, but where they are used, they may trigger additional
|
1736
|
-
# validation with other parts of the address (
|
1737
|
-
# S.A.).
|
1719
|
+
# validation with other parts of the address (For example state/zip validation
|
1720
|
+
# in the U.S.A.).
|
1738
1721
|
# Corresponds to the JSON property `postalCode`
|
1739
1722
|
# @return [String]
|
1740
1723
|
attr_accessor :postal_code
|
@@ -1763,9 +1746,9 @@ module Google
|
|
1763
1746
|
|
1764
1747
|
# Optional. Additional, country-specific, sorting code. This is not used in most
|
1765
1748
|
# regions. Where it is used, the value is either a string like "CEDEX",
|
1766
|
-
# optionally followed by a number (
|
1767
|
-
# representing the "sector code" (Jamaica), "delivery area indicator" (
|
1768
|
-
# or "post office indicator" (
|
1749
|
+
# optionally followed by a number (For example "CEDEX 7"), or just a number
|
1750
|
+
# alone, representing the "sector code" (Jamaica), "delivery area indicator" (
|
1751
|
+
# Malawi) or "post office indicator" (For example Côte d'Ivoire).
|
1769
1752
|
# Corresponds to the JSON property `sortingCode`
|
1770
1753
|
# @return [String]
|
1771
1754
|
attr_accessor :sorting_code
|
@@ -1944,6 +1927,12 @@ module Google
|
|
1944
1927
|
# @return [Array<Google::Apis::MerchantapiAccountsV1beta::ProductChange>]
|
1945
1928
|
attr_accessor :changes
|
1946
1929
|
|
1930
|
+
# The product expiration time. This field will not bet set if the notification
|
1931
|
+
# is sent for a product deletion event.
|
1932
|
+
# Corresponds to the JSON property `expirationTime`
|
1933
|
+
# @return [String]
|
1934
|
+
attr_accessor :expiration_time
|
1935
|
+
|
1947
1936
|
# The account that manages the merchant's account. can be the same as merchant
|
1948
1937
|
# id if it is standalone account. Format : `accounts/`service_provider_id``
|
1949
1938
|
# Corresponds to the JSON property `managingAccount`
|
@@ -1975,6 +1964,7 @@ module Google
|
|
1975
1964
|
@account = args[:account] if args.key?(:account)
|
1976
1965
|
@attribute = args[:attribute] if args.key?(:attribute)
|
1977
1966
|
@changes = args[:changes] if args.key?(:changes)
|
1967
|
+
@expiration_time = args[:expiration_time] if args.key?(:expiration_time)
|
1978
1968
|
@managing_account = args[:managing_account] if args.key?(:managing_account)
|
1979
1969
|
@resource = args[:resource] if args.key?(:resource)
|
1980
1970
|
@resource_id = args[:resource_id] if args.key?(:resource_id)
|
@@ -2254,7 +2244,7 @@ module Google
|
|
2254
2244
|
# @return [Google::Apis::MerchantapiAccountsV1beta::Price]
|
2255
2245
|
attr_accessor :fixed_fee
|
2256
2246
|
|
2257
|
-
# Type of return shipping fee.
|
2247
|
+
# Required. Type of return shipping fee.
|
2258
2248
|
# Corresponds to the JSON property `type`
|
2259
2249
|
# @return [String]
|
2260
2250
|
attr_accessor :type
|
@@ -2376,8 +2366,8 @@ module Google
|
|
2376
2366
|
end
|
2377
2367
|
end
|
2378
2368
|
|
2379
|
-
# The merchant account's [shipping setting](
|
2380
|
-
#
|
2369
|
+
# The merchant account's [shipping setting](https://support.google.com/merchants/
|
2370
|
+
# answer/6069284).
|
2381
2371
|
class ShippingSettings
|
2382
2372
|
include Google::Apis::Core::Hashable
|
2383
2373
|
|
@@ -2426,17 +2416,17 @@ module Google
|
|
2426
2416
|
|
2427
2417
|
# An object representing a short code, which is a phone number that is typically
|
2428
2418
|
# 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 (
|
2430
|
-
# how many minutes you have remaining on your plan."). Short codes are
|
2419
|
+
# MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611
|
2420
|
+
# to see how many minutes you have remaining on your plan."). Short codes are
|
2431
2421
|
# restricted to a region and are not internationally dialable, which means the
|
2432
2422
|
# same short code can exist in different regions, with different usage and
|
2433
|
-
# pricing, even if those regions share the same country calling code (
|
2434
|
-
# and CA).
|
2423
|
+
# pricing, even if those regions share the same country calling code (For
|
2424
|
+
# example: US and CA).
|
2435
2425
|
class ShortCode
|
2436
2426
|
include Google::Apis::Core::Hashable
|
2437
2427
|
|
2438
2428
|
# Required. The short code digits, without a leading plus ('+') or country
|
2439
|
-
# calling code
|
2429
|
+
# calling code. For example "611".
|
2440
2430
|
# Corresponds to the JSON property `number`
|
2441
2431
|
# @return [String]
|
2442
2432
|
attr_accessor :number
|
@@ -2568,103 +2558,14 @@ module Google
|
|
2568
2558
|
end
|
2569
2559
|
end
|
2570
2560
|
|
2571
|
-
#
|
2572
|
-
|
2573
|
-
|
2574
|
-
|
2575
|
-
|
2576
|
-
|
2577
|
-
|
2578
|
-
|
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`.
|
2561
|
+
# The `TermsOfService` message represents a specific version of the terms of
|
2562
|
+
# service that merchants must accept to access certain features or services (see
|
2563
|
+
# https://support.google.com/merchants/answer/160173). This message is important
|
2564
|
+
# for the onboarding process, ensuring that merchants agree to the necessary
|
2565
|
+
# legal agreements for using the service. Merchants can retrieve the latest
|
2566
|
+
# terms of service for a given `kind` and `region` through `
|
2567
|
+
# RetrieveLatestTermsOfService`, and accept them as required through `
|
2568
|
+
# AcceptTermsOfService`.
|
2668
2569
|
class TermsOfService
|
2669
2570
|
include Google::Apis::Core::Hashable
|
2670
2571
|
|
@@ -2784,12 +2685,12 @@ module Google
|
|
2784
2685
|
class TimeZone
|
2785
2686
|
include Google::Apis::Core::Hashable
|
2786
2687
|
|
2787
|
-
# IANA Time Zone Database time zone
|
2688
|
+
# IANA Time Zone Database time zone. For example "America/New_York".
|
2788
2689
|
# Corresponds to the JSON property `id`
|
2789
2690
|
# @return [String]
|
2790
2691
|
attr_accessor :id
|
2791
2692
|
|
2792
|
-
# Optional. IANA Time Zone Database version number
|
2693
|
+
# Optional. IANA Time Zone Database version number. For example "2019a".
|
2793
2694
|
# Corresponds to the JSON property `version`
|
2794
2695
|
# @return [String]
|
2795
2696
|
attr_accessor :version
|
@@ -2905,7 +2806,10 @@ module Google
|
|
2905
2806
|
end
|
2906
2807
|
end
|
2907
2808
|
|
2908
|
-
#
|
2809
|
+
# The `User` message represents a user associated with a Merchant Center account.
|
2810
|
+
# It is used to manage user permissions and access rights within the account.
|
2811
|
+
# For more information, see [Frequently asked questions about people and access
|
2812
|
+
# levels](//support.google.com/merchants/answer/12160472).
|
2909
2813
|
class User
|
2910
2814
|
include Google::Apis::Core::Hashable
|
2911
2815
|
|
@@ -2989,7 +2893,7 @@ module Google
|
|
2989
2893
|
end
|
2990
2894
|
end
|
2991
2895
|
|
2992
|
-
# A fulfillment warehouse, which stores and handles inventory.
|
2896
|
+
# A fulfillment warehouse, which stores and handles inventory.
|
2993
2897
|
class Warehouse
|
2994
2898
|
include Google::Apis::Core::Hashable
|
2995
2899
|
|
@@ -3042,7 +2946,9 @@ module Google
|
|
3042
2946
|
class WarehouseBasedDeliveryTime
|
3043
2947
|
include Google::Apis::Core::Hashable
|
3044
2948
|
|
3045
|
-
# Required. Carrier, such as `"UPS"` or `"Fedex"`.
|
2949
|
+
# Required. Carrier, such as `"UPS"` or `"Fedex"`. [supported carriers](https://
|
2950
|
+
# support.google.com/merchants/answer/7050921#zippy=%2Ccarrier-rates-au-de-uk-
|
2951
|
+
# and-us-only)
|
3046
2952
|
# Corresponds to the JSON property `carrier`
|
3047
2953
|
# @return [String]
|
3048
2954
|
attr_accessor :carrier
|