Show / Hide Table of Contents

Namespace Google.Shopping.Merchant.Accounts.V1

Classes

About

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

AcceptTermsOfServiceRequest

Request message for the AcceptTermsOfService method.

AcceptTermsOfServiceResponse

Response message for the AcceptTermsOfService method.

Accepted

Describes the accepted terms of service.

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.

AccountAggregation

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.

AccountIssue.Types

Container for nested types declared in the AccountIssue message type.

AccountIssue.Types.ImpactedDestination

The impact of the issue on a destination.

AccountIssue.Types.ImpactedDestination.Types

Container for nested types declared in the ImpactedDestination message type.

AccountIssue.Types.ImpactedDestination.Types.Impact

The impact of the issue on a region.

AccountIssueName

Resource name for the AccountIssue resource.

AccountIssueService

Service to support AccountIssueService API.

AccountIssueService.AccountIssueServiceBase

Base class for server-side implementations of AccountIssueService

AccountIssueService.AccountIssueServiceClient

Client for AccountIssueService

AccountIssueServiceClient

AccountIssueService client wrapper, for convenient use.

AccountIssueServiceClientBuilder

Builder class for AccountIssueServiceClient to provide simple configuration of credentials, endpoint etc.

AccountIssueServiceClientImpl

AccountIssueService client wrapper implementation, for convenient use.

AccountIssueServiceSettings

Settings for AccountIssueServiceClient instances.

AccountManagement

AccountManagement payload.

AccountName

Resource name for the Account resource.

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).

AccountRelationshipName

Resource name for the AccountRelationship resource.

AccountRelationshipsService

Service to support AccountRelationship API.

AccountRelationshipsService.AccountRelationshipsServiceBase

Base class for server-side implementations of AccountRelationshipsService

AccountRelationshipsService.AccountRelationshipsServiceClient

Client for AccountRelationshipsService

AccountRelationshipsServiceClient

AccountRelationshipsService client wrapper, for convenient use.

AccountRelationshipsServiceClientBuilder

Builder class for AccountRelationshipsServiceClient to provide simple configuration of credentials, endpoint etc.

AccountRelationshipsServiceClientImpl

AccountRelationshipsService client wrapper implementation, for convenient use.

AccountRelationshipsServiceSettings

Settings for AccountRelationshipsServiceClient instances.

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.

AccountService.Types

Container for nested types declared in the AccountService message type.

AccountServiceName

Resource name for the AccountService resource.

AccountServicesService

Service to support AccountService API.

AccountServicesService.AccountServicesServiceBase

Base class for server-side implementations of AccountServicesService

AccountServicesService.AccountServicesServiceClient

Client for AccountServicesService

AccountServicesServiceClient

AccountServicesService client wrapper, for convenient use.

AccountServicesServiceClientBuilder

Builder class for AccountServicesServiceClient to provide simple configuration of credentials, endpoint etc.

AccountServicesServiceClientImpl

AccountServicesService client wrapper implementation, for convenient use.

AccountServicesServiceSettings

Settings for AccountServicesServiceClient instances.

AccountsService

Service to support Accounts API.

AccountsService.AccountsServiceBase

Base class for server-side implementations of AccountsService

AccountsService.AccountsServiceClient

Client for AccountsService

AccountsServiceClient

AccountsService client wrapper, for convenient use.

AccountsServiceClientBuilder

Builder class for AccountsServiceClient to provide simple configuration of credentials, endpoint etc.

AccountsServiceClientImpl

AccountsService client wrapper implementation, for convenient use.

AccountsServiceSettings

Settings for AccountsServiceClient instances.

Address

Shipping address of the warehouse.

ApproveAccountServiceRequest

Request to approve an account service.

AutofeedSettings

Collection of information related to the autofeed settings.

AutofeedSettingsName

Resource name for the AutofeedSettings resource.

AutofeedSettingsService

Service to support autofeed setting.

AutofeedSettingsService.AutofeedSettingsServiceBase

Base class for server-side implementations of AutofeedSettingsService

AutofeedSettingsService.AutofeedSettingsServiceClient

Client for AutofeedSettingsService

AutofeedSettingsServiceClient

AutofeedSettingsService client wrapper, for convenient use.

