Package google.shopping.merchant.accounts.v1beta

Index

• AccountIssueService (interface)
• AccountRelationshipsService (interface)
• AccountServicesService (interface)
• AccountsService (interface)
• AutofeedSettingsService (interface)
• AutomaticImprovementsService (interface)
• BusinessIdentityService (interface)
• BusinessInfoService (interface)
• EmailPreferencesService (interface)
• GbpAccountsService (interface)
• HomepageService (interface)
• LfpProvidersService (interface)
• OmnichannelSettingsService (interface)
• OnlineReturnPolicyService (interface)
• ProgramsService (interface)
• RegionsService (interface)
• ShippingSettingsService (interface)
• TermsOfServiceAgreementStateService (interface)
• TermsOfServiceService (interface)
• UserService (interface)
• About (message)
• AcceptTermsOfServiceRequest (message)
• AcceptTermsOfServiceResponse (message)
• Accepted (message)
• AccessRight (enum)
• Account (message)
• AccountAggregation (message)
• AccountIssue (message)
• AccountIssue.ImpactedDestination (message)
• AccountIssue.ImpactedDestination.Impact (message)
• AccountIssue.Severity (enum)
• AccountManagement (message)
• AccountRelationship (message)
• AccountService (message)
• AccountService.Mutability (enum)
• Address (message)
• ApproveAccountServiceRequest (message)
• AutofeedSettings (message)
• AutomaticImageImprovements (message)
• AutomaticImageImprovements.ImageImprovementsAccountLevelSettings (message)
• AutomaticImprovements (message)
• AutomaticItemUpdates (message)
• AutomaticItemUpdates.ItemUpdatesAccountLevelSettings (message)
• AutomaticShippingImprovements (message)
• BusinessDayConfig (message)
• BusinessDayConfig.Weekday (enum)
• BusinessIdentity (message)
• BusinessIdentity.IdentityAttribute (message)
• BusinessIdentity.IdentityAttribute.IdentityDeclaration (enum)
• BusinessIdentity.PromotionsConsent (enum)
• BusinessInfo (message)
• CampaignsManagement (message)
• CarrierRate (message)
• ClaimHomepageRequest (message)
• CreateAndConfigureAccountRequest (message)
• CreateAndConfigureAccountRequest.AddAccountService (message)
• CreateAndConfigureAccountRequest.AddUser (message)
• CreateOmnichannelSettingRequest (message)
• CreateOnlineReturnPolicyRequest (message)
• CreateRegionRequest (message)
• CreateUserRequest (message)
• CustomerService (message)
• CutoffTime (message)
• DeleteAccountRequest (message)
• DeleteOnlineReturnPolicyRequest (message)
• DeleteRegionRequest (message)
• DeleteUserRequest (message)
• DeliveryTime (message)
• DisableProgramRequest (message)
• Distance (message)
• Distance.Unit (enum)
• EmailPreferences (message)
• EmailPreferences.OptInState (enum)
• EnableProgramRequest (message)
• FindLfpProvidersRequest (message)
• FindLfpProvidersResponse (message)
• GbpAccount (message)
• GbpAccount.Type (enum)
• GetAccountRelationshipRequest (message)
• GetAccountRequest (message)
• GetAccountServiceRequest (message)
• GetAutofeedSettingsRequest (message)
• GetAutomaticImprovementsRequest (message)
• GetBusinessIdentityRequest (message)
• GetBusinessInfoRequest (message)
• GetEmailPreferencesRequest (message)
• GetHomepageRequest (message)
• GetOmnichannelSettingRequest (message)
• GetOnlineReturnPolicyRequest (message)
• GetProgramRequest (message)
• GetRegionRequest (message)
• GetShippingSettingsRequest (message)
• GetTermsOfServiceAgreementStateRequest (message)
• GetTermsOfServiceRequest (message)
• GetUserRequest (message)
• Handshake (message)
• Handshake.Actor (enum)
• Handshake.ApprovalState (enum)
• Headers (message)
• Homepage (message)
• InStock (message)
• InsertShippingSettingsRequest (message)
• InventoryVerification (message)
• InventoryVerification.State (enum)
• LfpLink (message)
• LfpProvider (message)
• LinkGbpAccountRequest (message)
• LinkGbpAccountResponse (message)
• LinkLfpProviderRequest (message)
• LinkLfpProviderResponse (message)
• ListAccountIssuesRequest (message)
• ListAccountIssuesResponse (message)
• ListAccountRelationshipsRequest (message)
• ListAccountRelationshipsResponse (message)
• ListAccountServicesRequest (message)
• ListAccountServicesResponse (message)
• ListAccountsRequest (message)
• ListAccountsResponse (message)
• ListGbpAccountsRequest (message)
• ListGbpAccountsResponse (message)
• ListOmnichannelSettingsRequest (message)
• ListOmnichannelSettingsResponse (message)
• ListOnlineReturnPoliciesRequest (message)
• ListOnlineReturnPoliciesResponse (message)
• ListProgramsRequest (message)
• ListProgramsResponse (message)
• ListRegionsRequest (message)
• ListRegionsResponse (message)
• ListSubAccountsRequest (message)
• ListSubAccountsResponse (message)
• ListUsersRequest (message)
• ListUsersResponse (message)
• LocalListingManagement (message)
• LocationIdSet (message)
• MinimumOrderValueTable (message)
• MinimumOrderValueTable.StoreCodeSetWithMov (message)
• OmnichannelSetting (message)
• OmnichannelSetting.LsfType (enum)
• OnDisplayToOrder (message)
• OnlineReturnPolicy (message)
• OnlineReturnPolicy.ItemCondition (enum)
• OnlineReturnPolicy.Policy (message)
• OnlineReturnPolicy.Policy.Type (enum)
• OnlineReturnPolicy.RestockingFee (message)
• OnlineReturnPolicy.ReturnLabelSource (enum)
• OnlineReturnPolicy.ReturnMethod (enum)
• OnlineReturnPolicy.ReturnShippingFee (message)
• OnlineReturnPolicy.ReturnShippingFee.Type (enum)
• OnlineReturnPolicy.SeasonalOverride (message)
• PhoneVerificationState (enum)
• Pickup (message)
• ProductsManagement (message)
• Program (message)
• Program.Requirement (message)
• Program.State (enum)
• ProposeAccountServiceRequest (message)
• RateGroup (message)
• Region (message)
• Region.GeoTargetArea (message)
• Region.PostalCodeArea (message)
• Region.PostalCodeArea.PostalCodeRange (message)
• RejectAccountServiceRequest (message)
• RequestInventoryVerificationRequest (message)
• RequestInventoryVerificationResponse (message)
• Required (message)
• RetrieveForApplicationTermsOfServiceAgreementStateRequest (message)
• RetrieveLatestTermsOfServiceRequest (message)
• ReviewState (message)
• ReviewState.State (enum)
• Row (message)
• Service (message)
• Service.LoyaltyProgram (message)
• Service.LoyaltyProgram.LoyaltyProgramTiers (message)
• Service.ShipmentType (enum)
• Service.StoreConfig (message)
• Service.StoreConfig.CutoffConfig (message)
• Service.StoreConfig.CutoffConfig.LocalCutoffTime (message)
• Service.StoreConfig.StoreServiceType (enum)
• ShippingSettings (message)
• Table (message)
• TermsOfService (message)
• TermsOfServiceAgreementState (message)
• TermsOfServiceKind (enum)
• TransitTable (message)
• TransitTable.TransitTimeRow (message)
• TransitTable.TransitTimeRow.TransitTimeValue (message)
• UnclaimHomepageRequest (message)
• UpdateAccountRelationshipRequest (message)
• UpdateAccountRequest (message)
• UpdateAutofeedSettingsRequest (message)
• UpdateAutomaticImprovementsRequest (message)
• UpdateBusinessIdentityRequest (message)
• UpdateBusinessInfoRequest (message)
• UpdateEmailPreferencesRequest (message)
• UpdateHomepageRequest (message)
• UpdateOmnichannelSettingRequest (message)
• UpdateOnlineReturnPolicyRequest (message)
• UpdateRegionRequest (message)
• UpdateUserRequest (message)
• User (message)
• User.State (enum)
• Value (message)
• Warehouse (message)
• WarehouseBasedDeliveryTime (message)
• WarehouseCutoffTime (message)

AccountIssueService

Service to support AccountIssueService API.

ListAccountIssues

rpc ListAccountIssues(ListAccountIssuesRequest) returns (ListAccountIssuesResponse) Lists all account issues of a Merchant Center account. When called on a multi-client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call accounts.issues.list for each sub-account individually. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

AccountRelationshipsService

Service to support AccountRelationship API.

GetAccountRelationship
rpc GetAccountRelationship(GetAccountRelationshipRequest) returns (AccountRelationship) Retrieve an account relationship. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListAccountRelationships
rpc ListAccountRelationships(ListAccountRelationshipsRequest) returns (ListAccountRelationshipsResponse) List account relationships for the specified account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateAccountRelationship
rpc UpdateAccountRelationship(UpdateAccountRelationshipRequest) returns (AccountRelationship) Updates the account relationship. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

AccountServicesService

Service to support AccountService API.

