google-apis-merchantapi_accounts_v1beta 0.11.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/OVERVIEW.md +1 -1
- data/lib/google/apis/merchantapi_accounts_v1beta/classes.rb +351 -20
- data/lib/google/apis/merchantapi_accounts_v1beta/gem_version.rb +3 -3
- data/lib/google/apis/merchantapi_accounts_v1beta/representations.rb +162 -0
- data/lib/google/apis/merchantapi_accounts_v1beta/service.rb +286 -5
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b7a265e641981de78efbd698759f1012168e359a336b5758b44dfbd517e7006f
|
4
|
+
data.tar.gz: d94d3f67ff9a657340842ba41b34100b882dcf9b46ac66f118e89a4ebef7f3db
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 29890b5000294d686f540ceb95c58cf0e4d567f7e31f49195f924784ea623fd76e18cbf0c1f84d540e70e51e2cc01d0997272bcf5c2f66326ce8684d2a3c8710
|
7
|
+
data.tar.gz: 927e6de9cfca9cb3a908438c294f2617fe67d451069a1b6955cda10d7b0c160e90156b16048a5786d888ac74dc4f8e399678f293fea739ca5f0a37f320d5091e
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,10 @@
|
|
1
1
|
# Release history for google-apis-merchantapi_accounts_v1beta
|
2
2
|
|
3
|
+
### v0.12.0 (2025-05-11)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250507
|
6
|
+
* Regenerated using generator version 0.17.0
|
7
|
+
|
3
8
|
### v0.11.0 (2025-04-27)
|
4
9
|
|
5
10
|
* Regenerated from discovery document revision 20250422
|
data/OVERVIEW.md
CHANGED
@@ -83,7 +83,7 @@ The [product documentation](https://developers.devsite.corp.google.com/merchant/
|
|
83
83
|
|
84
84
|
## Supported Ruby versions
|
85
85
|
|
86
|
-
This library is supported on Ruby
|
86
|
+
This library is supported on Ruby 3.1+.
|
87
87
|
|
88
88
|
Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
|
89
89
|
|
@@ -36,7 +36,7 @@ module Google
|
|
36
36
|
# before `valid_until` in order for the account to continue having a valid
|
37
37
|
# agreement. When accepting new terms of services we expect 3Ps to display the
|
38
38
|
# text associated with the given terms of service agreement (the url to the file
|
39
|
-
# containing the text is added in the Required message below as `tos_file_uri
|
39
|
+
# containing the text is added in the Required message below as `tos_file_uri`).
|
40
40
|
# The actual acceptance of the terms of service is done by calling accept on the
|
41
41
|
# `TermsOfService` resource.
|
42
42
|
# Corresponds to the JSON property `termsOfServiceAgreementState`
|
@@ -63,8 +63,7 @@ module Google
|
|
63
63
|
# @return [String]
|
64
64
|
attr_accessor :accepted_by
|
65
65
|
|
66
|
-
# The accepted
|
67
|
-
# TermsOfService).
|
66
|
+
# The accepted termsOfService.
|
68
67
|
# Corresponds to the JSON property `termsOfService`
|
69
68
|
# @return [String]
|
70
69
|
attr_accessor :terms_of_service
|
@@ -227,6 +226,168 @@ module Google
|
|
227
226
|
end
|
228
227
|
end
|
229
228
|
|
229
|
+
# `AccountManagement` payload.
|
230
|
+
class AccountManagement
|
231
|
+
include Google::Apis::Core::Hashable
|
232
|
+
|
233
|
+
def initialize(**args)
|
234
|
+
update!(**args)
|
235
|
+
end
|
236
|
+
|
237
|
+
# Update properties of this object
|
238
|
+
def update!(**args)
|
239
|
+
end
|
240
|
+
end
|
241
|
+
|
242
|
+
# The `AccountRelationship` message defines a formal connection between a
|
243
|
+
# merchant's account and a service provider's account. This relationship enables
|
244
|
+
# the provider to offer specific services to the merchant, such as product
|
245
|
+
# management or campaign management. It specifies the access rights and
|
246
|
+
# permissions to the merchant's data relevant to those services. Establishing an
|
247
|
+
# account relationship involves linking the merchant's account with a provider's
|
248
|
+
# account. The provider could be another Google account (like Google Ads or
|
249
|
+
# Google My Business) or a third-party platform (such as Shopify or WooCommerce).
|
250
|
+
class AccountRelationship
|
251
|
+
include Google::Apis::Core::Hashable
|
252
|
+
|
253
|
+
# Optional. An optional alias you can assign to this account relationship. This
|
254
|
+
# alias acts as a convenient identifier for your own reference and management.
|
255
|
+
# It must be unique among all your account relationships with the same provider.
|
256
|
+
# For example, you might use `account_id_alias` to assign a friendly name to
|
257
|
+
# this relationship for easier identification in your systems.
|
258
|
+
# Corresponds to the JSON property `accountIdAlias`
|
259
|
+
# @return [String]
|
260
|
+
attr_accessor :account_id_alias
|
261
|
+
|
262
|
+
# Identifier. The resource name of the account relationship. Format: `accounts/`
|
263
|
+
# account`/relationships/`relationship``
|
264
|
+
# Corresponds to the JSON property `name`
|
265
|
+
# @return [String]
|
266
|
+
attr_accessor :name
|
267
|
+
|
268
|
+
# Immutable. The provider of the service. Either the reference to an account
|
269
|
+
# such as `providers/123` or a well-known service provider (one of `providers/
|
270
|
+
# GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
|
271
|
+
# Corresponds to the JSON property `provider`
|
272
|
+
# @return [String]
|
273
|
+
attr_accessor :provider
|
274
|
+
|
275
|
+
# Output only. The human-readable display name of the provider account.
|
276
|
+
# Corresponds to the JSON property `providerDisplayName`
|
277
|
+
# @return [String]
|
278
|
+
attr_accessor :provider_display_name
|
279
|
+
|
280
|
+
def initialize(**args)
|
281
|
+
update!(**args)
|
282
|
+
end
|
283
|
+
|
284
|
+
# Update properties of this object
|
285
|
+
def update!(**args)
|
286
|
+
@account_id_alias = args[:account_id_alias] if args.key?(:account_id_alias)
|
287
|
+
@name = args[:name] if args.key?(:name)
|
288
|
+
@provider = args[:provider] if args.key?(:provider)
|
289
|
+
@provider_display_name = args[:provider_display_name] if args.key?(:provider_display_name)
|
290
|
+
end
|
291
|
+
end
|
292
|
+
|
293
|
+
# The `AccountService` message represents a specific service that a provider
|
294
|
+
# account offers to a merchant account. `AccountService` defines the permissions
|
295
|
+
# and capabilities granted to the provider, allowing for operations such as
|
296
|
+
# product management or campaign management. The lifecycle of an `AccountService`
|
297
|
+
# involves a proposal phase, where one party suggests the service, and an
|
298
|
+
# approval phase, where the other party accepts or rejects it. This handshake
|
299
|
+
# mechanism ensures mutual consent before any access is granted. This mechanism
|
300
|
+
# safeguards both parties by ensuring that access rights are granted
|
301
|
+
# appropriately and that both the merchant and provider are aware of the
|
302
|
+
# services enabled. In scenarios where a user is an admin of both accounts, the
|
303
|
+
# approval can happen automatically. The mutability of a service is also managed
|
304
|
+
# through `AccountService`. Some services might be immutable, for example, if
|
305
|
+
# they were established through other systems or APIs, and you cannot alter them
|
306
|
+
# through this API.
|
307
|
+
class AccountService
|
308
|
+
include Google::Apis::Core::Hashable
|
309
|
+
|
310
|
+
# `AccountAggregation` payload.
|
311
|
+
# Corresponds to the JSON property `accountAggregation`
|
312
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountAggregation]
|
313
|
+
attr_accessor :account_aggregation
|
314
|
+
|
315
|
+
# `AccountManagement` payload.
|
316
|
+
# Corresponds to the JSON property `accountManagement`
|
317
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountManagement]
|
318
|
+
attr_accessor :account_management
|
319
|
+
|
320
|
+
# `CampaignManagement` payload.
|
321
|
+
# Corresponds to the JSON property `campaignsManagement`
|
322
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::CampaignsManagement]
|
323
|
+
attr_accessor :campaigns_management
|
324
|
+
|
325
|
+
# Immutable. An optional, immutable identifier that Google uses to refer to this
|
326
|
+
# account when communicating with the provider. This should be the unique
|
327
|
+
# account ID within the provider's system (for example, your shop ID in Shopify).
|
328
|
+
# If you have multiple accounts with the same provider - for instance,
|
329
|
+
# different accounts for various regions — the `external_account_id`
|
330
|
+
# differentiates between them, ensuring accurate linking and integration between
|
331
|
+
# Google and the provider.
|
332
|
+
# Corresponds to the JSON property `externalAccountId`
|
333
|
+
# @return [String]
|
334
|
+
attr_accessor :external_account_id
|
335
|
+
|
336
|
+
# The current status of establishing of the service. (for example, pending
|
337
|
+
# approval or approved).
|
338
|
+
# Corresponds to the JSON property `handshake`
|
339
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::Handshake]
|
340
|
+
attr_accessor :handshake
|
341
|
+
|
342
|
+
# Output only. Whether the service is mutable (e.g. through Approve / Reject
|
343
|
+
# RPCs). A service that was created through another system or API might be
|
344
|
+
# immutable.
|
345
|
+
# Corresponds to the JSON property `mutability`
|
346
|
+
# @return [String]
|
347
|
+
attr_accessor :mutability
|
348
|
+
|
349
|
+
# Identifier. The resource name of the account service. Format: `accounts/`
|
350
|
+
# account`/services/`service``
|
351
|
+
# Corresponds to the JSON property `name`
|
352
|
+
# @return [String]
|
353
|
+
attr_accessor :name
|
354
|
+
|
355
|
+
# `ProductsManagement` payload.
|
356
|
+
# Corresponds to the JSON property `productsManagement`
|
357
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::ProductsManagement]
|
358
|
+
attr_accessor :products_management
|
359
|
+
|
360
|
+
# Output only. The provider of the service. Either the reference to an account
|
361
|
+
# such as `providers/123` or a well-known service provider (one of `providers/
|
362
|
+
# GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
|
363
|
+
# Corresponds to the JSON property `provider`
|
364
|
+
# @return [String]
|
365
|
+
attr_accessor :provider
|
366
|
+
|
367
|
+
# Output only. The human-readable display name of the provider account.
|
368
|
+
# Corresponds to the JSON property `providerDisplayName`
|
369
|
+
# @return [String]
|
370
|
+
attr_accessor :provider_display_name
|
371
|
+
|
372
|
+
def initialize(**args)
|
373
|
+
update!(**args)
|
374
|
+
end
|
375
|
+
|
376
|
+
# Update properties of this object
|
377
|
+
def update!(**args)
|
378
|
+
@account_aggregation = args[:account_aggregation] if args.key?(:account_aggregation)
|
379
|
+
@account_management = args[:account_management] if args.key?(:account_management)
|
380
|
+
@campaigns_management = args[:campaigns_management] if args.key?(:campaigns_management)
|
381
|
+
@external_account_id = args[:external_account_id] if args.key?(:external_account_id)
|
382
|
+
@handshake = args[:handshake] if args.key?(:handshake)
|
383
|
+
@mutability = args[:mutability] if args.key?(:mutability)
|
384
|
+
@name = args[:name] if args.key?(:name)
|
385
|
+
@products_management = args[:products_management] if args.key?(:products_management)
|
386
|
+
@provider = args[:provider] if args.key?(:provider)
|
387
|
+
@provider_display_name = args[:provider_display_name] if args.key?(:provider_display_name)
|
388
|
+
end
|
389
|
+
end
|
390
|
+
|
230
391
|
# Additional instructions to add account services during creation of the account.
|
231
392
|
class AddAccountService
|
232
393
|
include Google::Apis::Core::Hashable
|
@@ -328,6 +489,19 @@ module Google
|
|
328
489
|
end
|
329
490
|
end
|
330
491
|
|
492
|
+
# Request to approve an account service.
|
493
|
+
class ApproveAccountServiceRequest
|
494
|
+
include Google::Apis::Core::Hashable
|
495
|
+
|
496
|
+
def initialize(**args)
|
497
|
+
update!(**args)
|
498
|
+
end
|
499
|
+
|
500
|
+
# Update properties of this object
|
501
|
+
def update!(**args)
|
502
|
+
end
|
503
|
+
end
|
504
|
+
|
331
505
|
# Collection of information related to the [autofeed](https://support.google.com/
|
332
506
|
# merchants/answer/7538732) settings.
|
333
507
|
class AutofeedSettings
|
@@ -700,6 +874,19 @@ module Google
|
|
700
874
|
end
|
701
875
|
end
|
702
876
|
|
877
|
+
# `CampaignManagement` payload.
|
878
|
+
class CampaignsManagement
|
879
|
+
include Google::Apis::Core::Hashable
|
880
|
+
|
881
|
+
def initialize(**args)
|
882
|
+
update!(**args)
|
883
|
+
end
|
884
|
+
|
885
|
+
# Update properties of this object
|
886
|
+
def update!(**args)
|
887
|
+
end
|
888
|
+
end
|
889
|
+
|
703
890
|
# A list of carrier rates that can be referred to by `main_table` or `
|
704
891
|
# single_value`. Supported carrier services are defined in https://support.
|
705
892
|
# google.com/merchants/answer/12577710?ref_topic=12570808&sjid=
|
@@ -760,8 +947,8 @@ module Google
|
|
760
947
|
include Google::Apis::Core::Hashable
|
761
948
|
|
762
949
|
# Optional. When set to `true`, this option removes any existing claim on the
|
763
|
-
# requested website
|
764
|
-
#
|
950
|
+
# requested website from any other account to the account making the request,
|
951
|
+
# effectively replacing the previous claim.
|
765
952
|
# Corresponds to the JSON property `overwrite`
|
766
953
|
# @return [Boolean]
|
767
954
|
attr_accessor :overwrite
|
@@ -1219,6 +1406,33 @@ module Google
|
|
1219
1406
|
end
|
1220
1407
|
end
|
1221
1408
|
|
1409
|
+
# The current status of establishing of the service. (for example, pending
|
1410
|
+
# approval or approved).
|
1411
|
+
class Handshake
|
1412
|
+
include Google::Apis::Core::Hashable
|
1413
|
+
|
1414
|
+
# Output only. The most recent account to modify the account service's `
|
1415
|
+
# approval_status`.
|
1416
|
+
# Corresponds to the JSON property `actor`
|
1417
|
+
# @return [String]
|
1418
|
+
attr_accessor :actor
|
1419
|
+
|
1420
|
+
# Output only. The approval state of this handshake.
|
1421
|
+
# Corresponds to the JSON property `approvalState`
|
1422
|
+
# @return [String]
|
1423
|
+
attr_accessor :approval_state
|
1424
|
+
|
1425
|
+
def initialize(**args)
|
1426
|
+
update!(**args)
|
1427
|
+
end
|
1428
|
+
|
1429
|
+
# Update properties of this object
|
1430
|
+
def update!(**args)
|
1431
|
+
@actor = args[:actor] if args.key?(:actor)
|
1432
|
+
@approval_state = args[:approval_state] if args.key?(:approval_state)
|
1433
|
+
end
|
1434
|
+
end
|
1435
|
+
|
1222
1436
|
# A non-empty list of row or column headers for a table. Exactly one of `prices`,
|
1223
1437
|
# `weights`, `num_items`, `postal_code_group_names`, or `location` must be set.
|
1224
1438
|
class Headers
|
@@ -1487,6 +1701,58 @@ module Google
|
|
1487
1701
|
end
|
1488
1702
|
end
|
1489
1703
|
|
1704
|
+
# Response after trying to list account relationships.
|
1705
|
+
class ListAccountRelationshipsResponse
|
1706
|
+
include Google::Apis::Core::Hashable
|
1707
|
+
|
1708
|
+
# The account relationships that match your filter.
|
1709
|
+
# Corresponds to the JSON property `accountRelationships`
|
1710
|
+
# @return [Array<Google::Apis::MerchantapiAccountsV1beta::AccountRelationship>]
|
1711
|
+
attr_accessor :account_relationships
|
1712
|
+
|
1713
|
+
# A page token. You can send the `page_token` to get the next page. Only
|
1714
|
+
# included in the `list` response if there are more pages.
|
1715
|
+
# Corresponds to the JSON property `nextPageToken`
|
1716
|
+
# @return [String]
|
1717
|
+
attr_accessor :next_page_token
|
1718
|
+
|
1719
|
+
def initialize(**args)
|
1720
|
+
update!(**args)
|
1721
|
+
end
|
1722
|
+
|
1723
|
+
# Update properties of this object
|
1724
|
+
def update!(**args)
|
1725
|
+
@account_relationships = args[:account_relationships] if args.key?(:account_relationships)
|
1726
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
1727
|
+
end
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# Response after trying to list account services.
|
1731
|
+
class ListAccountServicesResponse
|
1732
|
+
include Google::Apis::Core::Hashable
|
1733
|
+
|
1734
|
+
# The account services that match your filter.
|
1735
|
+
# Corresponds to the JSON property `accountServices`
|
1736
|
+
# @return [Array<Google::Apis::MerchantapiAccountsV1beta::AccountService>]
|
1737
|
+
attr_accessor :account_services
|
1738
|
+
|
1739
|
+
# A page token. You can send the `page_token` to get the next page. Only
|
1740
|
+
# included in the `list` response if there are more pages.
|
1741
|
+
# Corresponds to the JSON property `nextPageToken`
|
1742
|
+
# @return [String]
|
1743
|
+
attr_accessor :next_page_token
|
1744
|
+
|
1745
|
+
def initialize(**args)
|
1746
|
+
update!(**args)
|
1747
|
+
end
|
1748
|
+
|
1749
|
+
# Update properties of this object
|
1750
|
+
def update!(**args)
|
1751
|
+
@account_services = args[:account_services] if args.key?(:account_services)
|
1752
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
1753
|
+
end
|
1754
|
+
end
|
1755
|
+
|
1490
1756
|
# Response message for the `ListAccounts` method.
|
1491
1757
|
class ListAccountsResponse
|
1492
1758
|
include Google::Apis::Core::Hashable
|
@@ -1768,15 +2034,15 @@ module Google
|
|
1768
2034
|
class OnlineReturnPolicy
|
1769
2035
|
include Google::Apis::Core::Hashable
|
1770
2036
|
|
1771
|
-
# This field specifies if merchant only accepts defective products for
|
1772
|
-
#
|
2037
|
+
# Optional. This field specifies if merchant only accepts defective products for
|
2038
|
+
# returns.
|
1773
2039
|
# Corresponds to the JSON property `acceptDefectiveOnly`
|
1774
2040
|
# @return [Boolean]
|
1775
2041
|
attr_accessor :accept_defective_only
|
1776
2042
|
alias_method :accept_defective_only?, :accept_defective_only
|
1777
2043
|
|
1778
|
-
# This field specifies if merchant allows customers to exchange
|
1779
|
-
#
|
2044
|
+
# Optional. This field specifies if merchant allows customers to exchange
|
2045
|
+
# products.
|
1780
2046
|
# Corresponds to the JSON property `acceptExchange`
|
1781
2047
|
# @return [Boolean]
|
1782
2048
|
attr_accessor :accept_exchange
|
@@ -1816,8 +2082,8 @@ module Google
|
|
1816
2082
|
# @return [Google::Apis::MerchantapiAccountsV1beta::Policy]
|
1817
2083
|
attr_accessor :policy
|
1818
2084
|
|
1819
|
-
# The field specifies the number of days it takes for merchants to
|
1820
|
-
# refunds
|
2085
|
+
# Optional. The field specifies the number of days it takes for merchants to
|
2086
|
+
# process refunds.
|
1821
2087
|
# Corresponds to the JSON property `processRefundDays`
|
1822
2088
|
# @return [Fixnum]
|
1823
2089
|
attr_accessor :process_refund_days
|
@@ -1827,8 +2093,7 @@ module Google
|
|
1827
2093
|
# @return [Google::Apis::MerchantapiAccountsV1beta::RestockingFee]
|
1828
2094
|
attr_accessor :restocking_fee
|
1829
2095
|
|
1830
|
-
# The field specifies the return label source.
|
1831
|
-
# return method is BY_MAIL.
|
2096
|
+
# Optional. The field specifies the return label source.
|
1832
2097
|
# Corresponds to the JSON property `returnLabelSource`
|
1833
2098
|
# @return [String]
|
1834
2099
|
attr_accessor :return_label_source
|
@@ -2320,14 +2585,26 @@ module Google
|
|
2320
2585
|
end
|
2321
2586
|
end
|
2322
2587
|
|
2588
|
+
# `ProductsManagement` payload.
|
2589
|
+
class ProductsManagement
|
2590
|
+
include Google::Apis::Core::Hashable
|
2591
|
+
|
2592
|
+
def initialize(**args)
|
2593
|
+
update!(**args)
|
2594
|
+
end
|
2595
|
+
|
2596
|
+
# Update properties of this object
|
2597
|
+
def update!(**args)
|
2598
|
+
end
|
2599
|
+
end
|
2600
|
+
|
2323
2601
|
# Defines participation in a given program for the specified account. Programs
|
2324
2602
|
# provide a mechanism for adding functionality to merchant accounts. A typical
|
2325
2603
|
# example of this is the [Free product listings](https://support.google.com/
|
2326
|
-
# merchants/
|
2327
|
-
#
|
2328
|
-
#
|
2329
|
-
#
|
2330
|
-
# shopping-checkout`
|
2604
|
+
# merchants/answer/13889434) program, which enables products from a merchant's
|
2605
|
+
# store to be shown across Google for free. The following list is the available
|
2606
|
+
# set of program resource IDs accessible through the API: * `free-listings` * `
|
2607
|
+
# shopping-ads` * `youtube-shopping-checkout`
|
2331
2608
|
class Program
|
2332
2609
|
include Google::Apis::Core::Hashable
|
2333
2610
|
|
@@ -2376,6 +2653,46 @@ module Google
|
|
2376
2653
|
end
|
2377
2654
|
end
|
2378
2655
|
|
2656
|
+
# Request to propose an account service.
|
2657
|
+
class ProposeAccountServiceRequest
|
2658
|
+
include Google::Apis::Core::Hashable
|
2659
|
+
|
2660
|
+
# The `AccountService` message represents a specific service that a provider
|
2661
|
+
# account offers to a merchant account. `AccountService` defines the permissions
|
2662
|
+
# and capabilities granted to the provider, allowing for operations such as
|
2663
|
+
# product management or campaign management. The lifecycle of an `AccountService`
|
2664
|
+
# involves a proposal phase, where one party suggests the service, and an
|
2665
|
+
# approval phase, where the other party accepts or rejects it. This handshake
|
2666
|
+
# mechanism ensures mutual consent before any access is granted. This mechanism
|
2667
|
+
# safeguards both parties by ensuring that access rights are granted
|
2668
|
+
# appropriately and that both the merchant and provider are aware of the
|
2669
|
+
# services enabled. In scenarios where a user is an admin of both accounts, the
|
2670
|
+
# approval can happen automatically. The mutability of a service is also managed
|
2671
|
+
# through `AccountService`. Some services might be immutable, for example, if
|
2672
|
+
# they were established through other systems or APIs, and you cannot alter them
|
2673
|
+
# through this API.
|
2674
|
+
# Corresponds to the JSON property `accountService`
|
2675
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountService]
|
2676
|
+
attr_accessor :account_service
|
2677
|
+
|
2678
|
+
# Required. The provider of the service. Either the reference to an account such
|
2679
|
+
# as `providers/123` or a well-known service provider (one of `providers/
|
2680
|
+
# GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
|
2681
|
+
# Corresponds to the JSON property `provider`
|
2682
|
+
# @return [String]
|
2683
|
+
attr_accessor :provider
|
2684
|
+
|
2685
|
+
def initialize(**args)
|
2686
|
+
update!(**args)
|
2687
|
+
end
|
2688
|
+
|
2689
|
+
# Update properties of this object
|
2690
|
+
def update!(**args)
|
2691
|
+
@account_service = args[:account_service] if args.key?(:account_service)
|
2692
|
+
@provider = args[:provider] if args.key?(:provider)
|
2693
|
+
end
|
2694
|
+
end
|
2695
|
+
|
2379
2696
|
# Shipping rate group definitions. Only the last one is allowed to have an empty
|
2380
2697
|
# `applicable_shipping_labels`, which means "everything else". The other `
|
2381
2698
|
# applicable_shipping_labels` must not overlap.
|
@@ -2496,6 +2813,19 @@ module Google
|
|
2496
2813
|
end
|
2497
2814
|
end
|
2498
2815
|
|
2816
|
+
# Request to reject an account service.
|
2817
|
+
class RejectAccountServiceRequest
|
2818
|
+
include Google::Apis::Core::Hashable
|
2819
|
+
|
2820
|
+
def initialize(**args)
|
2821
|
+
update!(**args)
|
2822
|
+
end
|
2823
|
+
|
2824
|
+
# Update properties of this object
|
2825
|
+
def update!(**args)
|
2826
|
+
end
|
2827
|
+
end
|
2828
|
+
|
2499
2829
|
# Describes the terms of service which are required to be accepted.
|
2500
2830
|
class Required
|
2501
2831
|
include Google::Apis::Core::Hashable
|
@@ -3039,7 +3369,7 @@ module Google
|
|
3039
3369
|
# before `valid_until` in order for the account to continue having a valid
|
3040
3370
|
# agreement. When accepting new terms of services we expect 3Ps to display the
|
3041
3371
|
# text associated with the given terms of service agreement (the url to the file
|
3042
|
-
# containing the text is added in the Required message below as `tos_file_uri
|
3372
|
+
# containing the text is added in the Required message below as `tos_file_uri`).
|
3043
3373
|
# The actual acceptance of the terms of service is done by calling accept on the
|
3044
3374
|
# `TermsOfService` resource.
|
3045
3375
|
class TermsOfServiceAgreementState
|
@@ -3367,7 +3697,8 @@ module Google
|
|
3367
3697
|
# @return [String]
|
3368
3698
|
attr_accessor :carrier_service
|
3369
3699
|
|
3370
|
-
# Required. Warehouse name. This should match warehouse
|
3700
|
+
# Required. Warehouse name. This should match [warehouse](/merchant/api/
|
3701
|
+
# reference/rest/accounts_v1beta/accounts.shippingSettings#warehouse)
|
3371
3702
|
# Corresponds to the JSON property `warehouse`
|
3372
3703
|
# @return [String]
|
3373
3704
|
attr_accessor :warehouse
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module MerchantapiAccountsV1beta
|
18
18
|
# Version of the google-apis-merchantapi_accounts_v1beta gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.12.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.17.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20250507"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -52,6 +52,24 @@ module Google
|
|
52
52
|
include Google::Apis::Core::JsonObjectSupport
|
53
53
|
end
|
54
54
|
|
55
|
+
class AccountManagement
|
56
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
57
|
+
|
58
|
+
include Google::Apis::Core::JsonObjectSupport
|
59
|
+
end
|
60
|
+
|
61
|
+
class AccountRelationship
|
62
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
63
|
+
|
64
|
+
include Google::Apis::Core::JsonObjectSupport
|
65
|
+
end
|
66
|
+
|
67
|
+
class AccountService
|
68
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
69
|
+
|
70
|
+
include Google::Apis::Core::JsonObjectSupport
|
71
|
+
end
|
72
|
+
|
55
73
|
class AddAccountService
|
56
74
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
57
75
|
|
@@ -70,6 +88,12 @@ module Google
|
|
70
88
|
include Google::Apis::Core::JsonObjectSupport
|
71
89
|
end
|
72
90
|
|
91
|
+
class ApproveAccountServiceRequest
|
92
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
93
|
+
|
94
|
+
include Google::Apis::Core::JsonObjectSupport
|
95
|
+
end
|
96
|
+
|
73
97
|
class AutofeedSettings
|
74
98
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
75
99
|
|
@@ -118,6 +142,12 @@ module Google
|
|
118
142
|
include Google::Apis::Core::JsonObjectSupport
|
119
143
|
end
|
120
144
|
|
145
|
+
class CampaignsManagement
|
146
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
147
|
+
|
148
|
+
include Google::Apis::Core::JsonObjectSupport
|
149
|
+
end
|
150
|
+
|
121
151
|
class CarrierRate
|
122
152
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
123
153
|
|
@@ -208,6 +238,12 @@ module Google
|
|
208
238
|
include Google::Apis::Core::JsonObjectSupport
|
209
239
|
end
|
210
240
|
|
241
|
+
class Handshake
|
242
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
243
|
+
|
244
|
+
include Google::Apis::Core::JsonObjectSupport
|
245
|
+
end
|
246
|
+
|
211
247
|
class Headers
|
212
248
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
213
249
|
|
@@ -256,6 +292,18 @@ module Google
|
|
256
292
|
include Google::Apis::Core::JsonObjectSupport
|
257
293
|
end
|
258
294
|
|
295
|
+
class ListAccountRelationshipsResponse
|
296
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
297
|
+
|
298
|
+
include Google::Apis::Core::JsonObjectSupport
|
299
|
+
end
|
300
|
+
|
301
|
+
class ListAccountServicesResponse
|
302
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
303
|
+
|
304
|
+
include Google::Apis::Core::JsonObjectSupport
|
305
|
+
end
|
306
|
+
|
259
307
|
class ListAccountsResponse
|
260
308
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
261
309
|
|
@@ -376,12 +424,24 @@ module Google
|
|
376
424
|
include Google::Apis::Core::JsonObjectSupport
|
377
425
|
end
|
378
426
|
|
427
|
+
class ProductsManagement
|
428
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
429
|
+
|
430
|
+
include Google::Apis::Core::JsonObjectSupport
|
431
|
+
end
|
432
|
+
|
379
433
|
class Program
|
380
434
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
381
435
|
|
382
436
|
include Google::Apis::Core::JsonObjectSupport
|
383
437
|
end
|
384
438
|
|
439
|
+
class ProposeAccountServiceRequest
|
440
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
441
|
+
|
442
|
+
include Google::Apis::Core::JsonObjectSupport
|
443
|
+
end
|
444
|
+
|
385
445
|
class RateGroup
|
386
446
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
387
447
|
|
@@ -394,6 +454,12 @@ module Google
|
|
394
454
|
include Google::Apis::Core::JsonObjectSupport
|
395
455
|
end
|
396
456
|
|
457
|
+
class RejectAccountServiceRequest
|
458
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
459
|
+
|
460
|
+
include Google::Apis::Core::JsonObjectSupport
|
461
|
+
end
|
462
|
+
|
397
463
|
class Required
|
398
464
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
399
465
|
|
@@ -595,6 +661,43 @@ module Google
|
|
595
661
|
end
|
596
662
|
end
|
597
663
|
|
664
|
+
class AccountManagement
|
665
|
+
# @private
|
666
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
667
|
+
end
|
668
|
+
end
|
669
|
+
|
670
|
+
class AccountRelationship
|
671
|
+
# @private
|
672
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
673
|
+
property :account_id_alias, as: 'accountIdAlias'
|
674
|
+
property :name, as: 'name'
|
675
|
+
property :provider, as: 'provider'
|
676
|
+
property :provider_display_name, as: 'providerDisplayName'
|
677
|
+
end
|
678
|
+
end
|
679
|
+
|
680
|
+
class AccountService
|
681
|
+
# @private
|
682
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
683
|
+
property :account_aggregation, as: 'accountAggregation', class: Google::Apis::MerchantapiAccountsV1beta::AccountAggregation, decorator: Google::Apis::MerchantapiAccountsV1beta::AccountAggregation::Representation
|
684
|
+
|
685
|
+
property :account_management, as: 'accountManagement', class: Google::Apis::MerchantapiAccountsV1beta::AccountManagement, decorator: Google::Apis::MerchantapiAccountsV1beta::AccountManagement::Representation
|
686
|
+
|
687
|
+
property :campaigns_management, as: 'campaignsManagement', class: Google::Apis::MerchantapiAccountsV1beta::CampaignsManagement, decorator: Google::Apis::MerchantapiAccountsV1beta::CampaignsManagement::Representation
|
688
|
+
|
689
|
+
property :external_account_id, as: 'externalAccountId'
|
690
|
+
property :handshake, as: 'handshake', class: Google::Apis::MerchantapiAccountsV1beta::Handshake, decorator: Google::Apis::MerchantapiAccountsV1beta::Handshake::Representation
|
691
|
+
|
692
|
+
property :mutability, as: 'mutability'
|
693
|
+
property :name, as: 'name'
|
694
|
+
property :products_management, as: 'productsManagement', class: Google::Apis::MerchantapiAccountsV1beta::ProductsManagement, decorator: Google::Apis::MerchantapiAccountsV1beta::ProductsManagement::Representation
|
695
|
+
|
696
|
+
property :provider, as: 'provider'
|
697
|
+
property :provider_display_name, as: 'providerDisplayName'
|
698
|
+
end
|
699
|
+
end
|
700
|
+
|
598
701
|
class AddAccountService
|
599
702
|
# @private
|
600
703
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -624,6 +727,12 @@ module Google
|
|
624
727
|
end
|
625
728
|
end
|
626
729
|
|
730
|
+
class ApproveAccountServiceRequest
|
731
|
+
# @private
|
732
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
733
|
+
end
|
734
|
+
end
|
735
|
+
|
627
736
|
class AutofeedSettings
|
628
737
|
# @private
|
629
738
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -714,6 +823,12 @@ module Google
|
|
714
823
|
end
|
715
824
|
end
|
716
825
|
|
826
|
+
class CampaignsManagement
|
827
|
+
# @private
|
828
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
829
|
+
end
|
830
|
+
end
|
831
|
+
|
717
832
|
class CarrierRate
|
718
833
|
# @private
|
719
834
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -857,6 +972,14 @@ module Google
|
|
857
972
|
end
|
858
973
|
end
|
859
974
|
|
975
|
+
class Handshake
|
976
|
+
# @private
|
977
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
978
|
+
property :actor, as: 'actor'
|
979
|
+
property :approval_state, as: 'approvalState'
|
980
|
+
end
|
981
|
+
end
|
982
|
+
|
860
983
|
class Headers
|
861
984
|
# @private
|
862
985
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -930,6 +1053,24 @@ module Google
|
|
930
1053
|
end
|
931
1054
|
end
|
932
1055
|
|
1056
|
+
class ListAccountRelationshipsResponse
|
1057
|
+
# @private
|
1058
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1059
|
+
collection :account_relationships, as: 'accountRelationships', class: Google::Apis::MerchantapiAccountsV1beta::AccountRelationship, decorator: Google::Apis::MerchantapiAccountsV1beta::AccountRelationship::Representation
|
1060
|
+
|
1061
|
+
property :next_page_token, as: 'nextPageToken'
|
1062
|
+
end
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
class ListAccountServicesResponse
|
1066
|
+
# @private
|
1067
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1068
|
+
collection :account_services, as: 'accountServices', class: Google::Apis::MerchantapiAccountsV1beta::AccountService, decorator: Google::Apis::MerchantapiAccountsV1beta::AccountService::Representation
|
1069
|
+
|
1070
|
+
property :next_page_token, as: 'nextPageToken'
|
1071
|
+
end
|
1072
|
+
end
|
1073
|
+
|
933
1074
|
class ListAccountsResponse
|
934
1075
|
# @private
|
935
1076
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1134,6 +1275,12 @@ module Google
|
|
1134
1275
|
end
|
1135
1276
|
end
|
1136
1277
|
|
1278
|
+
class ProductsManagement
|
1279
|
+
# @private
|
1280
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1281
|
+
end
|
1282
|
+
end
|
1283
|
+
|
1137
1284
|
class Program
|
1138
1285
|
# @private
|
1139
1286
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1146,6 +1293,15 @@ module Google
|
|
1146
1293
|
end
|
1147
1294
|
end
|
1148
1295
|
|
1296
|
+
class ProposeAccountServiceRequest
|
1297
|
+
# @private
|
1298
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1299
|
+
property :account_service, as: 'accountService', class: Google::Apis::MerchantapiAccountsV1beta::AccountService, decorator: Google::Apis::MerchantapiAccountsV1beta::AccountService::Representation
|
1300
|
+
|
1301
|
+
property :provider, as: 'provider'
|
1302
|
+
end
|
1303
|
+
end
|
1304
|
+
|
1149
1305
|
class RateGroup
|
1150
1306
|
# @private
|
1151
1307
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1176,6 +1332,12 @@ module Google
|
|
1176
1332
|
end
|
1177
1333
|
end
|
1178
1334
|
|
1335
|
+
class RejectAccountServiceRequest
|
1336
|
+
# @private
|
1337
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1338
|
+
end
|
1339
|
+
end
|
1340
|
+
|
1179
1341
|
class Required
|
1180
1342
|
# @private
|
1181
1343
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -210,7 +210,7 @@ module Google
|
|
210
210
|
# the same results as calling `ListsAccounts` with the following filter: `
|
211
211
|
# relationship(providerId=`parent` AND service(type="ACCOUNT_AGGREGATION"))`
|
212
212
|
# @param [String] provider
|
213
|
-
# Required. The aggregation service provider. Format: `accounts/`
|
213
|
+
# Required. The aggregation service provider. Format: `accounts/`accountId``
|
214
214
|
# @param [Fixnum] page_size
|
215
215
|
# Optional. The maximum number of accounts to return. The service may return
|
216
216
|
# fewer than this value. If unspecified, at most 250 accounts are returned. The
|
@@ -651,10 +651,11 @@ module Google
|
|
651
651
|
# merchant is exempted from claiming, which also exempts from verification) and
|
652
652
|
# return a successful response. If ownership can no longer be verified, it will
|
653
653
|
# return an error, but it won't clear the claim. In case of failure, a canonical
|
654
|
-
# error message
|
655
|
-
# necessary permissions on this
|
656
|
-
# is not a Merchant Center account
|
657
|
-
#
|
654
|
+
# error message is returned: * PERMISSION_DENIED: User doesn't have the
|
655
|
+
# necessary permissions on this Merchant Center account. * FAILED_PRECONDITION: -
|
656
|
+
# The account is not a Merchant Center account. - Merchant Center account doesn'
|
657
|
+
# t have a homepage. - Claiming failed (in this case the error message contains
|
658
|
+
# more details).
|
658
659
|
# @param [String] name
|
659
660
|
# Required. The name of the homepage to claim. Format: `accounts/`account`/
|
660
661
|
# homepage`
|
@@ -1244,6 +1245,286 @@ module Google
|
|
1244
1245
|
execute_or_queue_command(command, &block)
|
1245
1246
|
end
|
1246
1247
|
|
1248
|
+
# Retrieve an account relationship.
|
1249
|
+
# @param [String] name
|
1250
|
+
# Required. The resource name of the account relationship to get. Format: `
|
1251
|
+
# accounts/`account`/relationships/`relationship``
|
1252
|
+
# @param [String] fields
|
1253
|
+
# Selector specifying which fields to include in a partial response.
|
1254
|
+
# @param [String] quota_user
|
1255
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1256
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1257
|
+
# @param [Google::Apis::RequestOptions] options
|
1258
|
+
# Request-specific options
|
1259
|
+
#
|
1260
|
+
# @yield [result, err] Result & error if block supplied
|
1261
|
+
# @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::AccountRelationship] parsed result object
|
1262
|
+
# @yieldparam err [StandardError] error object if request failed
|
1263
|
+
#
|
1264
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountRelationship]
|
1265
|
+
#
|
1266
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1267
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1268
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1269
|
+
def get_account_relationship(name, fields: nil, quota_user: nil, options: nil, &block)
|
1270
|
+
command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
|
1271
|
+
command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship::Representation
|
1272
|
+
command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship
|
1273
|
+
command.params['name'] = name unless name.nil?
|
1274
|
+
command.query['fields'] = fields unless fields.nil?
|
1275
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1276
|
+
execute_or_queue_command(command, &block)
|
1277
|
+
end
|
1278
|
+
|
1279
|
+
# List account relationships for the specified account.
|
1280
|
+
# @param [String] parent
|
1281
|
+
# Required. The parent account of the account relationship to filter by. Format:
|
1282
|
+
# `accounts/`account``
|
1283
|
+
# @param [Fixnum] page_size
|
1284
|
+
# Optional. The maximum number of elements to return in the response. Use for
|
1285
|
+
# paging. If no `page_size` is specified, `100` is used as the default value.
|
1286
|
+
# The maximum allowed value is `1000`.
|
1287
|
+
# @param [String] page_token
|
1288
|
+
# Optional. The token returned by the previous `list` request.
|
1289
|
+
# @param [String] fields
|
1290
|
+
# Selector specifying which fields to include in a partial response.
|
1291
|
+
# @param [String] quota_user
|
1292
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1293
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1294
|
+
# @param [Google::Apis::RequestOptions] options
|
1295
|
+
# Request-specific options
|
1296
|
+
#
|
1297
|
+
# @yield [result, err] Result & error if block supplied
|
1298
|
+
# @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::ListAccountRelationshipsResponse] parsed result object
|
1299
|
+
# @yieldparam err [StandardError] error object if request failed
|
1300
|
+
#
|
1301
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::ListAccountRelationshipsResponse]
|
1302
|
+
#
|
1303
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1304
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1305
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1306
|
+
def list_account_relationships(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1307
|
+
command = make_simple_command(:get, 'accounts/v1beta/{+parent}/relationships', options)
|
1308
|
+
command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListAccountRelationshipsResponse::Representation
|
1309
|
+
command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListAccountRelationshipsResponse
|
1310
|
+
command.params['parent'] = parent unless parent.nil?
|
1311
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1312
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1313
|
+
command.query['fields'] = fields unless fields.nil?
|
1314
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1315
|
+
execute_or_queue_command(command, &block)
|
1316
|
+
end
|
1317
|
+
|
1318
|
+
# Updates the account relationship. Executing this method requires admin access.
|
1319
|
+
# @param [String] name
|
1320
|
+
# Identifier. The resource name of the account relationship. Format: `accounts/`
|
1321
|
+
# account`/relationships/`relationship``
|
1322
|
+
# @param [Google::Apis::MerchantapiAccountsV1beta::AccountRelationship] account_relationship_object
|
1323
|
+
# @param [String] update_mask
|
1324
|
+
# Optional. List of fields being updated. The following fields are supported (in
|
1325
|
+
# both `snake_case` and `lowerCamelCase`): - `account_id_alias`
|
1326
|
+
# @param [String] fields
|
1327
|
+
# Selector specifying which fields to include in a partial response.
|
1328
|
+
# @param [String] quota_user
|
1329
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1330
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1331
|
+
# @param [Google::Apis::RequestOptions] options
|
1332
|
+
# Request-specific options
|
1333
|
+
#
|
1334
|
+
# @yield [result, err] Result & error if block supplied
|
1335
|
+
# @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::AccountRelationship] parsed result object
|
1336
|
+
# @yieldparam err [StandardError] error object if request failed
|
1337
|
+
#
|
1338
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountRelationship]
|
1339
|
+
#
|
1340
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1341
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1342
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1343
|
+
def patch_account_relationship(name, account_relationship_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1344
|
+
command = make_simple_command(:patch, 'accounts/v1beta/{+name}', options)
|
1345
|
+
command.request_representation = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship::Representation
|
1346
|
+
command.request_object = account_relationship_object
|
1347
|
+
command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship::Representation
|
1348
|
+
command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship
|
1349
|
+
command.params['name'] = name unless name.nil?
|
1350
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1351
|
+
command.query['fields'] = fields unless fields.nil?
|
1352
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1353
|
+
execute_or_queue_command(command, &block)
|
1354
|
+
end
|
1355
|
+
|
1356
|
+
# Approve an account service proposal.
|
1357
|
+
# @param [String] name
|
1358
|
+
# Required. The resource name of the account service to approve. Format: `
|
1359
|
+
# accounts/`account`/services/`service``
|
1360
|
+
# @param [Google::Apis::MerchantapiAccountsV1beta::ApproveAccountServiceRequest] approve_account_service_request_object
|
1361
|
+
# @param [String] fields
|
1362
|
+
# Selector specifying which fields to include in a partial response.
|
1363
|
+
# @param [String] quota_user
|
1364
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1365
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1366
|
+
# @param [Google::Apis::RequestOptions] options
|
1367
|
+
# Request-specific options
|
1368
|
+
#
|
1369
|
+
# @yield [result, err] Result & error if block supplied
|
1370
|
+
# @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::AccountService] parsed result object
|
1371
|
+
# @yieldparam err [StandardError] error object if request failed
|
1372
|
+
#
|
1373
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountService]
|
1374
|
+
#
|
1375
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1376
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1377
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1378
|
+
def approve_account_service(name, approve_account_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1379
|
+
command = make_simple_command(:post, 'accounts/v1beta/{+name}:approve', options)
|
1380
|
+
command.request_representation = Google::Apis::MerchantapiAccountsV1beta::ApproveAccountServiceRequest::Representation
|
1381
|
+
command.request_object = approve_account_service_request_object
|
1382
|
+
command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountService::Representation
|
1383
|
+
command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountService
|
1384
|
+
command.params['name'] = name unless name.nil?
|
1385
|
+
command.query['fields'] = fields unless fields.nil?
|
1386
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1387
|
+
execute_or_queue_command(command, &block)
|
1388
|
+
end
|
1389
|
+
|
1390
|
+
# Retrieve an account service.
|
1391
|
+
# @param [String] name
|
1392
|
+
# Required. The resource name of the account service to get. Format: `accounts/`
|
1393
|
+
# account`/services/`service``
|
1394
|
+
# @param [String] fields
|
1395
|
+
# Selector specifying which fields to include in a partial response.
|
1396
|
+
# @param [String] quota_user
|
1397
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1398
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1399
|
+
# @param [Google::Apis::RequestOptions] options
|
1400
|
+
# Request-specific options
|
1401
|
+
#
|
1402
|
+
# @yield [result, err] Result & error if block supplied
|
1403
|
+
# @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::AccountService] parsed result object
|
1404
|
+
# @yieldparam err [StandardError] error object if request failed
|
1405
|
+
#
|
1406
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountService]
|
1407
|
+
#
|
1408
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1409
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1410
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1411
|
+
def get_account_service(name, fields: nil, quota_user: nil, options: nil, &block)
|
1412
|
+
command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
|
1413
|
+
command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountService::Representation
|
1414
|
+
command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountService
|
1415
|
+
command.params['name'] = name unless name.nil?
|
1416
|
+
command.query['fields'] = fields unless fields.nil?
|
1417
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1418
|
+
execute_or_queue_command(command, &block)
|
1419
|
+
end
|
1420
|
+
|
1421
|
+
# List account services for the specified accounts. Supports filtering.
|
1422
|
+
# @param [String] parent
|
1423
|
+
# Required. The parent account of the account service to filter by. Format: `
|
1424
|
+
# accounts/`account``
|
1425
|
+
# @param [Fixnum] page_size
|
1426
|
+
# Optional. The maximum number of elements to return in the response. Use for
|
1427
|
+
# paging. If no `page_size` is specified, `100` is used as the default value.
|
1428
|
+
# The maximum allowed value is `1000`.
|
1429
|
+
# @param [String] page_token
|
1430
|
+
# Optional. The token returned by the previous `list` request.
|
1431
|
+
# @param [String] fields
|
1432
|
+
# Selector specifying which fields to include in a partial response.
|
1433
|
+
# @param [String] quota_user
|
1434
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1435
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1436
|
+
# @param [Google::Apis::RequestOptions] options
|
1437
|
+
# Request-specific options
|
1438
|
+
#
|
1439
|
+
# @yield [result, err] Result & error if block supplied
|
1440
|
+
# @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::ListAccountServicesResponse] parsed result object
|
1441
|
+
# @yieldparam err [StandardError] error object if request failed
|
1442
|
+
#
|
1443
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::ListAccountServicesResponse]
|
1444
|
+
#
|
1445
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1446
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1447
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1448
|
+
def list_account_services(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1449
|
+
command = make_simple_command(:get, 'accounts/v1beta/{+parent}/services', options)
|
1450
|
+
command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListAccountServicesResponse::Representation
|
1451
|
+
command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListAccountServicesResponse
|
1452
|
+
command.params['parent'] = parent unless parent.nil?
|
1453
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1454
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1455
|
+
command.query['fields'] = fields unless fields.nil?
|
1456
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1457
|
+
execute_or_queue_command(command, &block)
|
1458
|
+
end
|
1459
|
+
|
1460
|
+
# Propose an account service.
|
1461
|
+
# @param [String] parent
|
1462
|
+
# Required. The resource name of the parent account for the service. Format: `
|
1463
|
+
# accounts/`account``
|
1464
|
+
# @param [Google::Apis::MerchantapiAccountsV1beta::ProposeAccountServiceRequest] propose_account_service_request_object
|
1465
|
+
# @param [String] fields
|
1466
|
+
# Selector specifying which fields to include in a partial response.
|
1467
|
+
# @param [String] quota_user
|
1468
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1469
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1470
|
+
# @param [Google::Apis::RequestOptions] options
|
1471
|
+
# Request-specific options
|
1472
|
+
#
|
1473
|
+
# @yield [result, err] Result & error if block supplied
|
1474
|
+
# @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::AccountService] parsed result object
|
1475
|
+
# @yieldparam err [StandardError] error object if request failed
|
1476
|
+
#
|
1477
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::AccountService]
|
1478
|
+
#
|
1479
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1480
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1481
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1482
|
+
def propose_account_service(parent, propose_account_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1483
|
+
command = make_simple_command(:post, 'accounts/v1beta/{+parent}/services:propose', options)
|
1484
|
+
command.request_representation = Google::Apis::MerchantapiAccountsV1beta::ProposeAccountServiceRequest::Representation
|
1485
|
+
command.request_object = propose_account_service_request_object
|
1486
|
+
command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountService::Representation
|
1487
|
+
command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountService
|
1488
|
+
command.params['parent'] = parent unless parent.nil?
|
1489
|
+
command.query['fields'] = fields unless fields.nil?
|
1490
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1491
|
+
execute_or_queue_command(command, &block)
|
1492
|
+
end
|
1493
|
+
|
1494
|
+
# Reject an account service (both proposed and approve services can be rejected).
|
1495
|
+
# @param [String] name
|
1496
|
+
# Required. The resource name of the account service to reject. Format: `
|
1497
|
+
# accounts/`account`/services/`service``
|
1498
|
+
# @param [Google::Apis::MerchantapiAccountsV1beta::RejectAccountServiceRequest] reject_account_service_request_object
|
1499
|
+
# @param [String] fields
|
1500
|
+
# Selector specifying which fields to include in a partial response.
|
1501
|
+
# @param [String] quota_user
|
1502
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1503
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1504
|
+
# @param [Google::Apis::RequestOptions] options
|
1505
|
+
# Request-specific options
|
1506
|
+
#
|
1507
|
+
# @yield [result, err] Result & error if block supplied
|
1508
|
+
# @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::Empty] parsed result object
|
1509
|
+
# @yieldparam err [StandardError] error object if request failed
|
1510
|
+
#
|
1511
|
+
# @return [Google::Apis::MerchantapiAccountsV1beta::Empty]
|
1512
|
+
#
|
1513
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1514
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1515
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1516
|
+
def reject_account_service(name, reject_account_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1517
|
+
command = make_simple_command(:post, 'accounts/v1beta/{+name}:reject', options)
|
1518
|
+
command.request_representation = Google::Apis::MerchantapiAccountsV1beta::RejectAccountServiceRequest::Representation
|
1519
|
+
command.request_object = reject_account_service_request_object
|
1520
|
+
command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Empty::Representation
|
1521
|
+
command.response_class = Google::Apis::MerchantapiAccountsV1beta::Empty
|
1522
|
+
command.params['name'] = name unless name.nil?
|
1523
|
+
command.query['fields'] = fields unless fields.nil?
|
1524
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1525
|
+
execute_or_queue_command(command, &block)
|
1526
|
+
end
|
1527
|
+
|
1247
1528
|
# Retrieve shipping setting information.
|
1248
1529
|
# @param [String] name
|
1249
1530
|
# Required. The name of the shipping setting to retrieve. Format: `accounts/`
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-merchantapi_accounts_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.12.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
bindir: bin
|
9
9
|
cert_chain: []
|
10
|
-
date:
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
11
11
|
dependencies:
|
12
12
|
- !ruby/object:Gem::Dependency
|
13
13
|
name: google-apis-core
|
@@ -57,7 +57,7 @@ licenses:
|
|
57
57
|
metadata:
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-merchantapi_accounts_v1beta/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-merchantapi_accounts_v1beta/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-merchantapi_accounts_v1beta/v0.12.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-merchantapi_accounts_v1beta
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|
@@ -66,14 +66,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
66
66
|
requirements:
|
67
67
|
- - ">="
|
68
68
|
- !ruby/object:Gem::Version
|
69
|
-
version: '
|
69
|
+
version: '3.1'
|
70
70
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
71
71
|
requirements:
|
72
72
|
- - ">="
|
73
73
|
- !ruby/object:Gem::Version
|
74
74
|
version: '0'
|
75
75
|
requirements: []
|
76
|
-
rubygems_version: 3.6.
|
76
|
+
rubygems_version: 3.6.8
|
77
77
|
specification_version: 4
|
78
78
|
summary: Simple REST client for Merchant API AccountsV1beta
|
79
79
|
test_files: []
|