AutofeedSettingsServiceClientBuilder

Builder class for AutofeedSettingsServiceClient to provide simple configuration of credentials, endpoint etc.

AutofeedSettingsServiceClientImpl

AutofeedSettingsService client wrapper implementation, for convenient use.

AutofeedSettingsServiceSettings

Settings for AutofeedSettingsServiceClient instances.

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

AutomaticImageImprovements.Types

Container for nested types declared in the AutomaticImageImprovements message type.

AutomaticImageImprovements.Types.ImageImprovementsAccountLevelSettings

Settings for the Automatic Image Improvements.

AutomaticImprovements

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

AutomaticImprovementsName

Resource name for the AutomaticImprovements resource.

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.

AutomaticImprovementsService.AutomaticImprovementsServiceBase

Base class for server-side implementations of AutomaticImprovementsService

AutomaticImprovementsService.AutomaticImprovementsServiceClient

Client for AutomaticImprovementsService

AutomaticImprovementsServiceClient

AutomaticImprovementsService client wrapper, for convenient use.

AutomaticImprovementsServiceClientBuilder

Builder class for AutomaticImprovementsServiceClient to provide simple configuration of credentials, endpoint etc.

AutomaticImprovementsServiceClientImpl

AutomaticImprovementsService client wrapper implementation, for convenient use.

AutomaticImprovementsServiceSettings

Settings for AutomaticImprovementsServiceClient instances.

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.

AutomaticItemUpdates.Types

Container for nested types declared in the AutomaticItemUpdates message type.

AutomaticItemUpdates.Types.ItemUpdatesAccountLevelSettings

Settings for the Automatic Item Updates.

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

BusinessDayConfig

Business days of the warehouse.

BusinessDayConfig.Types

Container for nested types declared in the BusinessDayConfig message type.

BusinessIdentity

Collection of information related to the identity of a business.

BusinessIdentity.Types

Container for nested types declared in the BusinessIdentity message type.

BusinessIdentity.Types.IdentityAttribute

All information related to an identity attribute.

BusinessIdentity.Types.IdentityAttribute.Types

Container for nested types declared in the IdentityAttribute message type.

BusinessIdentityName

Resource name for the BusinessIdentity resource.

BusinessIdentityService

Service to support business identity API.

BusinessIdentityService.BusinessIdentityServiceBase

Base class for server-side implementations of BusinessIdentityService

BusinessIdentityService.BusinessIdentityServiceClient

Client for BusinessIdentityService

BusinessIdentityServiceClient

BusinessIdentityService client wrapper, for convenient use.

BusinessIdentityServiceClientBuilder

Builder class for BusinessIdentityServiceClient to provide simple configuration of credentials, endpoint etc.

BusinessIdentityServiceClientImpl

BusinessIdentityService client wrapper implementation, for convenient use.

BusinessIdentityServiceSettings

Settings for BusinessIdentityServiceClient instances.

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.

BusinessInfoName

Resource name for the BusinessInfo resource.

BusinessInfoService

Service to support business info API.

BusinessInfoService.BusinessInfoServiceBase

Base class for server-side implementations of BusinessInfoService

BusinessInfoService.BusinessInfoServiceClient

Client for BusinessInfoService

BusinessInfoServiceClient

BusinessInfoService client wrapper, for convenient use.

BusinessInfoServiceClientBuilder

Builder class for BusinessInfoServiceClient to provide simple configuration of credentials, endpoint etc.

BusinessInfoServiceClientImpl

BusinessInfoService client wrapper implementation, for convenient use.

BusinessInfoServiceSettings

Settings for BusinessInfoServiceClient instances.

CampaignsManagement

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.

CheckoutSettings

CheckoutSettings for a specific merchant.

CheckoutSettings.Types

Container for nested types declared in the CheckoutSettings message type.

CheckoutSettingsName

Resource name for the CheckoutSettings resource.

CheckoutSettingsService

Service for supporting checkout settings.

CheckoutSettingsService.CheckoutSettingsServiceBase

Base class for server-side implementations of CheckoutSettingsService

CheckoutSettingsService.CheckoutSettingsServiceClient

Client for CheckoutSettingsService

CheckoutSettingsServiceClient