ApproveAccountService
rpc ApproveAccountService(ApproveAccountServiceRequest) returns (AccountService) Approve an account service proposal. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetAccountService
rpc GetAccountService(GetAccountServiceRequest) returns (AccountService) Retrieve an account service. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListAccountServices
rpc ListAccountServices(ListAccountServicesRequest) returns (ListAccountServicesResponse) List account services for the specified accounts. Supports filtering. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ProposeAccountService
rpc ProposeAccountService(ProposeAccountServiceRequest) returns (AccountService) Propose an account service. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

RejectAccountService
rpc RejectAccountService(RejectAccountServiceRequest) returns (Empty) Reject an account service (both proposed and approve services can be rejected). Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

AccountsService

Service to support Accounts API.

CreateAndConfigureAccount
rpc CreateAndConfigureAccount(CreateAndConfigureAccountRequest) returns (Account) Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty) Deletes the specified account regardless of its type: standalone, advanced account or sub-account. Deleting an advanced account leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetAccount
rpc GetAccount(GetAccountRequest) returns (Account) Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) Note: For the accounts.list method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the accounts.listSubaccounts method, which is more suitable for advanced accounts use case. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListSubAccounts

rpc ListSubAccounts(ListSubAccountsRequest) returns (ListSubAccountsResponse) List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful ListAccounts method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION")) Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateAccount
rpc UpdateAccount(UpdateAccountRequest) returns (Account) Updates an account regardless of its type: standalone, advanced account or sub-account. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

AutofeedSettingsService

Service to support autofeed setting.

GetAutofeedSettings
rpc GetAutofeedSettings(GetAutofeedSettingsRequest) returns (AutofeedSettings) Retrieves the autofeed settings of an account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateAutofeedSettings
rpc UpdateAutofeedSettings(UpdateAutofeedSettingsRequest) returns (AutofeedSettings) Updates the autofeed settings of an account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

AutomaticImprovementsService

Service to manage the automatic improvements of an account. The automatic improvements of the account can be used to automatically update products, improve images and shipping.

GetAutomaticImprovements
rpc GetAutomaticImprovements(GetAutomaticImprovementsRequest) returns (AutomaticImprovements) Retrieves the automatic improvements of an account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateAutomaticImprovements
rpc UpdateAutomaticImprovements(UpdateAutomaticImprovementsRequest) returns (AutomaticImprovements) Updates the automatic improvements of an account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

BusinessIdentityService

Service to support business identity API.

GetBusinessIdentity
rpc GetBusinessIdentity(GetBusinessIdentityRequest) returns (BusinessIdentity) Retrieves the business identity of an account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateBusinessIdentity
rpc UpdateBusinessIdentity(UpdateBusinessIdentityRequest) returns (BusinessIdentity) Updates the business identity of an account. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

BusinessInfoService

Service to support business info API.

GetBusinessInfo
rpc GetBusinessInfo(GetBusinessInfoRequest) returns (BusinessInfo) Retrieves the business info of an account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateBusinessInfo
rpc UpdateBusinessInfo(UpdateBusinessInfoRequest) returns (BusinessInfo) Updates the business info of an account. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

EmailPreferencesService

Service to support the EmailPreferences API.

GetEmailPreferences

rpc GetEmailPreferences(GetEmailPreferencesRequest) returns (EmailPreferences) Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateEmailPreferences

rpc UpdateEmailPreferences(UpdateEmailPreferencesRequest) returns (EmailPreferences) Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GbpAccountsService

The service facilitates the management of a merchant's Google Business Profile (GBP) account settings. This API defines the following resource model: - [GbpAccount][google.shopping.merchant.accounts.v1.GbpAccount]

LinkGbpAccount
rpc LinkGbpAccount(LinkGbpAccountRequest) returns (LinkGbpAccountResponse) Link the specified merchant to a GBP account for all countries. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListGbpAccounts
rpc ListGbpAccounts(ListGbpAccountsRequest) returns (ListGbpAccountsResponse) List the GBP accounts for a given merchant. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

HomepageService

Service to support an API for a store's homepage.

ClaimHomepage

rpc ClaimHomepage(ClaimHomepageRequest) returns (Homepage) Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the business is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message is returned: PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account. FAILED_PRECONDITION: - The account is not a Merchant Center account. - Merchant Center account doesn't have a homepage. - Claiming failed (in this case the error message contains more details). Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetHomepage
rpc GetHomepage(GetHomepageRequest) returns (Homepage) Retrieves a store's homepage. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UnclaimHomepage
rpc UnclaimHomepage(UnclaimHomepageRequest) returns (Homepage) Unclaims a store's homepage. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateHomepage
rpc UpdateHomepage(UpdateHomepageRequest) returns (Homepage) Updates a store's homepage. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

LfpProvidersService

The service facilitates the management of a merchant's LFP provider settings. This API defines the following resource model: - [LfpProvider][google.shopping.merchant.accounts.v1.LfpProvider]

FindLfpProviders
rpc FindLfpProviders(FindLfpProvidersRequest) returns (FindLfpProvidersResponse) Find the LFP provider candidates in a given country. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

LinkLfpProvider
rpc LinkLfpProvider(LinkLfpProviderRequest) returns (LinkLfpProviderResponse) Link the specified merchant to a LFP provider for the specified country. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

OmnichannelSettingsService

The service facilitates the management of a merchant's omnichannel settings.

This API defines the following resource model:

[OmnichannelSetting][google.shopping.merchant.accounts.v1.OmnichannelSetting]

CreateOmnichannelSetting
rpc CreateOmnichannelSetting(CreateOmnichannelSettingRequest) returns (OmnichannelSetting) Create the omnichannel settings for a given merchant. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetOmnichannelSetting
rpc GetOmnichannelSetting(GetOmnichannelSettingRequest) returns (OmnichannelSetting) Get the omnichannel settings for a given merchant. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListOmnichannelSettings
rpc ListOmnichannelSettings(ListOmnichannelSettingsRequest) returns (ListOmnichannelSettingsResponse) List all the omnichannel settings for a given merchant. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

RequestInventoryVerification
rpc RequestInventoryVerification(RequestInventoryVerificationRequest) returns (RequestInventoryVerificationResponse) Requests inventory verification for a given merchant in a given country. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateOmnichannelSetting
rpc UpdateOmnichannelSetting(UpdateOmnichannelSettingRequest) returns (OmnichannelSetting) Update the omnichannel setting for a given merchant in a given country. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

OnlineReturnPolicyService

The service facilitates the management of a business's remorse return policy configuration, encompassing return policies for both ads and free listings

programs. This API defines the following resource model:

OnlineReturnPolicy

CreateOnlineReturnPolicy
rpc CreateOnlineReturnPolicy(CreateOnlineReturnPolicyRequest) returns (OnlineReturnPolicy) Creates a new return policy for a given business. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

DeleteOnlineReturnPolicy
rpc DeleteOnlineReturnPolicy(DeleteOnlineReturnPolicyRequest) returns (Empty) Deletes an existing return policy. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetOnlineReturnPolicy
rpc GetOnlineReturnPolicy(GetOnlineReturnPolicyRequest) returns (OnlineReturnPolicy) Gets an existing return policy for a given business. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListOnlineReturnPolicies
rpc ListOnlineReturnPolicies(ListOnlineReturnPoliciesRequest) returns (ListOnlineReturnPoliciesResponse) Lists all existing return policies for a given business. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateOnlineReturnPolicy
rpc UpdateOnlineReturnPolicy(UpdateOnlineReturnPolicyRequest) returns (OnlineReturnPolicy) Updates an existing return policy for a given business. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ProgramsService

Service for program management.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free.

This service exposes methods to retrieve a business's participation in all available programs, in addition to methods for explicitly enabling or disabling participation in each program.

DisableProgram
rpc DisableProgram(DisableProgramRequest) returns (Program) Disable participation in the specified program for the account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

EnableProgram
rpc EnableProgram(EnableProgramRequest) returns (Program) Enable participation in the specified program for the account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetProgram
rpc GetProgram(GetProgramRequest) returns (Program) Retrieves the specified program for the account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListPrograms
rpc ListPrograms(ListProgramsRequest) returns (ListProgramsResponse) Retrieves all programs for the account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

RegionsService

Manages regions configuration.

This API defines the following resource model:

• Region

CreateRegion
rpc CreateRegion(CreateRegionRequest) returns (Region) Creates a region definition in your Merchant Center account. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

DeleteRegion
rpc DeleteRegion(DeleteRegionRequest) returns (Empty) Deletes a region definition from your Merchant Center account. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetRegion
rpc GetRegion(GetRegionRequest) returns (Region) Retrieves a region defined in your Merchant Center account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListRegions
rpc ListRegions(ListRegionsRequest) returns (ListRegionsResponse) Lists the regions in your Merchant Center account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateRegion
rpc UpdateRegion(UpdateRegionRequest) returns (Region) Updates a region definition in your Merchant Center account. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ShippingSettingsService

Service to get method call shipping setting information per Merchant API method.

GetShippingSettings
rpc GetShippingSettings(GetShippingSettingsRequest) returns (ShippingSettings) Retrieve shipping setting information. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

InsertShippingSettings
rpc InsertShippingSettings(InsertShippingSettingsRequest) returns (ShippingSettings) Replace the shipping setting of a business with the request shipping setting. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

TermsOfServiceAgreementStateService

Service to support TermsOfServiceAgreementState API.

GetTermsOfServiceAgreementState
rpc GetTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState) Returns the state of a terms of service agreement. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

RetrieveForApplicationTermsOfServiceAgreementState

rpc RetrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState) Retrieves the state of the agreement for the application terms of service. Application terms of service covers permissions related to the usage of data provided through Merchant Center, CSS Center, Manufacturer Center, and more. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

TermsOfServiceService

Service to support TermsOfService API.

AcceptTermsOfService
rpc AcceptTermsOfService(AcceptTermsOfServiceRequest) returns (AcceptTermsOfServiceResponse) Accepts a TermsOfService. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetTermsOfService
rpc GetTermsOfService(GetTermsOfServiceRequest) returns (TermsOfService) Retrieves the TermsOfService associated with the provided version. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

RetrieveLatestTermsOfService
rpc RetrieveLatestTermsOfService(RetrieveLatestTermsOfServiceRequest) returns (TermsOfService) Retrieves the latest version of the TermsOfService for a given kind and region_code. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UserService

Service to support user API.

CreateUser
rpc CreateUser(CreateUserRequest) returns (User) Creates a Merchant Center account user. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

DeleteUser

rpc DeleteUser(DeleteUserRequest) returns (Empty) Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager" Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetUser
rpc GetUser(GetUserRequest) returns (User) Retrieves a Merchant Center account user. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListUsers
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) Lists all users of a Merchant Center account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateUser
rpc UpdateUser(UpdateUserRequest) returns (User) Updates a Merchant Center account user. Executing this method requires admin access. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

About

Collection of information related to the about page (impressum).

Fields
uri	string Required. The about page URI.
state	State Output only. The state of the URI.

AcceptTermsOfServiceRequest

Request message for the AcceptTermsOfService method.

Fields
name	string Required. The resource name of the terms of service version. Format: termsOfService/{version}
account	string Required. The account for which to accept the ToS. Format: accounts/{account}
region_code	string Required. Region code as defined by CLDR. This is either a country when the ToS applies specifically to that country or 001 when it applies globally.

AcceptTermsOfServiceResponse

Response message for the AcceptTermsOfService method.

Fields
terms_of_service_agreement_state	TermsOfServiceAgreementState The agreement state after accepting the ToS.

Accepted

Describes the accepted terms of service.

Fields
terms_of_service	string Required. The accepted termsOfService.
accepted_by	string Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account.
valid_until	Date Optional. When set, it states that the accepted TermsOfService is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required TermsOfService is found in the Required message.

AccessRight

The access right.

Enums
ACCESS_RIGHT_UNSPECIFIED	Default value. This value is unused.
STANDARD	Standard access rights.
READ_ONLY	Has access to the same read-only methods as STANDARD, but no access to any mutating methods.
ADMIN	Admin access rights.
PERFORMANCE_REPORTING	Users with this right have access to performance and insights.

Account

The Account message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers.

Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts.

Establishing an account involves configuring attributes like the account name, time zone, and language preferences.

The Account message is the parent entity for many other resources, for example, AccountRelationship, Homepage, BusinessInfo and so on.

Fields
name	string Identifier. The resource name of the account. Format: accounts/{account}
account_id	int64 Output only. The ID of the account.
account_name	string Required. A human-readable name of the account. See store name and business name for more information.
test_account	bool Output only. Whether this is a test account.
time_zone	TimeZone Required. The time zone of the account. On writes, time_zone sets both the reporting_time_zone and the display_time_zone. For reads, time_zone always returns the display_time_zone. If display_time_zone doesn't exist for your account, time_zone is empty. The version field is not supported, won't be set in responses and will be silently ignored if specified in requests.
language_code	string Required. The account's BCP-47 language code, such as en-US or sr-Latn.
adult_content	bool Optional. Whether this account contains adult content.

AccountAggregation

This type has no fields.

AccountAggregation payload.

AccountIssue

Issues with your Merchant Center account that can impact all your products. For more information, see Account-level issues in Merchant Center.

Fields
name	string Identifier. The resource name of the account issue. Format: accounts/{account}/issues/{id}. For example, accounts/123456/issues/misrepresentation-of-self-or-products-unacceptable-business-practice-policy.
title	string The localized title of the issue.
severity	Severity The overall severity of the issue.
impacted_destinations[]	ImpactedDestination The impact this issue has on various destinations.
detail	string Further localized details about the issue.
documentation_uri	string Link to Merchant Center Help Center providing further information about the issue and how to fix it.

ImpactedDestination

The impact of the issue on a destination.

Fields
impacts[]	Impact The (negative) impact for various regions on the given destination.
reporting_context	ReportingContextEnum The impacted reporting context.

Impact

The impact of the issue on a region.

Fields
region_code	string The CLDR region code where this issue applies.
severity	Severity The severity of the issue on the destination and region.

Severity

All possible issue severities.

Enums
SEVERITY_UNSPECIFIED	The severity is unknown.
CRITICAL	The issue causes offers to not serve.
ERROR	The issue might affect offers (in the future) or might be an indicator of issues with offers.
SUGGESTION	The issue is a suggestion for improvement.

AccountManagement

This type has no fields.

AccountManagement payload.

AccountRelationship

The AccountRelationship message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services.

Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).

Fields
name	string Identifier. The resource name of the account relationship. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.
provider_display_name	string Output only. The human-readable display name of the provider account.
account_id_alias	string Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use account_id_alias to assign a friendly name to this relationship for easier identification in your systems.
provider	string Immutable. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

AccountService

The AccountService message represents a specific service that a provider account offers to a Merchant Center account.

AccountService defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management.

The lifecycle of an AccountService involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically.

The mutability of a service is also managed through AccountService. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.

Fields
name	string Identifier. The resource name of the account service. Format: accounts/{account}/services/{service}
provider_display_name	string Output only. The human-readable display name of the provider account.
handshake	Handshake Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
mutability	Mutability Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.
external_account_id	string Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the external_account_id differentiates between them, ensuring accurate linking and integration between Google and the provider.
Union field service_type. The payload specified has to correspond to the service_type. service_type can be only one of the following:
products_management	ProductsManagement Service type for managing products. This allows the provider to handle product data on behalf of the business, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the business's product information up-to-date across platforms.
campaigns_management	CampaignsManagement Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
account_management	AccountManagement Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information.
account_aggregation	AccountAggregation Service type for account aggregation. This enables the provider, which is an advanced account, to manage multiple sub-accounts (client accounts). Through this service, the advanced account provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many Merchant Center accounts.
local_listing_management	LocalListingManagement Service type for local listings management. The business group associated with the external account id will be used to provide local inventory to this Merchant Center account.
provider	string Output only. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

Mutability

The list of mutability option settings a service can have.

Enums
MUTABILITY_UNSPECIFIED	Unused default value
MUTABLE	The service can be mutated without restrictions.
IMMUTABLE	The service is read-only and must not be mutated.

Address

Shipping address of the warehouse.

Fields
street_address	string Street-level part of the address. For example: 111w 31st Street.
city	string Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
administrative_area	string Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
postal_code	string Required. Postal code or ZIP (For example "94043").
region_code	string Required. CLDR country code (For example "US").

ApproveAccountServiceRequest

Request to approve an account service.

Fields
name	string Required. The resource name of the account service to approve. Format: accounts/{account}/services/{service}

AutofeedSettings

Collection of information related to the autofeed settings.

Fields
name	string Identifier. The resource name of the autofeed settings. Format: accounts/{account}/autofeedSettings.
enable_products	bool Required. Enables or disables product crawling through the autofeed for the given account. Autofeed accounts must meet certain conditions, which can be checked through the eligible field. The account must not be a marketplace. When the autofeed is enabled for the first time, the products usually appear instantly. When re-enabling, it might take up to 24 hours for products to appear.
eligible	bool Output only. Determines whether the business is eligible for being enrolled into an autofeed.

AutomaticImageImprovements

This improvement will attempt to automatically correct submitted images if they don't meet the image requirements, for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: Automatic image improvements

Fields
effective_allow_automatic_image_improvements	bool Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
account_image_improvements_settings	ImageImprovementsAccountLevelSettings Optional. Determines how the images should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.

ImageImprovementsAccountLevelSettings

Settings for the Automatic Image Improvements.

Fields
allow_automatic_image_improvements	bool Enables automatic image improvements.

AutomaticImprovements

Collection of information related to the automatic improvements of an account.

Fields
name	string Identifier. The resource name of the automatic improvements. Format: accounts/{account}/automaticImprovements.
item_updates	AutomaticItemUpdates Turning on item updates allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided in the update mask.
image_improvements	AutomaticImageImprovements This improvement will attempt to automatically correct submitted images if they don't meet the image requirements, for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: Automatic image improvements This field is only updated (cleared) if provided in the update mask.
shipping_improvements	AutomaticShippingImprovements Not available for advanced accounts. By turning on automatic shipping improvements, you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data This field is only updated (cleared) if provided in the update mask.

AutomaticItemUpdates

Turning on item updates allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown.

Fields
account_item_updates_settings	ItemUpdatesAccountLevelSettings Optional. Determines which attributes of the items should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
effective_allow_price_updates	bool Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
effective_allow_availability_updates	bool Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
effective_allow_strict_availability_updates	bool Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
effective_allow_condition_updates	bool Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.

ItemUpdatesAccountLevelSettings