CheckoutSettingsService client wrapper, for convenient use.

CheckoutSettingsServiceClientBuilder

Builder class for CheckoutSettingsServiceClient to provide simple configuration of credentials, endpoint etc.

CheckoutSettingsServiceClientImpl

CheckoutSettingsService client wrapper implementation, for convenient use.

CheckoutSettingsServiceSettings

Settings for CheckoutSettingsServiceClient instances.

ClaimHomepageRequest

Request message for the ClaimHomepage method.

CreateAndConfigureAccountRequest

Request message for the CreateAndConfigureAccount method.

CreateAndConfigureAccountRequest.Types

Container for nested types declared in the CreateAndConfigureAccountRequest message type.

CreateAndConfigureAccountRequest.Types.AddAccountService

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

CreateAndConfigureAccountRequest.Types.AddUser

Instruction for adding a user to the account during creation.

CreateCheckoutSettingsRequest

Request message for the CreateCheckoutSettings method.

CreateOmnichannelSettingRequest

Request message for the CreateOmnichannelSetting method.

CreateOnlineReturnPolicyRequest

Request message for the CreateOnlineReturnPolicy method.

CreateRegionRequest

Request message for the CreateRegion method.

CreateUserRequest

Request message for the CreateUser method.

CustomerService

Customer service information.

CutoffTime

Business days cutoff time definition.

DeleteAccountRequest

Request message for the DeleteAccount method.

DeleteCheckoutSettingsRequest

Request message for the DeleteCheckoutSettings method.

DeleteOnlineReturnPolicyRequest

Request message for the DeleteOnlineReturnPolicy method.

DeleteRegionRequest

Request message for the DeleteRegion method.

DeleteUserRequest

Request message for the DeleteUser method.

DeliveryTime

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

DeveloperRegistration

Represents a developer registration owned by a Merchant account.

DeveloperRegistrationName

Resource name for the DeveloperRegistration resource.

DeveloperRegistrationService

Service to access Developer Registration.

DeveloperRegistrationService.DeveloperRegistrationServiceBase

Base class for server-side implementations of DeveloperRegistrationService

DeveloperRegistrationService.DeveloperRegistrationServiceClient

Client for DeveloperRegistrationService

DeveloperRegistrationServiceClient

DeveloperRegistrationService client wrapper, for convenient use.

DeveloperRegistrationServiceClientBuilder

Builder class for DeveloperRegistrationServiceClient to provide simple configuration of credentials, endpoint etc.

DeveloperRegistrationServiceClientImpl

DeveloperRegistrationService client wrapper implementation, for convenient use.

DeveloperRegistrationServiceSettings

Settings for DeveloperRegistrationServiceClient instances.

DisableProgramRequest

Request message for the DisableProgram method.

Distance

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

Distance.Types

Container for nested types declared in the Distance message type.

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.

EmailPreferences.Types

Container for nested types declared in the EmailPreferences message type.

EmailPreferencesName

Resource name for the EmailPreferences resource.

EmailPreferencesService

Service to support the EmailPreferences API.

EmailPreferencesService.EmailPreferencesServiceBase

Base class for server-side implementations of EmailPreferencesService

EmailPreferencesService.EmailPreferencesServiceClient

Client for EmailPreferencesService

EmailPreferencesServiceClient

EmailPreferencesService client wrapper, for convenient use.

EmailPreferencesServiceClientBuilder

Builder class for EmailPreferencesServiceClient to provide simple configuration of credentials, endpoint etc.

EmailPreferencesServiceClientImpl

EmailPreferencesService client wrapper implementation, for convenient use.

EmailPreferencesServiceSettings

Settings for EmailPreferencesServiceClient instances.

EnableProgramRequest

Request message for the EnableProgram method.

FindLfpProvidersRequest

Request message for the FindLfpProviders method.

FindLfpProvidersResponse

Response message for the FindLfpProviders method.

GbpAccount

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

GbpAccount.Types

Container for nested types declared in the GbpAccount message type.

GbpAccountName

Resource name for the GbpAccount resource.

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]

GbpAccountsService.GbpAccountsServiceBase

Base class for server-side implementations of GbpAccountsService

GbpAccountsService.GbpAccountsServiceClient