Settings for the Automatic Item Updates.

Fields
allow_price_updates	bool If price updates are enabled, Google always updates the active price with the crawled information.
allow_availability_updates	bool If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally allow_strict_availability_updates field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
allow_strict_availability_updates	bool If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also set allow_availability_updates.
allow_condition_updates	bool If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.

AutomaticShippingImprovements

Not available for advanced accounts. By turning on automatic shipping improvements, you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data

Fields
allow_shipping_improvements	bool Enables automatic shipping improvements.

BusinessDayConfig

Business days of the warehouse.

Fields
business_days[]	Weekday Required. Regular business days. May not be empty.

Weekday

Enums
WEEKDAY_UNSPECIFIED
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

BusinessIdentity

Collection of information related to the identity of a business.

Fields
name	string Identifier. The resource name of the business identity. Format: accounts/{account}/businessIdentity
promotions_consent	PromotionsConsent Required. Whether the identity attributes may be used for promotions.
black_owned	IdentityAttribute Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to US. It is also not applicable for marketplaces or marketplace sellers.
women_owned	IdentityAttribute Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.
veteran_owned	IdentityAttribute Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.
latino_owned	IdentityAttribute Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for businesses with the business country set to US. It is also not applicable for marketplaces or marketplace sellers.
small_business	IdentityAttribute Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces.

IdentityAttribute

All information related to an identity attribute.

Fields
identity_declaration	IdentityDeclaration Required. The declaration of identity for this attribute.

IdentityDeclaration

All possible settings regarding the declaration of an identity.

Enums
IDENTITY_DECLARATION_UNSPECIFIED	Default value indicating that no selection was made.
SELF_IDENTIFIES_AS	Indicates that the account identifies with the attribute.
DOES_NOT_SELF_IDENTIFY_AS	Indicates that the account does not identify with the attribute.

PromotionsConsent

All possible settings regarding promotions related to the business identity.

Enums
PROMOTIONS_CONSENT_UNSPECIFIED	Default value indicating that no selection was made.
PROMOTIONS_CONSENT_GIVEN	Indicates that the account consented to having their business identity used for promotions.
PROMOTIONS_CONSENT_DENIED	Indicates that the account did not consent to having their business identity used for promotions.

BusinessInfo

The BusinessInfo message contains essential information about a business.

This message captures key business details such as physical address, customer service contacts, and region-specific identifiers.

Fields
name	string Identifier. The resource name of the business info. Format: accounts/{account}/businessInfo
address	PostalAddress Optional. The address of the business. Only region_code, address_lines, postal_code, administrative_area and locality fields are supported. All other fields are ignored.
phone	PhoneNumber Output only. The phone number of the business.
phone_verification_state	PhoneVerificationState Output only. The phone verification state of the business.
customer_service	CustomerService Optional. The customer service of the business.
korean_business_registration_number	string Optional. The 10-digit Korean business registration number separated with dashes in the format: XXX-XX-XXXXX.

CampaignsManagement

This type has no fields.

CampaignManagement payload.

CarrierRate

A list of carrier rates that can be referred to by main_table or single_value. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.

Fields
name	string Required. Name of the carrier rate. Must be unique per rate group.
carrier	string Required. Carrier service, such as "UPS" or "Fedex".
carrier_service	string Required. Carrier service, such as "ground" or "2 days".
origin_postal_code	string Required. Shipping origin for this carrier rate.
percentage_adjustment	string Optional. Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%.
flat_adjustment	Price Optional. Additive shipping rate modifier. Can be negative. For example { "amount_micros": 1, "currency_code" : "USD" } adds $1 to the rate, { "amount_micros": -3, "currency_code" : "USD" } removes $3 from the rate.

ClaimHomepageRequest

Request message for the ClaimHomepage method.

Fields
name	string Required. The name of the homepage to claim. Format: accounts/{account}/homepage
overwrite	bool Optional. When set to true, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim.

CreateAndConfigureAccountRequest

Request message for the CreateAndConfigureAccount method.

Fields
account	Account Required. The account to be created.
users[] (deprecated)	CreateUserRequest This item is deprecated! Optional. Users to be added to the account. This field is deprecated and will not exist after the API evolves out of beta. Use the user field instead.
user[]	AddUser Optional. Users to be added to the account.
service[]	AddAccountService Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be account_aggregation and accounts.createAndConfigure method can be used to create a sub-account under an existing advanced account through this method. Additional account_management or product_management services may be provided.

AddAccountService

Additional instructions to add account services during creation of the account.

Fields
Union field service_type. The service type to be added. service_type can be only one of the following:
account_aggregation	AccountAggregation The provider is an aggregator for the account. Payload for service type Account Aggregation.
provider	string Required. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

AddUser

Instruction for adding a user to the account during creation.

Fields
user_id	string Required. The email address of the user (for example, [e-mail]).
user	User Optional. Details about the user to be added. At the moment, only access rights may be specified.

CreateOmnichannelSettingRequest

Request message for the CreateOmnichannelSetting method.

Fields
parent	string Required. The parent resource where this omnichannel setting will be created. Format: accounts/{account}
omnichannel_setting	OmnichannelSetting Required. The omnichannel setting to create.

CreateOnlineReturnPolicyRequest

Request message for the CreateOnlineReturnPolicy method.

Fields
parent	string Required. The Merchant Center account for which the return policy will be created. Format: accounts/{account}
online_return_policy	OnlineReturnPolicy Required. The return policy object to create.

CreateRegionRequest

Request message for the CreateRegion method.

Fields
parent	string Required. The account to create a region for. Format: accounts/{account}
region_id	string Required. The identifier for the region, unique over all regions of the same account.
region	Region Required. The region to create.

CreateUserRequest

Request message for the CreateUser method.

Fields
parent	string Required. The resource name of the account for which a user will be created. Format: accounts/{account}
user_id	string Required. The email address of the user (for example, [e-mail]).
user	User Optional. The user to create.

CustomerService

Customer service information.

Fields
uri	string Optional. The URI where customer service may be found.
email	string Optional. The email address where customer service may be reached.
phone	PhoneNumber Optional. The phone number where customer service may be called.

CutoffTime

Business days cutoff time definition.

Fields
hour	int32 Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
minute	int32 Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
time_zone	string Required. Timezone identifier For example "Europe/Zurich".

DeleteAccountRequest

Request message for the DeleteAccount method.

Fields
name	string Required. The name of the account to delete. Format: accounts/{account}
force	bool Optional. If set to true, the account is deleted even if it provides services to other accounts or has processed offers.

DeleteOnlineReturnPolicyRequest

Request message for the DeleteOnlineReturnPolicy method.

Fields
name	string Required. The name of the return policy to delete. Format: accounts/{account}/onlineReturnPolicies/{return_policy}

DeleteRegionRequest

Request message for the DeleteRegion method.

Fields
name	string Required. The name of the region to delete. Format: accounts/{account}/regions/{region}

DeleteUserRequest

Request message for the DeleteUser method.

Fields
name	string Required. The name of the user to delete. Format: accounts/{account}/users/{email} It is also possible to delete the user corresponding to the caller by using me rather than an email address as in accounts/{account}/users/me.

DeliveryTime

Time spent in various aspects from order to the delivery of the product.

Fields
warehouse_based_delivery_times[]	WarehouseBasedDeliveryTime Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in [delivery time][google.shopping.merchant.accounts.v1beta.deliverytime] should be set.
min_transit_days	int32 Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either min_transit_days, max_transit_days or transit_time_table must be set, but not both.
max_transit_days	int32 Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to min_transit_days.
cutoff_time	CutoffTime Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
min_handling_days	int32 Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
max_handling_days	int32 Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to min_handling_days. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
transit_time_table	TransitTable Transit time table, number of business days spent in transit based on row and column dimensions. Either min_transit_days, max_transit_days or transit_time_table can be set, but not both.
handling_business_day_config	BusinessDayConfig The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
transit_business_day_config	BusinessDayConfig The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.

DisableProgramRequest

Request message for the DisableProgram method.

Fields
name	string Required. The name of the program for which to disable participation for the given account. Format: accounts/{account}/programs/{program}. For example, accounts/123456/programs/free-listings.

Distance

Maximum delivery radius. This is only required for the local delivery shipment type.

Fields
value	int64 Integer value of distance.
unit	Unit Unit can differ based on country, it is parameterized to include miles and kilometers.

Unit

Unit can differ based on country, it is parameterized to include miles and kilometers.

Enums
UNIT_UNSPECIFIED	Unit unspecified
MILES	Unit in miles
KILOMETERS	Unit in kilometers

EmailPreferences

The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.

Fields
name	string Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
news_and_tips	OptInState Optional. Updates on new features, tips and best practices.

OptInState

Opt in state of the email preference.

Enums
OPT_IN_STATE_UNSPECIFIED	Opt-in status is not specified.
OPTED_OUT	User has opted out of receiving this type of email.
OPTED_IN	User has opted in to receiving this type of email.
UNCONFIRMED	User has opted in to receiving this type of email and the confirmation email has been sent, but user has not yet confirmed the opt in (applies only to certain countries).

EnableProgramRequest

Request message for the EnableProgram method.

Fields
name	string Required. The name of the program for which to enable participation for the given account. Format: accounts/{account}/programs/{program}. For example, accounts/123456/programs/free-listings.

FindLfpProvidersRequest