Client for GbpAccountsService

GbpAccountsServiceClient

GbpAccountsService client wrapper, for convenient use.

GbpAccountsServiceClientBuilder

Builder class for GbpAccountsServiceClient to provide simple configuration of credentials, endpoint etc.

GbpAccountsServiceClientImpl

GbpAccountsService client wrapper implementation, for convenient use.

GbpAccountsServiceSettings

Settings for GbpAccountsServiceClient instances.

GetAccountRelationshipRequest

Request to get an account relationship.

GetAccountRequest

Request message for the GetAccount method.

GetAccountServiceRequest

Request to get an account service.

GetAutofeedSettingsRequest

Request message for the GetAutofeedSettings method.

GetAutomaticImprovementsRequest

Request message for the GetAutomaticImprovements method.

GetBusinessIdentityRequest

Request message for the GetBusinessIdentity method.

GetBusinessInfoRequest

Request message for the GetBusinessInfo method.

GetCheckoutSettingsRequest

Request message for GetCheckoutSettings method.

GetDeveloperRegistrationRequest

Request message for the GetDeveloperRegistration method.

GetEmailPreferencesRequest

Request message for GetEmailPreferences method.

GetHomepageRequest

Request message for the GetHomepage method.

GetOmnichannelSettingRequest

Request message for the GetOmnichannelSettings method.

GetOnlineReturnPolicyRequest

Request message for the GetOnlineReturnPolicy method.

GetProgramRequest

Request message for the GetProgram method.

GetRegionRequest

Request message for the GetRegion method.

GetShippingSettingsRequest

Request message for the GetShippingSetting method.

GetTermsOfServiceAgreementStateRequest

Request message for the GetTermsOfServiceAgreementState method.

GetTermsOfServiceRequest

Request message for the GetTermsOfService method.

GetUserRequest

Request message for the GetUser method.

Handshake

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

Handshake.Types

Container for nested types declared in the Handshake message type.

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.

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.

HomepageName

Resource name for the Homepage resource.

HomepageService

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

HomepageService.HomepageServiceBase

Base class for server-side implementations of HomepageService

HomepageService.HomepageServiceClient

Client for HomepageService

HomepageServiceClient

HomepageService client wrapper, for convenient use.

HomepageServiceClientBuilder

Builder class for HomepageServiceClient to provide simple configuration of credentials, endpoint etc.

HomepageServiceClientImpl

HomepageService client wrapper implementation, for convenient use.

HomepageServiceSettings

Settings for HomepageServiceClient instances.

InStock

Collection of information related to InStock.

InsertShippingSettingsRequest

Request message for the InsertShippingSetting method.

InventoryVerification

Collection of information related to inventory verification.

InventoryVerification.Types

Container for nested types declared in the InventoryVerification message type.

LfpLink

Collection of information related to the LFP link.

LfpProvider

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

LfpProviderName

Resource name for the LfpProvider resource.

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]

LfpProvidersService.LfpProvidersServiceBase

Base class for server-side implementations of LfpProvidersService

LfpProvidersService.LfpProvidersServiceClient

Client for LfpProvidersService

LfpProvidersServiceClient

LfpProvidersService client wrapper, for convenient use.

LfpProvidersServiceClientBuilder

Builder class for LfpProvidersServiceClient to provide simple configuration of credentials, endpoint etc.

LfpProvidersServiceClientImpl

LfpProvidersService client wrapper implementation, for convenient use.

LfpProvidersServiceSettings

Settings for LfpProvidersServiceClient instances.

LinkGbpAccountRequest

Request message for the LinkGbpAccount method.

LinkGbpAccountResponse

Response message for the LinkGbpAccount method.

LinkLfpProviderRequest

Request message for the LinkLfpProvider method.

LinkLfpProviderResponse

Response message for the LinkLfpProvider method.

ListAccountIssuesRequest

Request message for the ListAccountIssues method.

ListAccountIssuesResponse

Response message for the ListAccountIssues method.

ListAccountRelationshipsRequest

Request to list account relationships.

ListAccountRelationshipsResponse

Response after trying to list account relationships.

ListAccountServicesRequest

Request to list account services.

ListAccountServicesResponse

Response after trying to list account services.