Request message for the FindLfpProviders method.

Fields
parent	string Required. The name of the parent resource under which the LFP providers are found. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}.
page_size	int32 Optional. The maximum number of LfpProvider resources to return. The service returns fewer than this value if the number of lfp providers is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.
page_token	string Optional. A page token, received from a previous FindLfpProviders call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to FindLfpProviders must match the call that provided the page token.

FindLfpProvidersResponse

Response message for the FindLfpProviders method.

Fields
lfp_providers[]	LfpProvider The LFP providers from the specified merchant in the specified country.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

GbpAccount

Collection of information related to a Google Business Profile (GBP) account.

Fields
name	string Identifier. The resource name of the GBP account. Format: accounts/{account}/gbpAccount/{gbp_account}
gbp_account_id	string The id of the GBP account.
type	Type The type of the Business Profile.
gbp_account_name	string The name of the Business Profile. For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account.
listing_count	int64 Number of listings under this account.

Type

The type of the GBP account.

Enums
TYPE_UNSPECIFIED	Default value. This value is unused.
USER	The GBP account is a user account.
BUSINESS_ACCOUNT	The GBP account is a business account.

GetAccountRelationshipRequest

Request to get an account relationship.

Fields
name	string Required. The resource name of the account relationship to get. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.

GetAccountRequest

Request message for the GetAccount method.

Fields
name	string Required. The name of the account to retrieve. Format: accounts/{account}

GetAccountServiceRequest

Request to get an account service.

Fields
name	string Required. The resource name of the account service to get. Format: accounts/{account}/services/{service}

GetAutofeedSettingsRequest

Request message for the GetAutofeedSettings method.

Fields
name	string Required. The resource name of the autofeed settings. Format: accounts/{account}/autofeedSettings

GetAutomaticImprovementsRequest

Request message for the GetAutomaticImprovements method.

Fields
name	string Required. The resource name of the automatic improvements. Format: accounts/{account}/automaticImprovements

GetBusinessIdentityRequest

Request message for the GetBusinessIdentity method.

Fields
name	string Required. The resource name of the business identity. Format: accounts/{account}/businessIdentity. For example, accounts/123456/businessIdentity.

GetBusinessInfoRequest

Request message for the GetBusinessInfo method.

Fields
name	string Required. The resource name of the business info. Format: accounts/{account}/businessInfo. For example, accounts/123456/businessInfo.

GetEmailPreferencesRequest

Request message for GetEmailPreferences method.

Fields
name	string Required. The name of the EmailPreferences resource. Format: accounts/{account}/users/{email}/emailPreferences

GetHomepageRequest

Request message for the GetHomepage method.

Fields
name	string Required. The name of the homepage to retrieve. Format: accounts/{account}/homepage

GetOmnichannelSettingRequest

Request message for the GetOmnichannelSettings method.

Fields
name	string Required. The name of the omnichannel setting to retrieve. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}

GetOnlineReturnPolicyRequest

Request message for the GetOnlineReturnPolicy method.

Fields
name	string Required. The name of the return policy to retrieve. Format: accounts/{account}/onlineReturnPolicies/{return_policy}

GetProgramRequest

Request message for the GetProgram method.

Fields
name	string Required. The name of the program to retrieve. Format: accounts/{account}/programs/{program}. For example, accounts/123456/programs/free-listings.

GetRegionRequest

Request message for the GetRegion method.

Fields
name	string Required. The name of the region to retrieve. Format: accounts/{account}/regions/{region}

GetShippingSettingsRequest

Request message for the GetShippingSetting method.

Fields
name	string Required. The name of the shipping setting to retrieve. Format: accounts/{account}/shippingsettings

GetTermsOfServiceAgreementStateRequest

Request message for the GetTermsOfServiceAgreementState method.

Fields
name	string Required. The resource name of the terms of service version. Format: accounts/{account}/termsOfServiceAgreementStates/{identifier} The identifier format is: {TermsOfServiceKind}-{country}

GetTermsOfServiceRequest

Request message for the GetTermsOfService method.

Fields
name	string Required. The resource name of the terms of service version. Format: termsOfService/{version}

GetUserRequest

Request message for the GetUser method.

Fields
name	string Required. The name of the user to retrieve. Format: accounts/{account}/users/{email} It is also possible to retrieve the user corresponding to the caller by using me rather than an email address as in accounts/{account}/users/me.

Handshake

The current status of establishing of the service. (for example, pending approval or approved).

Fields
approval_state	ApprovalState Output only. The approval state of this handshake.
actor	Actor Output only. The most recent account to modify the account service's approval_status.

Actor

The various actors that can be involved in a handshake.

Enums
ACTOR_UNSPECIFIED	Unspecified actor.
ACCOUNT	The last change was done by the account who has this service.
OTHER_PARTY	The last change was done by the other party who this service points to.

ApprovalState

The approal state of a handshake.

Enums
APPROVAL_STATE_UNSPECIFIED	Unspecified approval status.
PENDING	The service was proposed and is waiting to be confirmed.
ESTABLISHED	Both parties have confirmed the service.
REJECTED	The service proposal was rejected.

Headers

A non-empty list of row or column headers for a table. Exactly one of prices, weights, num_items, postal_code_group_names, or location must be set.

Fields
prices[]	Price Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example [{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}] represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
weights[]	Weight Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example [{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}] represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
number_of_items[]	string Required. A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
postal_code_group_names[]	string Required. A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
locations[]	LocationIdSet Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.

Homepage

The Homepage message represents a business's store homepage within the system.

A business's homepage is the primary domain where customers interact with their store.

The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see Understanding online store URL verification.

Fields
name	string Identifier. The resource name of the store's homepage. Format: accounts/{account}/homepage
claimed	bool Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
uri	string Required. The URI (typically a URL) of the store's homepage.

InStock

Collection of information related to InStock.

Fields
uri	string Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsf_type is GHLSF, and required when the lsf_type is MHLSF_FULL or MHLSF_BASIC.
state	State Output only. The state of the in-stock serving.

InsertShippingSettingsRequest

Request message for the InsertShippingSetting method.

Fields
parent	string Required. The account for which this shipping setting will be inserted. If you are using an advanced account, you must specify the unique identifier of the sub-account for which you want to insert the shipping setting. Format: accounts/{ACCOUNT_ID}
shipping_setting	ShippingSettings Required. The new version of the account.

InventoryVerification

Collection of information related to inventory verification.

Fields
state	State Output only. The state of the inventory verification process.
contact	string Required. The name of the contact for the inventory verification process.
contact_email	string Required. The email address of the contact for the inventory verification process.
contact_state	State Output only. The state of the contact verification.

State

The state of the inventory verification process.

Enums
STATE_UNSPECIFIED	Default value. This value is unused.
ACTION_REQUIRED	When the merchant needs to initiate the inventory verification process. The next state is INACTIVE.
INACTIVE	When the merchant is ready to request inventory verification.
RUNNING	The inventory verification process is running. If the merchant is rejected, the next state is INACTIVE.
SUCCEEDED	The inventory verification process succeeded.
SUSPENDED	When merchant fails the inventory verification process and all attempts are exhausted.

LfpLink

Collection of information related to the LFP link.

Fields
lfp_provider	string Required. The resource name of the LFP provider. Format: lfpProviders/{lfp_provider}
external_account_id	string Required. The account ID by which this merchant is known to the LFP provider.
state	State Output only. The state of the LFP link.

LfpProvider

Collection of information related to a Local Feed Partnership (LFP) provider.

Fields
name	string Identifier. The resource name of the LFP provider. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}
region_code	string Output only. Region code defined by CLDR.
display_name	string The display name of the LFP provider.

LinkGbpAccountRequest

Request message for the LinkGbpAccount method.

Fields
parent	string Required. The name of the parent resource to which the GBP account is linked. Format: accounts/{account}.
gbp_email	string Required. The email address of the Business Profile account.

LinkGbpAccountResponse

Response message for the LinkGbpAccount method.

Fields
response	Empty Empty response.

LinkLfpProviderRequest

Request message for the LinkLfpProvider method.

Fields
name	string Required. The name of the LFP provider resource to link. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}. The lfp_provider is the LFP provider ID.
external_account_id	string Required. The external account ID by which this merchant is known to the LFP provider.

LinkLfpProviderResponse

Response message for the LinkLfpProvider method.

Fields
response	Empty Empty response.

ListAccountIssuesRequest

Request message for the ListAccountIssues method.

Fields
parent	string Required. The parent, which owns this collection of issues. Format: accounts/{account}
page_size	int32 Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 issues will be returned. The maximum value is 100; values above 100 will be coerced to 100
page_token	string Optional. A page token, received from a previous ListAccountIssues call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountIssues must match the call that provided the page token.
language_code	string Optional. The issues in the response will have human-readable fields in the given language. The format is BCP-47, such as en-US or sr-Latn. If not value is provided, en-US will be used.
time_zone	string Optional. The IANA timezone used to localize times in human-readable fields. For example 'America/Los_Angeles'. If not set, 'America/Los_Angeles' will be used.

ListAccountIssuesResponse

Response message for the ListAccountIssues method.

Fields
account_issues[]	AccountIssue The issues from the specified account.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListAccountRelationshipsRequest

Request to list account relationships.

Fields
parent	string Required. The parent account of the account relationship to filter by. Format: accounts/{account}
page_token	string Optional. The token returned by the previous list request.
page_size	int32 Optional. The maximum number of elements to return in the response. Use for paging. If no page_size is specified, 100 is used as the default value. The maximum allowed value is 1000.

ListAccountRelationshipsResponse

Response after trying to list account relationships.

Fields
account_relationships[]	AccountRelationship The account relationships that match your filter.
next_page_token	string A page token. You can send the page_token to get the next page. Only included in the list response if there are more pages.

ListAccountServicesRequest

Request to list account services.

Fields
parent	string Required. The parent account of the account service to filter by. Format: accounts/{account}
page_token	string Optional. The token returned by the previous list request.
page_size	int32 Optional. The maximum number of elements to return in the response. Use for paging. If no page_size is specified, 100 is used as the default value. The maximum allowed value is 1000.

ListAccountServicesResponse

Response after trying to list account services.

Fields
account_services[]	AccountService The account services that match your filter.
next_page_token	string A page token. You can send the page_token to get the next page. Only included in the list response if there are more pages.

ListAccountsRequest

Request message for the ListAccounts method.

Fields
page_size	int32 Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
page_token	string Optional. A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.
filter	string Optional. Returns only accounts that match the filter. For more details, see the filter syntax reference.

ListAccountsResponse

Response message for the ListAccounts method.

Fields
accounts[]	Account The accounts matching the ListAccountsRequest.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListGbpAccountsRequest

Request message for the ListGbpAccounts method.

Fields
parent	string Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account}.
page_size	int32 Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.
page_token	string Optional. A page token, received from a previous ListGbpAccounts call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListGbpAccounts must match the call that provided the page token.

ListGbpAccountsResponse

Response message for the ListGbpAccounts method.

Fields
gbp_accounts[]	GbpAccount The GBP accounts from the specified merchant in the specified country.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListOmnichannelSettingsRequest

Request message for the ListOmnichannelSettings method.

Fields
parent	string Required. The parent, which owns this collection of omnichannel settings. Format: accounts/{account}
page_size	int32 Optional. The maximum number of omnichannel settings to return. The service may return fewer than this value. If unspecified, at most 50 omnichannel settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListOmnichannelSettings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListOmnichannelSettings must match the call that provided the page token.

ListOmnichannelSettingsResponse

Response message for the ListOmnichannelSettings method.

Fields
omnichannel_settings[]	OmnichannelSetting The omnichannel settings from the specified merchant.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListOnlineReturnPoliciesRequest

Request message for the ListOnlineReturnPolicies method.

Fields
parent	string Required. The Merchant Center account for which to list return policies. Format: accounts/{account}
page_size	int32 Optional. The maximum number of OnlineReturnPolicy resources to return. The service returns fewer than this value if the number of return policies for the given business is less that than the pageSize. The default value is 10. The maximum value is 100; If a value higher than the maximum is specified, then the pageSize will default to the maximum
page_token	string Optional. A page token, received from a previous ListOnlineReturnPolicies call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListOnlineReturnPolicies must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

ListOnlineReturnPoliciesResponse

Response message for the ListOnlineReturnPolicies method.

Fields
online_return_policies[]	OnlineReturnPolicy The retrieved return policies.
next_page_token	string A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListProgramsRequest

Request message for the ListPrograms method.

Fields
parent	string Required. The name of the account for which to retrieve all programs. Format: accounts/{account}
page_size	int32 Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A continuation token, received from a previous ListPrograms call. Provide this to retrieve the next page.

ListProgramsResponse

Response message for the ListPrograms method.

Fields
programs[]	Program The programs for the given account.
next_page_token	string A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListRegionsRequest

Request message for the ListRegions method.

Fields
parent	string Required. The account to list regions for. Format: accounts/{account}
page_size	int32 Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListRegions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRegions must match the call that provided the page token.

ListRegionsResponse

Response message for the ListRegions method.

Fields
regions[]	Region The regions from the specified business.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListSubAccountsRequest

Request message for the ListSubAccounts method.

Fields
provider	string Required. The aggregation service provider. Format: accounts/{accountId}
page_size	int32 Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
page_token	string Optional. A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.

ListSubAccountsResponse

Response message for the ListSubAccounts method.

Fields
accounts[]	Account The accounts for which the given parent account is an aggregator.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListUsersRequest

Request message for the ListUsers method.

Fields
parent	string Required. The parent, which owns this collection of users. Format: accounts/{account}
page_size	int32 Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
page_token	string Optional. A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUsers must match the call that provided the page token.

ListUsersResponse

Response message for the ListUsers method.

Fields
users[]	User The users from the specified account.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

LocalListingManagement

This type has no fields.

LocalListingManagement payload.

LocationIdSet

A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.

Fields
location_ids[]	string Required. A non-empty list of location IDs. They must all be of the same location type (For example, state).

MinimumOrderValueTable

Table of per store minimum order values for the pickup fulfillment type.

Fields
store_code_set_with_movs[]	StoreCodeSetWithMov Required. A list of store code sets sharing the same minimum order value (MOV). At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.

StoreCodeSetWithMov

A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.

Fields
store_codes[]	string Optional. A list of unique store codes or empty for the catch all.
value	Price The minimum order value for the given stores.

OmnichannelSetting

Collection of information related to the omnichannel settings of a merchant.

Fields
name	string Identifier. The resource name of the omnichannel setting. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
region_code	string Required. Immutable. Region code defined by CLDR. Must be provided in the Create method, and is immutable.
lsf_type	LsfType Required. The Local Store Front type for this country.
in_stock	InStock Optional. The InStock URI and state for this country.
pickup	Pickup Optional. The Pickup URI and state for this country.
lfp_link	LfpLink Output only. The established link to a LFP provider.
odo	OnDisplayToOrder Optional. The On Display to Order (ODO) policy URI and state for this country.
about	About Optional. The about page URI and state for this country.
inventory_verification	InventoryVerification Optional. The inventory verification contact and state for this country.

LsfType

The product page experience type, which is also called the Local Store Front (LSF) type. Check the HC article for more details.

Enums
LSF_TYPE_UNSPECIFIED	Default value. This value is unused.
GHLSF	Google-Hosted Local Store Front. Check the HC article for more details.
MHLSF_BASIC	Merchant-Hosted Local Store Front Basic. Check the HC article for more details.
MHLSF_FULL	Merchant-Hosted Local Store Front Full. Check the HC article for more details.

OnDisplayToOrder

Collection of information related to the on display to order (ODO).

Fields
uri	string Required. The on display to order (ODO) policy URI.
state	State Output only. The state of the URI.

OnlineReturnPolicy

Online return policy object. This is currently used to represent return policies for ads and free listings programs.

Fields
name	string Identifier. The name of the OnlineReturnPolicy resource. Format: accounts/{account}/onlineReturnPolicies/{return_policy}
return_policy_id	string Output only. Return policy ID generated by Google.
label	string Required. Immutable. This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the Return policy label. The label can contain up to 50 characters.
countries[]	string Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
policy	Policy Optional. The return policy.
seasonal_overrides[]	SeasonalOverride Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
restocking_fee	RestockingFee Optional. The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
return_methods[]	ReturnMethod Optional. The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
item_conditions[]	ItemCondition Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
return_shipping_fee	ReturnShippingFee Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
return_policy_uri	string Required. The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
accept_defective_only	bool Optional. This field specifies if business only accepts defective products for returns.
process_refund_days	int32 Optional. The field specifies the number of days it takes for business to process refunds.
accept_exchange	bool Optional. This field specifies if business allows customers to exchange products.
return_label_source	ReturnLabelSource Optional. The field specifies the return label source.

ItemCondition

The available item conditions.

Enums
ITEM_CONDITION_UNSPECIFIED	Default value. This value is unused.
NEW	New.
USED	Used.

Policy

The available policies.

Fields
type	Type Policy type.
days	int64 The number of days items can be returned after delivery, where one day is defined as 24 hours after the delivery timestamp. Required for NUMBER_OF_DAYS_AFTER_DELIVERY returns.

Type

Return policy types.

Enums
TYPE_UNSPECIFIED	Default value. This value is unused.
NUMBER_OF_DAYS_AFTER_DELIVERY	The number of days within which a return is valid after delivery.
NO_RETURNS	No returns.
LIFETIME_RETURNS	Life time returns.

RestockingFee

The restocking fee. This can be a flat fee or a micro percent.

Fields
Union field type. type can be only one of the following:
fixed_fee	Price Fixed restocking fee.
micro_percent	int32 Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.

ReturnLabelSource

The available return label sources.

Enums
RETURN_LABEL_SOURCE_UNSPECIFIED	Default value. This value is unused.
DOWNLOAD_AND_PRINT	Download and print.
IN_THE_PACKAGE	Label include in the package.
CUSTOMER_RESPONSIBILITY	Customer to provide.

ReturnMethod

The available return methods.

Enums
RETURN_METHOD_UNSPECIFIED	Default value. This value is unused.
BY_MAIL	Return by mail.
IN_STORE	Return in store.
AT_A_KIOSK	Return at a kiosk.

ReturnShippingFee

The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.

Fields
type	Type Required. Type of return shipping fee.
fixed_fee	Price Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.

Type

Return shipping fee types.