ListAccountsRequest

Request message for the accounts.list method.

ListAccountsResponse

Response message for the accounts.list method.

ListGbpAccountsRequest

Request message for the ListGbpAccounts method.

ListGbpAccountsResponse

Response message for the ListGbpAccounts method.

ListOmnichannelSettingsRequest

Request message for the ListOmnichannelSettings method.

ListOmnichannelSettingsResponse

Response message for the ListOmnichannelSettings method.

ListOnlineReturnPoliciesRequest

Request message for the ListOnlineReturnPolicies method.

ListOnlineReturnPoliciesResponse

Response message for the ListOnlineReturnPolicies method.

ListProgramsRequest

Request message for the ListPrograms method.

ListProgramsResponse

Response message for the ListPrograms method.

ListRegionsRequest

Request message for the ListRegions method.

ListRegionsResponse

Response message for the ListRegions method.

ListSubAccountsRequest

Request message for the ListSubAccounts method.

ListSubAccountsResponse

Response message for the ListSubAccounts method.

ListUsersRequest

Request message for the ListUsers method.

ListUsersResponse

Response message for the ListUsers method.

LocalListingManagement

LocalListingManagement payload.

LocationIdSet

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

MinimumOrderValueTable

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

MinimumOrderValueTable.Types

Container for nested types declared in the MinimumOrderValueTable message type.

MinimumOrderValueTable.Types.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.

OmnichannelSetting

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

OmnichannelSetting.Types

Container for nested types declared in the OmnichannelSetting message type.

OmnichannelSettingName

Resource name for the OmnichannelSetting resource.

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]

OmnichannelSettingsService.OmnichannelSettingsServiceBase

Base class for server-side implementations of OmnichannelSettingsService

OmnichannelSettingsService.OmnichannelSettingsServiceClient

Client for OmnichannelSettingsService

OmnichannelSettingsServiceClient

OmnichannelSettingsService client wrapper, for convenient use.

OmnichannelSettingsServiceClientBuilder

Builder class for OmnichannelSettingsServiceClient to provide simple configuration of credentials, endpoint etc.

OmnichannelSettingsServiceClientImpl

OmnichannelSettingsService client wrapper implementation, for convenient use.

OmnichannelSettingsServiceSettings

Settings for OmnichannelSettingsServiceClient instances.

OnDisplayToOrder

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

OnlineReturnPolicy

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

OnlineReturnPolicy.Types

Container for nested types declared in the OnlineReturnPolicy message type.

OnlineReturnPolicy.Types.Policy

The available policies.

OnlineReturnPolicy.Types.Policy.Types

Container for nested types declared in the Policy message type.

OnlineReturnPolicy.Types.RestockingFee

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

OnlineReturnPolicy.Types.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.

OnlineReturnPolicy.Types.ReturnShippingFee.Types

Container for nested types declared in the ReturnShippingFee message type.

OnlineReturnPolicy.Types.SeasonalOverride

OnlineReturnPolicyName

Resource name for the OnlineReturnPolicy resource.

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

OnlineReturnPolicyService.OnlineReturnPolicyServiceBase

Base class for server-side implementations of OnlineReturnPolicyService

OnlineReturnPolicyService.OnlineReturnPolicyServiceClient

Client for OnlineReturnPolicyService

OnlineReturnPolicyServiceClient

OnlineReturnPolicyService client wrapper, for convenient use.

OnlineReturnPolicyServiceClientBuilder

Builder class for OnlineReturnPolicyServiceClient to provide simple configuration of credentials, endpoint etc.

OnlineReturnPolicyServiceClientImpl

OnlineReturnPolicyService client wrapper implementation, for convenient use.

OnlineReturnPolicyServiceSettings

Settings for OnlineReturnPolicyServiceClient instances.

Pickup

Collection of information related to Pickup.

ProductsManagement

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

Program.Types

Container for nested types declared in the Program message type.

Program.Types.Requirement

Defines a requirement specified for participation in the program.

ProgramName

Resource name for the Program resource.

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.

ProgramsService.ProgramsServiceBase

Base class for server-side implementations of ProgramsService

ProgramsService.ProgramsServiceClient

Client for ProgramsService

ProgramsServiceClient

ProgramsService client wrapper, for convenient use.

ProgramsServiceClientBuilder

Builder class for ProgramsServiceClient to provide simple configuration of credentials, endpoint etc.

ProgramsServiceClientImpl

ProgramsService client wrapper implementation, for convenient use.

ProgramsServiceSettings

Settings for ProgramsServiceClient instances.

ProposeAccountServiceRequest

Request to propose an account service.

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.

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.

Region.Types

Container for nested types declared in the Region message type.

Region.Types.GeoTargetArea

A list of geotargets that defines the region area.

Region.Types.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.

Region.Types.PostalCodeArea.Types

Container for nested types declared in the PostalCodeArea message type.

Region.Types.PostalCodeArea.Types.PostalCodeRange

A range of postal codes that defines the region area.

RegionName

Resource name for the Region resource.

RegionsService

Manages regions configuration.

This API defines the following resource model:

  • [Region][google.shopping.merchant.accounts.v1.Region]

RegionsService.RegionsServiceBase

Base class for server-side implementations of RegionsService

RegionsService.RegionsServiceClient

Client for RegionsService

RegionsServiceClient

RegionsService client wrapper, for convenient use.

RegionsServiceClientBuilder

Builder class for RegionsServiceClient to provide simple configuration of credentials, endpoint etc.

RegionsServiceClientImpl

RegionsService client wrapper implementation, for convenient use.

RegionsServiceSettings

Settings for RegionsServiceClient instances.

RegisterGcpRequest

Request message for the RegisterGCP method.

RejectAccountServiceRequest

Request to reject an account service.

RequestInventoryVerificationRequest

Request message for the RequestInventoryVerification method.

RequestInventoryVerificationResponse

Response message for the RequestInventoryVerification method.

Required

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

RetrieveForApplicationTermsOfServiceAgreementStateRequest

Request message for the RetrieveForApplicationTermsOfServiceAgreementState method.

RetrieveLatestTermsOfServiceRequest

Request message for the RetrieveLatestTermsOfService method.

ReviewState

The state of a omnichannel setting related review process.

ReviewState.Types

Container for nested types declared in the ReviewState message type.

Row

Include a list of cells.

Service

Shipping service.

Service.Types

Container for nested types declared in the Service message type.

Service.Types.LoyaltyProgram

Loyalty program provided by a business.

Service.Types.LoyaltyProgram.Types

Container for nested types declared in the LoyaltyProgram message type.

Service.Types.LoyaltyProgram.Types.LoyaltyProgramTiers

Subset of a business's loyalty program.

Service.Types.StoreConfig

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

Service.Types.StoreConfig.Types

Container for nested types declared in the StoreConfig message type.

Service.Types.StoreConfig.Types.CutoffConfig

Configs related to local delivery ends for the day.

Service.Types.StoreConfig.Types.CutoffConfig.Types

Container for nested types declared in the CutoffConfig message type.

Service.Types.StoreConfig.Types.CutoffConfig.Types.LocalCutoffTime

Time that local delivery ends for the day.

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.

ShippingSettingsName

Resource name for the ShippingSettings resource.

ShippingSettingsService

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

ShippingSettingsService.ShippingSettingsServiceBase

Base class for server-side implementations of ShippingSettingsService

ShippingSettingsService.ShippingSettingsServiceClient

Client for ShippingSettingsService

ShippingSettingsServiceClient

ShippingSettingsService client wrapper, for convenient use.

ShippingSettingsServiceClientBuilder

Builder class for ShippingSettingsServiceClient to provide simple configuration of credentials, endpoint etc.

ShippingSettingsServiceClientImpl

ShippingSettingsService client wrapper implementation, for convenient use.

ShippingSettingsServiceSettings

Settings for ShippingSettingsServiceClient instances.

Table

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

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.

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][google.shopping.merchant.accounts.v1.Accepted] will be populated, otherwise it will be empty
  • If the business must sign a terms of service, [required][google.shopping.merchant.accounts.v1.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][google.shopping.merchant.accounts.v1.Accepted.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][google.shopping.merchant.accounts.v1.Required.tos_file_uri]). The actual acceptance of the terms of service is done by calling accept on the [TermsOfService][google.shopping.merchant.accounts.v1.Accepted.terms_of_service] resource. valid_until field.