Enums
TYPE_UNSPECIFIED	Default value. This value is unused.
FIXED	The return shipping fee is a fixed value.
CUSTOMER_PAYING_ACTUAL_FEE	Customers will pay the actual return shipping fee.

SeasonalOverride

Fields
label	string Required. Display name of this seasonal override in Merchant Center.
start_date	Date Required. Defines the date range when this seasonal override applies. Both start_date and end_date are inclusive. The dates of the seasonal overrides should not overlap.
end_date	Date Required. seasonal override end date (inclusive).
Union field return_window. ReturnWindow: Specifies either a fixed return date or the number of days (from the delivery date) until which a product can be returned. Merchant Return Days return_window can be only one of the following:
return_days	int32 Number of days (from the delivery date) that the product can be returned.
return_until_date	Date Fixed end date until which the product can be returned.

PhoneVerificationState

The phone verification state.

Enums
PHONE_VERIFICATION_STATE_UNSPECIFIED	Default value. This value is unused.
PHONE_VERIFICATION_STATE_VERIFIED	The phone is verified.
PHONE_VERIFICATION_STATE_UNVERIFIED	The phone is unverified.

Pickup

Collection of information related to Pickup.

Fields
uri	string Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage.
state	State Output only. The state of the pickup serving.

ProductsManagement

This type has no fields.

ProductsManagement payload.

Program

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the Free product listings program, which enables products from a business's store to be shown across Google for free.

The following list is the available set of program resource IDs accessible through the API:

• free-listings
• shopping-ads
• youtube-shopping-checkout

Fields
name	string Identifier. The resource name of the program. Format: accounts/{account}/programs/{program}
documentation_uri	string Output only. The URL of a Merchant Center help page describing the program.
state	State Output only. The participation state of the account in the program.
active_region_codes[]	string Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or 001 when the program applies globally.
unmet_requirements[]	Requirement Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.

Requirement

Defines a requirement specified for participation in the program.

Fields
title	string Output only. Name of the requirement.
documentation_uri	string Output only. The URL of a help page describing the requirement.
affected_region_codes[]	string Output only. The regions that are currently affected by this requirement not being met. Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or 001 when the program applies globally.

State

Possible program participation states for the account.

Enums
STATE_UNSPECIFIED	Default value. This value is unused.
NOT_ELIGIBLE	The account is not eligible to participate in the program.
ELIGIBLE	The account is eligible to participate in the program.
ENABLED	The program is enabled for the account.

ProposeAccountServiceRequest

Request to propose an account service.

Fields
parent	string Required. The resource name of the parent account for the service. Format: accounts/{account}
provider	string Required. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).
account_service	AccountService Required. The account service to propose.

RateGroup

Shipping rate group definitions. Only the last one is allowed to have an empty applicable_shipping_labels, which means "everything else". The other applicable_shipping_labels must not overlap.

Fields
applicable_shipping_labels[]	string Required. A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service.
subtables[]	Table Optional. A list of subtables referred to by main_table. Can only be set if main_table is set.
carrier_rates[]	CarrierRate Optional. A list of carrier rates that can be referred to by main_table or single_value.
single_value	Value The value of the rate group (For example flat rate $10). Can only be set if main_table and subtables are not set.
main_table	Table A table defining the rate group, when single_value is not expressive enough. Can only be set if single_value is not set.
name	string Optional. Name of the rate group. If set has to be unique within shipping service.

Region

Represents a geographic region that you can use as a target with both the RegionalInventory and ShippingSettings services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. For more information, see Set up regions for more information.

Fields
name	string Identifier. The resource name of the region. Format: accounts/{account}/regions/{region}
postal_code_area	PostalCodeArea Optional. A list of postal codes that defines the region area.
geotarget_area	GeoTargetArea Optional. A list of geotargets that defines the region area.
regional_inventory_eligible	BoolValue Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
shipping_eligible	BoolValue Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
display_name	string Optional. The display name of the region.

GeoTargetArea

A list of geotargets that defines the region area.

Fields
geotarget_criteria_ids[]	int64 Required. A non-empty list of location IDs. They must all be of the same location type (for example, state).

PostalCodeArea

A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible through the account's ShippingSettings.postalCodeGroups resource.

Fields
region_code	string Required. CLDR territory code or the country the postal code group applies to.
postal_codes[]	PostalCodeRange Required. A range of postal codes.

PostalCodeRange

A range of postal codes that defines the region area.

Fields
begin	string Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: 94108, 9410*, 9*.
end	string Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.

RejectAccountServiceRequest

Request to reject an account service.

Fields
name	string Required. The resource name of the account service to reject. Format: accounts/{account}/services/{service}

RequestInventoryVerificationRequest

Request message for the RequestInventoryVerification method.

Fields
name	string Required. The name of the omnichannel setting to request inventory verification. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}

RequestInventoryVerificationResponse

Response message for the RequestInventoryVerification method.

Fields
omnichannel_setting	OmnichannelSetting The omnichannel setting that was updated.

Required

Describes the terms of service which are required to be accepted.

Fields
terms_of_service	string Required. The TermsOfService that need to be accepted.
tos_file_uri	string Required. Full URL to the terms of service file. This field is the same as TermsOfService.file_uri, it is added here for convenience only.

RetrieveForApplicationTermsOfServiceAgreementStateRequest

Request message for the RetrieveForApplicationTermsOfServiceAgreementState method.

Fields
parent	string Required. The account for which to get a TermsOfServiceAgreementState Format: accounts/{account}

RetrieveLatestTermsOfServiceRequest

Request message for the RetrieveLatestTermsOfService method.

Fields
region_code	string Required. Region code as defined by CLDR. This is either a country when the ToS applies specifically to that country or 001 when it applies globally.
kind	TermsOfServiceKind Required. The Kind this terms of service version applies to.

ReviewState

This type has no fields.

The state of a omnichannel setting related review process.

State

The state of the review process.

Enums
STATE_UNSPECIFIED	Default value. This value is unused.
ACTIVE	The review process has concluded successfully. The reviewed item is active.
FAILED	The review process failed.
RUNNING	The review process is running.
ACTION_REQUIRED	The review process is waiting for the merchant to take action.

Row

Include a list of cells.

Fields
cells[]	Value Required. The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables.

Service

Shipping service.

Fields
delivery_countries[]	string Required. The CLDR territory code of the countries to which the service applies.
rate_groups[]	RateGroup Optional. Shipping rate group definitions. Only the last one is allowed to have an empty applicable_shipping_labels, which means "everything else". The other applicable_shipping_labels must not overlap.
loyalty_programs[]	LoyaltyProgram Optional. Loyalty programs that this shipping service is limited to.
service_name	string Required. Free-form name of the service. Must be unique within target account.
active	bool Required. A boolean exposing the active status of the shipping service.
currency_code	string Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
delivery_time	DeliveryTime Required. Time spent in various aspects from order to the delivery of the product.
shipment_type	ShipmentType Optional. Type of locations this service ships orders to.
minimum_order_value	Price Optional. Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
minimum_order_value_table	MinimumOrderValueTable Optional. Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
store_config	StoreConfig A list of stores your products are delivered from. This is only valid for the local delivery shipment type.

LoyaltyProgram

Loyalty program provided by a business.

Fields
loyalty_program_tiers[]	LoyaltyProgramTiers Optional. Loyalty program tier of this shipping service.
program_label	string This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers.

LoyaltyProgramTiers

Subset of a business's loyalty program.

Fields
tier_label	string The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier.

ShipmentType

Shipment type of shipping service.

Enums
SHIPMENT_TYPE_UNSPECIFIED	This service did not specify shipment type.
DELIVERY	This service ships orders to an address chosen by the customer.
LOCAL_DELIVERY	This service ships orders to an address chosen by the customer. The order is shipped from a local store near by.
COLLECTION_POINT	This service ships orders to an address chosen by the customer. The order is shipped from a collection point.

StoreConfig

A list of stores your products are delivered from. This is only valid for the local delivery shipment type.

Fields
store_codes[]	string Optional. A list of store codes that provide local delivery. If empty, then all_stores must be true.
store_service_type	StoreServiceType Indicates whether all stores, or selected stores, listed by this business provide local delivery.
cutoff_config	CutoffConfig Configs related to local delivery ends for the day.
service_radius	Distance Maximum delivery radius. This is only required for the local delivery shipment type.

CutoffConfig

Configs related to local delivery ends for the day.

Fields
local_cutoff_time	LocalCutoffTime Time that local delivery ends for the day.
store_close_offset_hours	int64 Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with local_cutoff_time.
no_delivery_post_cutoff	bool Businesses can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to true results in the calculated shipping service rate returning NO_DELIVERY_POST_CUTOFF. In the same example, setting this field to false results in the calculated shipping time being one day. This is only for local delivery.

LocalCutoffTime

Time that local delivery ends for the day.

Fields
hour	int64 Hour local delivery orders must be placed by to process the same day.
minute	int64 Minute local delivery orders must be placed by to process the same day.

StoreServiceType

Indicates whether all stores, or selected stores, listed by the business provide local delivery.

Enums
STORE_SERVICE_TYPE_UNSPECIFIED	Did not specify store service type.
ALL_STORES	Indicates whether all stores, current and future, listed by this business provide local delivery.
SELECTED_STORES	Indicates that only the stores listed in store_codes are eligible for local delivery.

ShippingSettings

The Merchant Center account's shipping settings. The ShippingSettings resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts.