TermsOfServiceAgreementStateName

Resource name for the TermsOfServiceAgreementState resource.

TermsOfServiceAgreementStateService

Service to support TermsOfServiceAgreementState API.

TermsOfServiceAgreementStateService.TermsOfServiceAgreementStateServiceBase

Base class for server-side implementations of TermsOfServiceAgreementStateService

TermsOfServiceAgreementStateService.TermsOfServiceAgreementStateServiceClient

Client for TermsOfServiceAgreementStateService

TermsOfServiceAgreementStateServiceClient

TermsOfServiceAgreementStateService client wrapper, for convenient use.

TermsOfServiceAgreementStateServiceClientBuilder

Builder class for TermsOfServiceAgreementStateServiceClient to provide simple configuration of credentials, endpoint etc.

TermsOfServiceAgreementStateServiceClientImpl

TermsOfServiceAgreementStateService client wrapper implementation, for convenient use.

TermsOfServiceAgreementStateServiceSettings

Settings for TermsOfServiceAgreementStateServiceClient instances.

TermsOfServiceName

Resource name for the TermsOfService resource.

TermsOfServiceService

Service to support TermsOfService API.

TermsOfServiceService.TermsOfServiceServiceBase

Base class for server-side implementations of TermsOfServiceService

TermsOfServiceService.TermsOfServiceServiceClient

Client for TermsOfServiceService

TermsOfServiceServiceClient

TermsOfServiceService client wrapper, for convenient use.

TermsOfServiceServiceClientBuilder

Builder class for TermsOfServiceServiceClient to provide simple configuration of credentials, endpoint etc.

TermsOfServiceServiceClientImpl

TermsOfServiceService client wrapper implementation, for convenient use.

TermsOfServiceServiceSettings

Settings for TermsOfServiceServiceClient instances.

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.

TransitTable.Types

Container for nested types declared in the TransitTable message type.

TransitTable.Types.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.

TransitTable.Types.TransitTimeRow.Types

Container for nested types declared in the TransitTimeRow message type.

TransitTable.Types.TransitTimeRow.Types.TransitTimeValue

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

UnclaimHomepageRequest

Request message for the UnclaimHomepage method.

UnregisterGcpRequest

Request message for the UnregisterGCP method.

UpdateAccountRelationshipRequest

Request message for the UpdateAccountRelationship method.

UpdateAccountRequest

Request message for the UpdateAccount method.

UpdateAutofeedSettingsRequest

Request message for the UpdateAutofeedSettings method.

UpdateAutomaticImprovementsRequest

Request message for the UpdateAutomaticImprovements method.

UpdateBusinessIdentityRequest

Request message for the UpdateBusinessIdentity method.

UpdateBusinessInfoRequest

Request message for the UpdateBusinessInfo method.

UpdateCheckoutSettingsRequest

Request message for the UpdateCheckoutSettings method.

UpdateEmailPreferencesRequest

Request message for UpdateEmailPreferences method.

UpdateHomepageRequest

Request message for the UpdateHomepage method.

UpdateOmnichannelSettingRequest

Request message for the UpdateOmnichannelSetting method.

UpdateRegionRequest

Request message for the UpdateRegion method.

UpdateUserRequest

Request message for the UpdateUser method.

UriSettings

URL settings for cart or checkout URL.

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.

User.Types

Container for nested types declared in the User message type.

UserName

Resource name for the User resource.

UserService

Service to support user API.

UserService.UserServiceBase

Base class for server-side implementations of UserService

UserService.UserServiceClient

Client for UserService

UserServiceClient

UserService client wrapper, for convenient use.

UserServiceClientBuilder

Builder class for UserServiceClient to provide simple configuration of credentials, endpoint etc.

UserServiceClientImpl

UserService client wrapper implementation, for convenient use.

UserServiceSettings

Settings for UserServiceClient instances.

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.

Warehouse

A fulfillment warehouse, which stores and handles inventory.

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.

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.

Enums

AccessRight

The access right.

AccountIssue.Types.Severity

All possible issue severities.

AccountIssueName.ResourceNameType

The possible contents of AccountIssueName.

AccountName.ResourceNameType

The possible contents of AccountName.

AccountRelationshipName.ResourceNameType

The possible contents of AccountRelationshipName.

AccountService.ServiceTypeOneofCase

Enum of possible cases for the "service_type" oneof.

AccountService.Types.Mutability

The list of mutability option settings a service can have.

AccountServiceName.ResourceNameType

The possible contents of AccountServiceName.

AutofeedSettingsName.ResourceNameType

The possible contents of AutofeedSettingsName.

AutomaticImprovementsName.ResourceNameType

The possible contents of AutomaticImprovementsName.

BusinessDayConfig.Types.Weekday

BusinessIdentity.Types.IdentityAttribute.Types.IdentityDeclaration

All possible settings regarding the declaration of an identity.

BusinessIdentity.Types.PromotionsConsent

All possible settings regarding promotions related to the business identity.

BusinessIdentityName.ResourceNameType

The possible contents of BusinessIdentityName.

BusinessInfoName.ResourceNameType

The possible contents of BusinessInfoName.

CheckoutSettings.Types.CheckoutEnrollmentState

Enum indicating the enrollment state of merchant in Checkout program.

CheckoutSettings.Types.CheckoutReviewState

Enum indicating the review state of merchant in Checkout program.

CheckoutSettingsName.ResourceNameType

The possible contents of CheckoutSettingsName.

CreateAndConfigureAccountRequest.Types.AddAccountService.ServiceTypeOneofCase

Enum of possible cases for the "service_type" oneof.

DeveloperRegistrationName.ResourceNameType

The possible contents of DeveloperRegistrationName.

Distance.Types.Unit

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

EmailPreferences.Types.OptInState

Opt in state of the email preference.

EmailPreferencesName.ResourceNameType

The possible contents of EmailPreferencesName.

GbpAccount.Types.Type

The type of the GBP account.

GbpAccountName.ResourceNameType

The possible contents of GbpAccountName.

Handshake.Types.Actor

The various actors that can be involved in a handshake.

Handshake.Types.ApprovalState

The approal state of a handshake.

HomepageName.ResourceNameType

The possible contents of HomepageName.

InventoryVerification.Types.State

The state of the inventory verification process.

LfpProviderName.ResourceNameType

The possible contents of LfpProviderName.

OmnichannelSetting.Types.LsfType

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

OmnichannelSettingName.ResourceNameType

The possible contents of OmnichannelSettingName.

OnlineReturnPolicy.Types.ItemCondition

The available item conditions.

OnlineReturnPolicy.Types.Policy.Types.Type

Return policy types.

OnlineReturnPolicy.Types.RestockingFee.TypeOneofCase

Enum of possible cases for the "type" oneof.

OnlineReturnPolicy.Types.ReturnLabelSource

The available return label sources.

OnlineReturnPolicy.Types.ReturnMethod

The available return methods.

OnlineReturnPolicy.Types.ReturnShippingFee.Types.Type

Return shipping fee types.

OnlineReturnPolicy.Types.SeasonalOverride.ReturnWindowOneofCase

Enum of possible cases for the "return_window" oneof.

OnlineReturnPolicyName.ResourceNameType

The possible contents of OnlineReturnPolicyName.

PhoneVerificationState

The phone verification state.

Program.Types.State

Possible program participation states for the account.

ProgramName.ResourceNameType

The possible contents of ProgramName.

RegionName.ResourceNameType

The possible contents of RegionName.

ReviewState.Types.State

The state of the review process.

Service.Types.ShipmentType

Shipment type of shipping service.

Service.Types.StoreConfig.Types.StoreServiceType

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

ShippingSettingsName.ResourceNameType

The possible contents of ShippingSettingsName.

TermsOfServiceAgreementStateName.ResourceNameType

The possible contents of TermsOfServiceAgreementStateName.

TermsOfServiceKind

The TermsOfService Kind.

TermsOfServiceName.ResourceNameType

The possible contents of TermsOfServiceName.

UriSettings.UriTemplateOneofCase

Enum of possible cases for the "uri_template" oneof.

User.Types.State

The possible states of a user.

UserName.ResourceNameType

The possible contents of UserName.

In this article
Back to top Generated by DocFX