Fields
name	string Identifier. The resource name of the shipping settings. Format: accounts/{account}/shippingSettings. For example, accounts/123456/shippingSettings.
services[]	Service Optional. The target account's list of services.
warehouses[]	Warehouse Optional. A list of warehouses which can be referred to in services.
etag	string Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the get call and the insert call. The user should follow these steps: Set the etag field as an empty string for the initial shipping setting creation. After the initial creation, call the get method to obtain an etag and the current shipping setting data before calling insert. Modify the shipping setting information. Call the insert method with the shipping setting information and the etag obtained in step 2. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag.

Table

A table defining the rate group, when single_value is not expressive enough.

Fields
rows[]	Row Required. The list of rows that constitute the table. Must have the same length as row_headers.
name	string Name of the table. Required for subtables, ignored for the main table.
row_headers	Headers Required. Headers of the table's rows.
column_headers	Headers Headers of the table's columns. Optional: if not set then the table has only one dimension.

TermsOfService

The TermsOfService message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see Terms of Service.

This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given kind and region through RetrieveLatestTermsOfService, and accept them as required through AcceptTermsOfService.

Fields
name	string Identifier. The resource name of the terms of service version. Format: termsOfService/{version}
region_code	string Region code as defined by CLDR. This is either a country where the ToS applies specifically to that country or 001 when the same TermsOfService can be signed in any country. However note that when signing a ToS that applies globally we still expect that a specific country is provided (this should be merchant business country or program country of participation).
kind	TermsOfServiceKind The Kind this terms of service version applies to.
external	bool Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API.
file_uri	string URI for terms of service file that needs to be displayed to signing users.

TermsOfServiceAgreementState

This resource represents the agreement state for a given account and terms of service kind. The state is as follows:

• If the business has accepted a terms of service, accepted will be populated, otherwise it will be empty
• If the business must sign a terms of service, required will be populated, otherwise it will be empty.

Note that both required and accepted can be present. In this case the accepted terms of services will have an expiration date set in the valid_until field. The required terms of services need to be accepted before valid_until in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as tos_file_uri). The actual acceptance of the terms of service is done by calling accept on the TermsOfService resource. valid_until field. The required terms of services need to be accepted before valid_until in order for the account to continue having a valid agreement. When accepting new terms of services, we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as tos_file_uri. The actual acceptance of the terms of service is done by calling accept on the TermsOfService resource.

Fields
name	string Identifier. The resource name of the terms of service version. Format: accounts/{account}/termsOfServiceAgreementState/{identifier} The identifier format is: {[TermsOfServiceKind][google.shopping.merchant.accounts.v1beta.TermsOfServiceKind]}-{country} For example, an identifier could be: MERCHANT_CENTER-EU or MERCHANT_CENTER-US.
region_code	string Required. Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to.
terms_of_service_kind	TermsOfServiceKind Required. Terms of Service kind associated with the particular version.
accepted	Accepted Optional. The accepted terms of service of this kind and for the associated region_code
required	Required Optional. The required terms of service

TermsOfServiceKind

The TermsOfService Kind.

Enums
TERMS_OF_SERVICE_KIND_UNSPECIFIED	Default value. This value is unused.
MERCHANT_CENTER	Merchant Center application.

TransitTable

Transit time table, number of business days spent in transit based on row and column dimensions. Either min_transit_days, max_transit_days or transit_time_table can be set, but not both.

Fields
postal_code_group_names[]	string Required. A list of region names Region.name . The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service.
transit_time_labels[]	string Required. A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
rows[]	TransitTimeRow Required. If there's only one dimension set of postal_code_group_names or transit_time_labels, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a postal_code_group_names, and columns (values) to a transit_time_labels.

TransitTimeRow

If there's only one dimension set of postal_code_group_names or transit_time_labels, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a postal_code_group_names, and columns (values) to a transit_time_labels.

Fields
values[]	TransitTimeValue Required. Transit time range (min-max) in business days.

TransitTimeValue

Transit time range (min-max) in business days.

Fields
min_transit_days	int32 Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.
max_transit_days	int32 Must be greater than or equal to min_transit_days.

UnclaimHomepageRequest

Request message for the UnclaimHomepage method.

Fields
name	string Required. The name of the homepage to unclaim. Format: accounts/{account}/homepage

UpdateAccountRelationshipRequest

Request message for the UpdateAccountRelationship method.

Fields
account_relationship	AccountRelationship Required. The new version of the account relationship.
update_mask	FieldMask Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): account_id_alias

UpdateAccountRequest

Request message for the UpdateAccount method.

Fields
account	Account Required. The new version of the account.
update_mask	FieldMask Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): account_name adult_content language_code time_zone

UpdateAutofeedSettingsRequest

Request message for the UpdateAutofeedSettings method.

Fields
autofeed_settings	AutofeedSettings Required. The new version of the autofeed setting.
update_mask	FieldMask Required. List of fields being updated.

UpdateAutomaticImprovementsRequest

Request message for the UpdateAutomaticImprovements method.

Fields
automatic_improvements	AutomaticImprovements Required. The new version of the automatic imrovements.
update_mask	FieldMask Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): item_updates item_updates.account_level_settings image_improvements image_improvements.account_level_settings shipping_improvements shipping_improvements.allow_shipping_improvements

UpdateBusinessIdentityRequest

Request message for the UpdateBusinessIdentity method.

Fields
business_identity	BusinessIdentity Required. The new version of the business identity.
update_mask	FieldMask Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): black_owned latino_owned promotions_consent small_business veteran_owned women_owned

UpdateBusinessInfoRequest

Request message for the UpdateBusinessInfo method.

Fields
business_info	BusinessInfo Required. The new version of the business info.
update_mask	FieldMask Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): address customer_service korean_business_registration_number

UpdateEmailPreferencesRequest

Request message for UpdateEmailPreferences method.

Fields
email_preferences	EmailPreferences Required. Email Preferences to be updated.
update_mask	FieldMask Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): news_and_tips

UpdateHomepageRequest

Request message for the UpdateHomepage method.

Fields
homepage	Homepage Required. The new version of the homepage.
update_mask	FieldMask Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): uri

UpdateOmnichannelSettingRequest

Request message for the UpdateOmnichannelSetting method.

Fields
omnichannel_setting	OmnichannelSetting Required. The omnichannel setting to update. The omnichannel setting's name field is used to identify the omnichannel setting to be updated.
update_mask	FieldMask Required. The list of fields to be updated. The following fields are supported in snake_case only: - lsf_type - in_stock - pickup - odo - about - inventory_verification Full replacement with wildcard *is supported, while empty/implied update mask is not.

UpdateOnlineReturnPolicyRequest

Request message for the UpdateOnlineReturnPolicy method. The method supports field masks and when the mask is provided, only the fields specified in the mask are updated.

Fields
online_return_policy	OnlineReturnPolicy Required. The online return policy to update. The online return policy's name field is used to identify the online return policy to be updated.
update_mask	FieldMask Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): accept_defective_only accept_exchange item_conditions policy process_refund_days restocking_fee return_methods return_policy_uri return_shipping_fee

UpdateRegionRequest

Request message for the UpdateRegion method.

Fields
region	Region Required. The updated region.
update_mask	FieldMask Optional. The comma-separated field mask indicating the fields to update. Example: "displayName,postalCodeArea.regionCode".

UpdateUserRequest

Request message for the UpdateUser method.

Fields
user	User Required. The new version of the user. Use me to refer to your own email address, for example accounts/{account}/users/me.
update_mask	FieldMask Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): access_rights

User

The User message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see Frequently asked questions about people and access levels.

Fields
name	string Identifier. The resource name of the user. Format: accounts/{account}/user/{email} Use me to refer to your own email address, for example accounts/{account}/users/me.
state	State Output only. The state of the user.
access_rights[]	AccessRight Required. The access rights the user has.

State

The possible states of a user.

Enums
STATE_UNSPECIFIED	Default value. This value is unused.
PENDING	The user is pending confirmation. In this state, the user first needs to accept the invitation before performing other actions.
VERIFIED	The user is verified.

Value

The single value of a rate group or the value of a rate group table's cell. Exactly one of no_shipping, flat_rate, price_percentage, carrier_rateName, subtable_name must be set.

Fields
no_shipping	bool If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
flat_rate	Price A flat rate. Can only be set if all other fields are not set.
price_percentage	string A percentage of the price represented as a number in decimal notation (For example, "5.4"). Can only be set if all other fields are not set.
carrier_rate	string The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
subtable	string The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.

Warehouse

A fulfillment warehouse, which stores and handles inventory.

Fields
name	string Required. The name of the warehouse. Must be unique within account.
shipping_address	Address Required. Shipping address of the warehouse.
cutoff_time	WarehouseCutoffTime Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
handling_days	int64 Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.
business_day_config	BusinessDayConfig Business days of the warehouse. If not set, will be Monday to Friday by default.

WarehouseBasedDeliveryTime

Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery_time should be set.

Fields
carrier	string Required. Carrier, such as "UPS" or "Fedex". supported carriers
carrier_service	string Required. Carrier service, such as "ground" or "2 days". The name of the service must be in the eddSupportedServices list.
warehouse	string Required. Warehouse name. This should match warehouse

WarehouseCutoffTime

The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.

Fields
hour	int32 Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.
minute	int32 Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.