As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Shopping Merchant Accounts v1 API

class google.shopping.merchant_accounts_v1.types.About(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

uri

Required. The about page URI.

Type

str

state

Output only. The state of the URI.

Type

google.shopping.merchant_accounts_v1.types.ReviewState.State

class google.shopping.merchant_accounts_v1.types.AcceptTermsOfServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the AcceptTermsOfService method.

name

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

Type

str

account

Required. The account for which to accept the ToS. Format: accounts/{account}

Type

str

region_code

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.

Type

str

class google.shopping.merchant_accounts_v1.types.AcceptTermsOfServiceResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the AcceptTermsOfService method.

terms_of_service_agreement_state

The agreement state after accepting the ToS.

Type

google.shopping.merchant_accounts_v1.types.TermsOfServiceAgreementState

class google.shopping.merchant_accounts_v1.types.Accepted(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes the accepted terms of service.

terms_of_service

Required. The accepted [termsOfService][google.shopping.merchant.accounts.v1.TermsOfService].

Type

str

accepted_by

Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account.

Type

str

valid_until

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.

This field is a member of oneof _valid_until.

Type

google.type.date_pb2.Date

class google.shopping.merchant_accounts_v1.types.AccessRight(value)

Bases: proto.enums.Enum

The access right defines the level of permission a user has within a Merchant Center account.

Values:

ACCESS_RIGHT_UNSPECIFIED (0):

Default value. This value is unused.

STANDARD (1):

Standard access rights.

READ_ONLY (4):

Has access to the same read-only methods as STANDARD, but no access to any mutating methods.

ADMIN (2):

Admin access rights.

PERFORMANCE_REPORTING (3):

Users with this right have access to performance and insights.

API_DEVELOPER (5):

Users with this right have access to Merchant API and its notifications. This role is only accessible to accounts that have a developer registration.

class google.shopping.merchant_accounts_v1.types.Account(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Identifier. The resource name of the account. Format: accounts/{account}

Type

str

account_id

Output only. The ID of the account.

Type

int

account_name

Required. A human-readable name of the account. See store name and business name for more information.

Type

str

adult_content

Optional. Whether this account contains adult content.

This field is a member of oneof _adult_content.

Type

bool

test_account

Output only. Whether this is a test account.

Type

bool

time_zone

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.

Type

google.type.datetime_pb2.TimeZone

language_code

Required. The account’s BCP-47 language code, such as en-US or sr-Latn.

Type

str

class google.shopping.merchant_accounts_v1.types.AccountAggregation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

AccountAggregation payload.

class google.shopping.merchant_accounts_v1.types.AccountIssue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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.

Type

str

title

The localized title of the issue.

Type

str

severity

The overall severity of the issue.

Type

google.shopping.merchant_accounts_v1.types.AccountIssue.Severity

impacted_destinations

The impact this issue has on various destinations.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.AccountIssue.ImpactedDestination]

detail

Further localized details about the issue.

Type

str

documentation_uri

Link to Merchant Center Help Center providing further information about the issue and how to fix it.

Type

str

class ImpactedDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The impact of the issue on a destination.

reporting_context

The impacted reporting context.

This field is a member of oneof _reporting_context.

Type

google.shopping.type.types.ReportingContext.ReportingContextEnum

impacts

The (negative) impact for various regions on the given destination.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.AccountIssue.ImpactedDestination.Impact]

class Impact(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The impact of the issue on a region.

region_code

The CLDR region code where this issue applies.

Type

str

severity

The severity of the issue on the destination and region.

Type

google.shopping.merchant_accounts_v1.types.AccountIssue.Severity

class Severity(value)

Bases: proto.enums.Enum

All possible issue severities.

Values:

SEVERITY_UNSPECIFIED (0):

The severity is unknown.

CRITICAL (1):

The issue causes offers to not serve.

ERROR (2):

The issue might affect offers (in the future) or might be an indicator of issues with offers.

SUGGESTION (3):

The issue is a suggestion for improvement.

class google.shopping.merchant_accounts_v1.types.AccountManagement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

AccountManagement payload.

class google.shopping.merchant_accounts_v1.types.AccountRelationship(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Identifier. The resource name of the account relationship. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.

Type

str

provider

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

This field is a member of oneof _provider.

Type

str

provider_display_name

Output only. The human-readable display name of the provider account.

Type

str

account_id_alias

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.

Type

str

class google.shopping.merchant_accounts_v1.types.AccountService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

products_management

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.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.ProductsManagement

campaigns_management

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.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.CampaignsManagement

account_management

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.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.AccountManagement

account_aggregation

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.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.AccountAggregation

local_listing_management

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.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.LocalListingManagement

comparison_shopping

Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.ComparisonShopping

name

Identifier. The resource name of the account service. Format: accounts/{account}/services/{service}

Type

str

provider

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

This field is a member of oneof _provider.

Type

str

provider_display_name

Output only. The human-readable display name of the provider account.

Type

str

handshake

Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).

Type

google.shopping.merchant_accounts_v1.types.Handshake

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.

Type

google.shopping.merchant_accounts_v1.types.AccountService.Mutability

external_account_id

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.

Type

str

class Mutability(value)

Bases: proto.enums.Enum

The list of mutability option settings a service can have.

Values:

MUTABILITY_UNSPECIFIED (0):

Unused default value

MUTABLE (1):

The service can be mutated without restrictions.

IMMUTABLE (2):

The service is read-only and must not be mutated.

class google.shopping.merchant_accounts_v1.types.Address(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Shipping address of the warehouse.

street_address

Street-level part of the address. For example: 111w 31st Street.

This field is a member of oneof _street_address.

Type

str

city

Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).

This field is a member of oneof _city.

Type

str

administrative_area

Required. Top-level administrative subdivision of the country. For example, a state like California (“CA”) or a province like Quebec (“QC”).

This field is a member of oneof _administrative_area.

Type

str

postal_code

Required. Postal code or ZIP (For example “94043”).

This field is a member of oneof _postal_code.

Type

str

region_code

Required. CLDR country code (For example “US”).

This field is a member of oneof _region_code.

Type

str

class google.shopping.merchant_accounts_v1.types.ApproveAccountServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to approve an account service.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.AutofeedSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Collection of information related to the autofeed settings.

name

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

Type

str

enable_products

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.

Type

bool

eligible

Output only. Determines whether the business is eligible for being enrolled into an autofeed.

Type

bool

class google.shopping.merchant_accounts_v1.types.AutomaticImageImprovements(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

account_image_improvements_settings

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.

This field is a member of oneof _account_image_improvements_settings.

Type

google.shopping.merchant_accounts_v1.types.AutomaticImageImprovements.ImageImprovementsAccountLevelSettings

effective_allow_automatic_image_improvements

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.

Type

bool

class ImageImprovementsAccountLevelSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings for the Automatic Image Improvements.

allow_automatic_image_improvements

Enables automatic image improvements.

This field is a member of oneof _allow_automatic_image_improvements.

Type

bool

class google.shopping.merchant_accounts_v1.types.AutomaticImprovements(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

item_updates

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.

This field is a member of oneof _item_updates.

Type

google.shopping.merchant_accounts_v1.types.AutomaticItemUpdates

image_improvements

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.

This field is a member of oneof _image_improvements.

Type

google.shopping.merchant_accounts_v1.types.AutomaticImageImprovements

shipping_improvements

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.

This field is a member of oneof _shipping_improvements.

Type

google.shopping.merchant_accounts_v1.types.AutomaticShippingImprovements

class google.shopping.merchant_accounts_v1.types.AutomaticItemUpdates(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

account_item_updates_settings

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.

Type

google.shopping.merchant_accounts_v1.types.AutomaticItemUpdates.ItemUpdatesAccountLevelSettings

effective_allow_price_updates

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.

Type

bool

effective_allow_availability_updates

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.

Type

bool

effective_allow_strict_availability_updates

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.

Type

bool

effective_allow_condition_updates

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.

Type

bool

class ItemUpdatesAccountLevelSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings for the Automatic Item Updates.

allow_price_updates

If price updates are enabled, Google always updates the active price with the crawled information.

This field is a member of oneof _allow_price_updates.

Type

bool

allow_availability_updates

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.

This field is a member of oneof _allow_availability_updates.

Type

bool

allow_strict_availability_updates

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.

This field is a member of oneof _allow_strict_availability_updates.

Type

bool

allow_condition_updates

If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.

This field is a member of oneof _allow_condition_updates.

Type

bool

class google.shopping.merchant_accounts_v1.types.AutomaticShippingImprovements(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

allow_shipping_improvements

Enables automatic shipping improvements.

This field is a member of oneof _allow_shipping_improvements.

Type

bool

class google.shopping.merchant_accounts_v1.types.BatchCreateRegionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the BatchCreateRegions method.

parent

Required. The account to create one or more regions for. Format: accounts/{account}

Type

str

requests

Required. The region(s) to create. The maximum number of regions that can be created in a batch is 100.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.CreateRegionRequest]

class google.shopping.merchant_accounts_v1.types.BatchCreateRegionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the BatchCreateRegions method.

regions

The created region(s).

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Region]

class google.shopping.merchant_accounts_v1.types.BatchDeleteRegionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the BatchDeleteRegions method.

parent

Required. The account to delete one or more regions from. Format: accounts/{account}

Type

str

requests

Required. The names of the regions to delete. A maximum of 100 regions can be deleted in a batch.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.DeleteRegionRequest]

class google.shopping.merchant_accounts_v1.types.BatchUpdateRegionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the BatchUpdateRegions method.

parent

Required. The account to update one or more regions for. Format: accounts/{account}

Type

str

requests

Required. The region(s) to update. The maximum number of regions that can be updated in a batch is 100.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.UpdateRegionRequest]

class google.shopping.merchant_accounts_v1.types.BatchUpdateRegionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the BatchUpdateRegions method.

regions

The updated region(s).

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Region]

class google.shopping.merchant_accounts_v1.types.BusinessDayConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Business days of the warehouse.

business_days

Required. Regular business days. May not be empty.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.BusinessDayConfig.Weekday]

class Weekday(value)

Bases: proto.enums.Enum

Values:

WEEKDAY_UNSPECIFIED (0):

No description available.

MONDAY (1):

No description available.

TUESDAY (2):

No description available.

WEDNESDAY (3):

No description available.

THURSDAY (4):

No description available.

FRIDAY (5):

No description available.

SATURDAY (6):

No description available.

SUNDAY (7):

No description available.

class google.shopping.merchant_accounts_v1.types.BusinessIdentity(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Collection of information related to the identity of a business.

name

Identifier. The resource name of the business identity. Format: accounts/{account}/businessIdentity

Type

str

promotions_consent

Required. Whether the identity attributes may be used for promotions.

Type

google.shopping.merchant_accounts_v1.types.BusinessIdentity.PromotionsConsent

black_owned

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.

Type

google.shopping.merchant_accounts_v1.types.BusinessIdentity.IdentityAttribute

women_owned

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.

Type

google.shopping.merchant_accounts_v1.types.BusinessIdentity.IdentityAttribute

veteran_owned

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.

Type

google.shopping.merchant_accounts_v1.types.BusinessIdentity.IdentityAttribute

latino_owned

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.

Type

google.shopping.merchant_accounts_v1.types.BusinessIdentity.IdentityAttribute

small_business

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.

Type

google.shopping.merchant_accounts_v1.types.BusinessIdentity.IdentityAttribute

class IdentityAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

All information related to an identity attribute.

identity_declaration

Required. The declaration of identity for this attribute.

Type

google.shopping.merchant_accounts_v1.types.BusinessIdentity.IdentityAttribute.IdentityDeclaration

class IdentityDeclaration(value)

Bases: proto.enums.Enum

All possible settings regarding the declaration of an identity.

Values:

IDENTITY_DECLARATION_UNSPECIFIED (0):

Default value indicating that no selection was made.

SELF_IDENTIFIES_AS (1):

Indicates that the account identifies with the attribute.

DOES_NOT_SELF_IDENTIFY_AS (2):

Indicates that the account does not identify with the attribute.

class PromotionsConsent(value)

Bases: proto.enums.Enum

All possible settings regarding promotions related to the business identity.

Values:

PROMOTIONS_CONSENT_UNSPECIFIED (0):

Default value indicating that no selection was made.

PROMOTIONS_CONSENT_GIVEN (1):

Indicates that the account consented to having their business identity used for promotions.

PROMOTIONS_CONSENT_DENIED (2):

Indicates that the account did not consent to having their business identity used for promotions.

class google.shopping.merchant_accounts_v1.types.BusinessInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Identifier. The resource name of the business info. Format: accounts/{account}/businessInfo

Type

str

address

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.

This field is a member of oneof _address.

Type

google.type.postal_address_pb2.PostalAddress

phone

Output only. The phone number of the business.

This field is a member of oneof _phone.

Type

google.type.phone_number_pb2.PhoneNumber

phone_verification_state

Output only. The phone verification state of the business.

This field is a member of oneof _phone_verification_state.

Type

google.shopping.merchant_accounts_v1.types.PhoneVerificationState

customer_service

Optional. The customer service of the business.

This field is a member of oneof _customer_service.

Type

google.shopping.merchant_accounts_v1.types.CustomerService

korean_business_registration_number

Optional. The 10-digit Korean business registration number separated with dashes in the format: XXX-XX-XXXXX.

This field is a member of oneof _korean_business_registration_number.

Type

str

class google.shopping.merchant_accounts_v1.types.CampaignsManagement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

CampaignManagement payload.

class google.shopping.merchant_accounts_v1.types.CarrierRate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Required. Name of the carrier rate. Must be unique per rate group.

This field is a member of oneof _name.

Type

str

carrier

Required. Carrier service, such as "UPS" or "Fedex".

This field is a member of oneof _carrier.

Type

str

carrier_service

Required. Carrier service, such as "ground" or "2 days".

This field is a member of oneof _carrier_service.

Type

str

origin_postal_code

Required. Shipping origin for this carrier rate.

This field is a member of oneof _origin_postal_code.

Type

str

percentage_adjustment

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

This field is a member of oneof _percentage_adjustment.

Type

str

flat_adjustment

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.

This field is a member of oneof _flat_adjustment.

Type

google.shopping.type.types.Price

class google.shopping.merchant_accounts_v1.types.CheckoutSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

CheckoutSettings for a specific merchant.

name

Identifier. The resource name of the program configuration settings. Format: accounts/{account}/programs/{program}/checkoutSettings

Type

str

uri_settings

URI settings for cart or checkout URL.

This field is a member of oneof _uri_settings.

Type

google.shopping.merchant_accounts_v1.types.UriSettings

eligible_destinations

Optional. The destinations (also known as Marketing methods) to which the checkout program applies, valid destination values are SHOPPING_ADS, FREE_LISTINGS

Type

MutableSequence[google.shopping.type.types.Destination.DestinationEnum]

enrollment_state

Output only. Reflects the merchant enrollment state in Checkout program.

This field is a member of oneof _enrollment_state.

Type

google.shopping.merchant_accounts_v1.types.CheckoutSettings.CheckoutEnrollmentState

review_state

Output only. Reflects the merchant review state in Checkout program. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as ENROLLED can be in the following review states: IN_REVIEW, APPROVED or DISAPPROVED. A merchant must be in an enrollment_state of ENROLLED before a review can begin for the merchant.For more details, check the help center doc.

This field is a member of oneof _review_state.

Type

google.shopping.merchant_accounts_v1.types.CheckoutSettings.CheckoutReviewState

effective_uri_settings

Output only. The effective value of uri_settings for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).

Type

google.shopping.merchant_accounts_v1.types.UriSettings

effective_enrollment_state

Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).

This field is a member of oneof _effective_enrollment_state.

Type

google.shopping.merchant_accounts_v1.types.CheckoutSettings.CheckoutEnrollmentState

effective_review_state

Output only. The effective value of review_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).

This field is a member of oneof _effective_review_state.

Type

google.shopping.merchant_accounts_v1.types.CheckoutSettings.CheckoutReviewState

class CheckoutEnrollmentState(value)

Bases: proto.enums.Enum

Enum indicating the enrollment state of merchant in Checkout program.

Values:

CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED (0):

Default enrollment state when enrollment state is not specified.

INACTIVE (1):

Merchant has not enrolled into the program.

ENROLLED (2):

Merchant has enrolled into the program by providing either an account level URL or checkout URLs as part of their feed.

OPTED_OUT (3):

Merchant has previously enrolled but opted out of the program.

class CheckoutReviewState(value)

Bases: proto.enums.Enum

Enum indicating the review state of merchant in Checkout program.

Values:

CHECKOUT_REVIEW_STATE_UNSPECIFIED (0):

Default review state when review state is not specified.

IN_REVIEW (1):

Merchant provided URLs are being reviewed for data quality issues.

APPROVED (2):

Merchant account has been approved. Indicates the data quality checks have passed.

DISAPPROVED (3):

Merchant account has been disapproved due to data quality issues.

class google.shopping.merchant_accounts_v1.types.ClaimHomepageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ClaimHomepage method.

name

Required. The name of the homepage to claim. Format: accounts/{account}/homepage

Type

str

overwrite

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.

Type

bool

class google.shopping.merchant_accounts_v1.types.ComparisonShopping(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ComparisonShopping payload.

class google.shopping.merchant_accounts_v1.types.CreateAndConfigureAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the CreateAndConfigureAccount method.

account

Required. The account to be created.

Type

google.shopping.merchant_accounts_v1.types.Account

user

Optional. Users to be added to the account.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.CreateAndConfigureAccountRequest.AddUser]

service

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.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.CreateAndConfigureAccountRequest.AddAccountService]

set_alias

Optional. If a relationship is created with a provider, you can set an alias for it with this field. The calling user must be an admin on the provider to be able to set an alias.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.CreateAndConfigureAccountRequest.SetAliasForRelationship]

class AddAccountService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

account_aggregation

The provider is an aggregator for the account. Payload for service type Account Aggregation.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.AccountAggregation

account_management

The provider manages this account. Payload for service type Account Management.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.AccountManagement

comparison_shopping

The provider is a CSS (Comparison Shopping Service) of this account. Payload for service type Comparison Shopping.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.ComparisonShopping

products_management

The provider manages products for this account. Payload for service type products management.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.ProductsManagement

campaigns_management

The provider manages campaigns for this account. Payload for service type campaigns management.

This field is a member of oneof service_type.

Type

google.shopping.merchant_accounts_v1.types.CampaignsManagement

provider

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

This field is a member of oneof _provider.

Type

str

external_account_id

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.

The external account ID must be specified for the campaigns management service type.

The external account ID must not be specified for the account aggregation service type.

The external account ID is optional / may be specified for all other service types.

Type

str

class AddUser(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Instruction for adding a user to the account during creation.

user_id

Required. The email address of the user (for example, john.doe@gmail.com).

Type

str

user

Optional. Details about the user to be added. At the moment, only access rights may be specified.

Type

google.shopping.merchant_accounts_v1.types.User

verification_mail_settings

Optional. Settings related to configuring the verification email that is sent after adding a user.

Type

google.shopping.merchant_accounts_v1.types.VerificationMailSettings

class SetAliasForRelationship(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Set an alias for a relationship between a provider and the account to be created.

provider

Required. The provider of the service. This is a reference to an account such as providers/123 or accounts/123. The same provider must be specified in at least one of the service fields.

Type

str

account_id_alias

Required. The unique ID of this account in the provider’s system. The value must be unique across all accounts on the platform for this provider.

Type

str

class google.shopping.merchant_accounts_v1.types.CreateCheckoutSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the CreateCheckoutSettings method.

parent

Required. The merchant account for which the CheckoutSettings will be created.

Type

str

checkout_settings

Required. The CheckoutSettings object to create.

Type

google.shopping.merchant_accounts_v1.types.CheckoutSettings

class google.shopping.merchant_accounts_v1.types.CreateOmnichannelSettingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the CreateOmnichannelSetting method.

parent

Required. The parent resource where this omnichannel setting will be created. Format: accounts/{account}

Type

str

omnichannel_setting

Required. The omnichannel setting to create.

Type

google.shopping.merchant_accounts_v1.types.OmnichannelSetting

class google.shopping.merchant_accounts_v1.types.CreateOnlineReturnPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the CreateOnlineReturnPolicy method.

parent

Required. The Merchant Center account for which the return policy will be created. Format: accounts/{account}

Type

str

online_return_policy

Required. The return policy object to create.

Type

google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy

class google.shopping.merchant_accounts_v1.types.CreateRegionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the CreateRegion method.

parent

Required. The account to create a region for. Format: accounts/{account}

Type

str

region_id

Required. The identifier for the region, unique over all regions of the same account.

Type

str

region

Required. The region to create.

Type

google.shopping.merchant_accounts_v1.types.Region

class google.shopping.merchant_accounts_v1.types.CreateUserRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the CreateUser method.

parent

Required. The resource name of the account for which a user will be created. Format: accounts/{account}

Type

str

user_id

Required. The email address of the user (for example, john.doe@gmail.com).

Type

str

user

Optional. The user to create.

Type

google.shopping.merchant_accounts_v1.types.User

class google.shopping.merchant_accounts_v1.types.CustomerService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Customer service information.

uri

Optional. The URI where customer service may be found.

This field is a member of oneof _uri.

Type

str

email

Optional. The email address where customer service may be reached.

This field is a member of oneof _email.

Type

str

phone

Optional. The phone number where customer service may be called.

This field is a member of oneof _phone.

Type

google.type.phone_number_pb2.PhoneNumber

class google.shopping.merchant_accounts_v1.types.CutoffTime(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Business days cutoff time definition.

hour

Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.

This field is a member of oneof _hour.

Type

int

minute

Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.

This field is a member of oneof _minute.

Type

int

time_zone

Required. Timezone identifier For example “Europe/Zurich”.

This field is a member of oneof _time_zone.

Type

str

class google.shopping.merchant_accounts_v1.types.DeleteAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the DeleteAccount method.

name

Required. The name of the account to delete. Format: accounts/{account}

Type

str

force

Optional. If set to true, the account is deleted even if it provides services to other accounts or has processed offers.

Type

bool

class google.shopping.merchant_accounts_v1.types.DeleteCheckoutSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the DeleteCheckoutSettings method.

name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

Type

str

class google.shopping.merchant_accounts_v1.types.DeleteOnlineReturnPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the DeleteOnlineReturnPolicy method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.DeleteRegionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the DeleteRegion method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.DeleteUserRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the DeleteUser method.

name

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.

Type

str

class google.shopping.merchant_accounts_v1.types.DeliveryTime(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

min_transit_days

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.

This field is a member of oneof _min_transit_days.

Type

int

max_transit_days

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.

This field is a member of oneof _max_transit_days.

Type

int

cutoff_time

Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.

This field is a member of oneof _cutoff_time.

Type

google.shopping.merchant_accounts_v1.types.CutoffTime

min_handling_days

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.

This field is a member of oneof _min_handling_days.

Type

int

max_handling_days

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.

This field is a member of oneof _max_handling_days.

Type

int

transit_time_table

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.

This field is a member of oneof _transit_time_table.

Type

google.shopping.merchant_accounts_v1.types.TransitTable

handling_business_day_config

The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.

This field is a member of oneof _handling_business_day_config.

Type

google.shopping.merchant_accounts_v1.types.BusinessDayConfig

transit_business_day_config

The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.

This field is a member of oneof _transit_business_day_config.

Type

google.shopping.merchant_accounts_v1.types.BusinessDayConfig

warehouse_based_delivery_times

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.v1.DeliveryTime] should be set.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.WarehouseBasedDeliveryTime]

class google.shopping.merchant_accounts_v1.types.DeveloperRegistration(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a developer registration owned by a Merchant account.

name

Identifier. The name (ID) of the developer registration. Generated by the Content API upon creation of a new DeveloperRegistration. The account represents the merchant ID of the merchant that owns the registration.

Type

str

gcp_ids

Output only. The GCP ids attached to this developer registration

Type

MutableSequence[str]

class google.shopping.merchant_accounts_v1.types.DisableProgramRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the DisableProgram method.

name

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.

Type

str

class google.shopping.merchant_accounts_v1.types.Distance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

value

Integer value of distance.

This field is a member of oneof _value.

Type

int

unit

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

This field is a member of oneof _unit.

Type

google.shopping.merchant_accounts_v1.types.Distance.Unit

class Unit(value)

Bases: proto.enums.Enum

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

Values:

UNIT_UNSPECIFIED (0):

Unit unspecified

MILES (1):

Unit in miles

KILOMETERS (2):

Unit in kilometers

class google.shopping.merchant_accounts_v1.types.EmailPreferences(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.

Type

str

news_and_tips

Optional. Updates on new features, tips and best practices.

Type

google.shopping.merchant_accounts_v1.types.EmailPreferences.OptInState

class OptInState(value)

Bases: proto.enums.Enum

Opt in state of the email preference.

Values:

OPT_IN_STATE_UNSPECIFIED (0):

Opt-in status is not specified.

OPTED_OUT (1):

User has opted out of receiving this type of email.

OPTED_IN (2):

User has opted in to receiving this type of email.

UNCONFIRMED (3):

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

class google.shopping.merchant_accounts_v1.types.EnableProgramRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the EnableProgram method.

name

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.

Type

str

class google.shopping.merchant_accounts_v1.types.FindLfpProvidersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the FindLfpProviders method.

parent

Required. The name of the parent resource under which the LFP providers are found. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}.

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

class google.shopping.merchant_accounts_v1.types.FindLfpProvidersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the FindLfpProviders method.

lfp_providers

The LFP providers from the specified merchant in the specified country.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.LfpProvider]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.GbpAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Identifier. The resource name of the GBP account. Format: accounts/{account}/gbpAccount/{gbp_account}

Type

str

gbp_account_id

The id of the GBP account.

Type

str

type_

The type of the Business Profile.

Type

google.shopping.merchant_accounts_v1.types.GbpAccount.Type

gbp_account_name

The name of the Business Profile. For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account.

Type

str

listing_count

Number of listings under this account.

Type

int

class Type(value)

Bases: proto.enums.Enum

The type of the GBP account.

Values:

TYPE_UNSPECIFIED (0):

Default value. This value is unused.

USER (1):

The GBP account is a user account.

BUSINESS_ACCOUNT (2):

The GBP account is a business account.

class google.shopping.merchant_accounts_v1.types.GetAccountForGcpRegistrationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the GetAccountForGcpRegistration method.

name

The name of the merchant account id that the GCP is registered with.

Type

str

class google.shopping.merchant_accounts_v1.types.GetAccountRelationshipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get an account relationship.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetAccount method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetAccountServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get an account service.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetAutofeedSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetAutofeedSettings method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetAutomaticImprovementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetAutomaticImprovements method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetBusinessIdentityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetBusinessIdentity method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetBusinessInfoRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetBusinessInfo method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetCheckoutSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetCheckoutSettings method.

name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

Type

str

class google.shopping.merchant_accounts_v1.types.GetDeveloperRegistrationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetDeveloperRegistration method.

name

Required. The name (ID) of the developer registration.

Type

str

class google.shopping.merchant_accounts_v1.types.GetEmailPreferencesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetEmailPreferences method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetHomepageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetHomepage method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetOmnichannelSettingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetOmnichannelSettings method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetOnlineReturnPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetOnlineReturnPolicy method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetProgramRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetProgram method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetRegionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetRegion method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetShippingSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetShippingSetting method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetTermsOfServiceAgreementStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetTermsOfServiceAgreementState method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetTermsOfServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetTermsOfService method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.GetUserRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetUser method.

name

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.

Type

str

class google.shopping.merchant_accounts_v1.types.Handshake(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

approval_state

Output only. The approval state of this handshake.

Type

google.shopping.merchant_accounts_v1.types.Handshake.ApprovalState

actor

Output only. The most recent account to modify the account service’s approval_status.

Type

google.shopping.merchant_accounts_v1.types.Handshake.Actor

class Actor(value)

Bases: proto.enums.Enum

The various actors that can be involved in a handshake.

Values:

ACTOR_UNSPECIFIED (0):

Unspecified actor.

ACCOUNT (1):

The last change was done by the account who has this service.

OTHER_PARTY (2):

The last change was done by the other party who this service points to.

class ApprovalState(value)

Bases: proto.enums.Enum

The approal state of a handshake.

Values:

APPROVAL_STATE_UNSPECIFIED (0):

Unspecified approval status.

PENDING (1):

The service was proposed and is waiting to be confirmed.

ESTABLISHED (2):

Both parties have confirmed the service.

REJECTED (3):

The service proposal was rejected.

class google.shopping.merchant_accounts_v1.types.Headers(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

prices

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.

Type

MutableSequence[google.shopping.type.types.Price]

weights

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.

Type

MutableSequence[google.shopping.type.types.Weight]

number_of_items

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.

Type

MutableSequence[str]

postal_code_group_names

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.

Type

MutableSequence[str]

locations

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

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.LocationIdSet]

class google.shopping.merchant_accounts_v1.types.Homepage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Identifier. The resource name of the store’s homepage. Format: accounts/{account}/homepage

Type

str

uri

Required. The URI (typically a URL) of the store’s homepage.

This field is a member of oneof _uri.

Type

str

claimed

Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.

Type

bool

class google.shopping.merchant_accounts_v1.types.InStock(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Collection of information related to InStock.

uri

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.

Type

str

state

Output only. The state of the in-stock serving.

Type

google.shopping.merchant_accounts_v1.types.ReviewState.State

class google.shopping.merchant_accounts_v1.types.InsertShippingSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the InsertShippingSetting method.

parent

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}

Type

str

shipping_setting

Required. The new version of the account.

Type

google.shopping.merchant_accounts_v1.types.ShippingSettings

class google.shopping.merchant_accounts_v1.types.InventoryVerification(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Collection of information related to inventory verification.

state

Output only. The state of the inventory verification process.

Type

google.shopping.merchant_accounts_v1.types.InventoryVerification.State

contact

Required. The name of the contact for the inventory verification process.

Type

str

contact_email

Required. The email address of the contact for the inventory verification process.

Type

str

contact_state

Output only. The state of the contact verification.

Type

google.shopping.merchant_accounts_v1.types.ReviewState.State

class State(value)

Bases: proto.enums.Enum

The state of the inventory verification process.

Values:

STATE_UNSPECIFIED (0):

Default value. This value is unused.

ACTION_REQUIRED (1):

When the merchant needs to initiate the inventory verification process. The next state is INACTIVE.

INACTIVE (5):

When the merchant is ready to request inventory verification.

RUNNING (2):

The inventory verification process is running. If the merchant is rejected, the next state is INACTIVE.

SUCCEEDED (3):

The inventory verification process succeeded.

SUSPENDED (4):

When merchant fails the inventory verification process and all attempts are exhausted.

class google.shopping.merchant_accounts_v1.types.LfpLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Collection of information related to the LFP link.

lfp_provider

Required. The resource name of the LFP provider. Format: lfpProviders/{lfp_provider}

Type

str

external_account_id

Required. The account ID by which this merchant is known to the LFP provider.

Type

str

state

Output only. The state of the LFP link.

Type

google.shopping.merchant_accounts_v1.types.ReviewState.State

class google.shopping.merchant_accounts_v1.types.LfpProvider(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Identifier. The resource name of the LFP provider. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}

Type

str

region_code

Output only. Region code defined by CLDR.

Type

str

display_name

The display name of the LFP provider.

Type

str

class google.shopping.merchant_accounts_v1.types.LinkGbpAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the LinkGbpAccount method.

parent

Required. The name of the parent resource to which the GBP account is linked. Format: accounts/{account}.

Type

str

gbp_email

Required. The email address of the Business Profile account.

Type

str

class google.shopping.merchant_accounts_v1.types.LinkGbpAccountResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the LinkGbpAccount method.

response

Empty response.

Type

google.protobuf.empty_pb2.Empty

class google.shopping.merchant_accounts_v1.types.LinkLfpProviderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the LinkLfpProvider method.

name

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.

Type

str

external_account_id

Required. The external account ID by which this merchant is known to the LFP provider.

Type

str

class google.shopping.merchant_accounts_v1.types.LinkLfpProviderResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the LinkLfpProvider method.

response

Empty response.

Type

google.protobuf.empty_pb2.Empty

class google.shopping.merchant_accounts_v1.types.ListAccountIssuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListAccountIssues method.

parent

Required. The parent, which owns this collection of issues. Format: accounts/{account}

Type

str

page_size

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

Type

int

page_token

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.

Type

str

language_code

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.

Type

str

time_zone

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.

Type

str

class google.shopping.merchant_accounts_v1.types.ListAccountIssuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListAccountIssues method.

account_issues

The issues from the specified account.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.AccountIssue]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.ListAccountRelationshipsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to list account relationships.

parent

Required. The parent account of the account relationship to filter by. Format: accounts/{account}

Type

str

page_token

Optional. The token returned by the previous list request.

Type

str

page_size

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.

Type

int

class google.shopping.merchant_accounts_v1.types.ListAccountRelationshipsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response after trying to list account relationships.

account_relationships

The account relationships that match your filter.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.AccountRelationship]

next_page_token

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.

Type

str

class google.shopping.merchant_accounts_v1.types.ListAccountServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to list account services.

parent

Required. The parent account of the account service to filter by. Format: accounts/{account}

Type

str

page_token

Optional. The token returned by the previous list request.

Type

str

page_size

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.

Type

int

class google.shopping.merchant_accounts_v1.types.ListAccountServicesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response after trying to list account services.

account_services

The account services that match your filter.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.AccountService]

next_page_token

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.

Type

str

class google.shopping.merchant_accounts_v1.types.ListAccountsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the accounts.list method.

page_size

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.

Type

int

page_token

Optional. A page token, received from a previous accounts.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided in the accounts.list request must match the call that provided the page token.

Type

str

filter

Optional. Returns only accounts that match the filter. For more details, see the filter syntax reference.

Type

str

class google.shopping.merchant_accounts_v1.types.ListAccountsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the accounts.list method.

accounts

The accounts matching the ListAccountsRequest.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Account]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.ListGbpAccountsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListGbpAccounts method.

parent

Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account}.

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

class google.shopping.merchant_accounts_v1.types.ListGbpAccountsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListGbpAccounts method.

gbp_accounts

The GBP accounts from the specified merchant in the specified country.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.GbpAccount]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.ListOmnichannelSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListOmnichannelSettings method.

parent

Required. The parent, which owns this collection of omnichannel settings. Format: accounts/{account}

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

class google.shopping.merchant_accounts_v1.types.ListOmnichannelSettingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListOmnichannelSettings method.

omnichannel_settings

The omnichannel settings from the specified merchant.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.OmnichannelSetting]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.ListOnlineReturnPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListOnlineReturnPolicies method.

parent

Required. The Merchant Center account for which to list return policies. Format: accounts/{account}

Type

str

page_size

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

Type

int

page_token

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][google.shopping.merchant.accounts.v1.ListOnlineReturnPoliciesResponse.next_page_token] in the response to the previous request.

Type

str

class google.shopping.merchant_accounts_v1.types.ListOnlineReturnPoliciesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListOnlineReturnPolicies method.

online_return_policies

The retrieved return policies.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy]

next_page_token

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.ListProgramsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListPrograms method.

parent

Required. The name of the account for which to retrieve all programs. Format: accounts/{account}

Type

str

page_size

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.

Type

int

page_token

Optional. A continuation token, received from a previous ListPrograms call. Provide this to retrieve the next page.

Type

str

class google.shopping.merchant_accounts_v1.types.ListProgramsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListPrograms method.

programs

The programs for the given account.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Program]

next_page_token

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.ListRegionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListRegions method.

parent

Required. The account to list regions for. Format: accounts/{account}

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

class google.shopping.merchant_accounts_v1.types.ListRegionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListRegions method.

regions

The regions from the specified business.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Region]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.ListSubAccountsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListSubAccounts method.

provider

Required. The aggregation service provider. Format: accounts/{accountId}

Type

str

page_size

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.

Type

int

page_token

Optional. A page token, received from a previous accounts.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided in the accounts.list request must match the call that provided the page token.

Type

str

class google.shopping.merchant_accounts_v1.types.ListSubAccountsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListSubAccounts method.

accounts

The accounts for which the given parent account is an aggregator.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Account]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.ListUsersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListUsers method.

parent

Required. The parent, which owns this collection of users. Format: accounts/{account}

Type

str

page_size

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

Type

int

page_token

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.

Type

str

class google.shopping.merchant_accounts_v1.types.ListUsersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListUsers method.

users

The users from the specified account.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.User]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.shopping.merchant_accounts_v1.types.LocalListingManagement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

LocalListingManagement payload.

class google.shopping.merchant_accounts_v1.types.LocationIdSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

location_ids

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

Type

MutableSequence[str]

class google.shopping.merchant_accounts_v1.types.MinimumOrderValueTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

store_code_set_with_movs

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.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.MinimumOrderValueTable.StoreCodeSetWithMov]

class StoreCodeSetWithMov(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

store_codes

Optional. A list of unique store codes or empty for the catch all.

Type

MutableSequence[str]

value

The minimum order value for the given stores.

This field is a member of oneof _value.

Type

google.shopping.type.types.Price

class google.shopping.merchant_accounts_v1.types.OmnichannelSetting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Identifier. The resource name of the omnichannel setting. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}

Type

str

region_code

Required. Immutable. Region code defined by CLDR. Must be provided in the Create method, and is immutable.

Type

str

lsf_type

Required. The Local Store Front type for this country.

Type

google.shopping.merchant_accounts_v1.types.OmnichannelSetting.LsfType

in_stock

Optional. The InStock URI and state for this country.

Type

google.shopping.merchant_accounts_v1.types.InStock

pickup

Optional. The Pickup URI and state for this country.

Type

google.shopping.merchant_accounts_v1.types.Pickup

lfp_link

Output only. The established link to a LFP provider.

Type

google.shopping.merchant_accounts_v1.types.LfpLink

odo

Optional. The On Display to Order (ODO) policy URI and state for this country.

Type

google.shopping.merchant_accounts_v1.types.OnDisplayToOrder

about

Optional. The about page URI and state for this country.

Type

google.shopping.merchant_accounts_v1.types.About

inventory_verification

Optional. The inventory verification contact and state for this country.

Type

google.shopping.merchant_accounts_v1.types.InventoryVerification

class LsfType(value)

Bases: proto.enums.Enum

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

Values:

LSF_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

GHLSF (1):

Google-Hosted Local Store Front. Check the HC article for more details.

MHLSF_BASIC (2):

Merchant-Hosted Local Store Front Basic. Check the HC article for more details.

MHLSF_FULL (3):

Merchant-Hosted Local Store Front Full. Check the HC article for more details.

class google.shopping.merchant_accounts_v1.types.OnDisplayToOrder(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

uri

Required. The on display to order (ODO) policy URI.

Type

str

state

Output only. The state of the URI.

Type

google.shopping.merchant_accounts_v1.types.ReviewState.State

class google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Identifier. The name of the OnlineReturnPolicy resource. Format: accounts/{account}/onlineReturnPolicies/{return_policy}

Type

str

return_policy_id

Output only. Return policy ID generated by Google.

Type

str

label

Optional. Immutable. This field represents the unique user-defined label of the return policy for the given country. It is important to note that the same label cannot be used in different return policies for the same country. If not given, policies will be automatically treated as the ‘default’ for the country. When using label, you are creating an exception policy in that country to assign a custom return policy to certain product groups, follow the instructions provided in the [Return policy label] (https://support.google.com/merchants/answer/9445425). The label can contain up to 50 characters.

Type

str

countries

Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.

Type

MutableSequence[str]

policy

Optional. The return policy.

Type

google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.Policy

seasonal_overrides

Optional. Overrides to the general policy for orders placed during a specific set of time intervals.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.SeasonalOverride]

restocking_fee

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.

Type

google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.RestockingFee

return_methods

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.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.ReturnMethod]

item_conditions

Optional. The item conditions accepted for returns must not be empty unless the type of return policy is ‘noReturns’.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.ItemCondition]

return_shipping_fee

Optional. The return shipping fee. Should be set only when customer need to download and print the return label.

Type

google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.ReturnShippingFee

return_policy_uri

Required. The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.

Type

str

accept_defective_only

Optional. This field specifies if business only accepts defective products for returns.

This field is a member of oneof _accept_defective_only.

Type

bool

process_refund_days

Optional. The field specifies the number of days it takes for business to process refunds.

This field is a member of oneof _process_refund_days.

Type

int

accept_exchange

Optional. This field specifies if business allows customers to exchange products.

This field is a member of oneof _accept_exchange.

Type

bool

return_label_source

Optional. The field specifies the return label source.

This field is a member of oneof _return_label_source.

Type

google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.ReturnLabelSource

class ItemCondition(value)

Bases: proto.enums.Enum

The available item conditions.

Values:

ITEM_CONDITION_UNSPECIFIED (0):

Default value. This value is unused.

NEW (1):

New.

USED (2):

Used.

class Policy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The available policies.

type_

Policy type.

Type

google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.Policy.Type

days

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

int

class Type(value)

Bases: proto.enums.Enum

Return policy types.

Values:

TYPE_UNSPECIFIED (0):

Default value. This value is unused.

NUMBER_OF_DAYS_AFTER_DELIVERY (1):

The number of days within which a return is valid after delivery.

NO_RETURNS (2):

No returns.

LIFETIME_RETURNS (3):

Life time returns.

class RestockingFee(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

fixed_fee

Fixed restocking fee.

This field is a member of oneof type.

Type

google.shopping.type.types.Price

micro_percent

Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.

This field is a member of oneof type.

Type

int

class ReturnLabelSource(value)

Bases: proto.enums.Enum

The available return label sources.

Values:

RETURN_LABEL_SOURCE_UNSPECIFIED (0):

Default value. This value is unused.

DOWNLOAD_AND_PRINT (1):

Download and print.

IN_THE_PACKAGE (2):

Label include in the package.

CUSTOMER_RESPONSIBILITY (3):

Customer to provide.

class ReturnMethod(value)

Bases: proto.enums.Enum

The available return methods.

Values:

RETURN_METHOD_UNSPECIFIED (0):

Default value. This value is unused.

BY_MAIL (1):

Return by mail.

IN_STORE (2):

Return in store.

AT_A_KIOSK (3):

Return at a kiosk.

class ReturnShippingFee(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

type_

Required. Type of return shipping fee.

Type

google.shopping.merchant_accounts_v1.types.OnlineReturnPolicy.ReturnShippingFee.Type

fixed_fee

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

google.shopping.type.types.Price

class Type(value)

Bases: proto.enums.Enum

Return shipping fee types.

Values:

TYPE_UNSPECIFIED (0):

Default value. This value is unused.

FIXED (1):

The return shipping fee is a fixed value.

CUSTOMER_PAYING_ACTUAL_FEE (2):

Customers will pay the actual return shipping fee.

class SeasonalOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

return_days

Number of days (from the delivery date) that the product can be returned.

This field is a member of oneof return_window.

Type

int

return_until_date

Fixed end date until which the product can be returned.

This field is a member of oneof return_window.

Type

google.type.date_pb2.Date

label

Required. Display name of this seasonal override in Merchant Center.

Type

str

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

Type

google.type.date_pb2.Date

end_date

Required. seasonal override end date (inclusive).

Type

google.type.date_pb2.Date

class google.shopping.merchant_accounts_v1.types.PhoneVerificationState(value)

Bases: proto.enums.Enum

The phone verification state.

Values:

PHONE_VERIFICATION_STATE_UNSPECIFIED (0):

Default value. This value is unused.

PHONE_VERIFICATION_STATE_VERIFIED (1):

The phone is verified.

PHONE_VERIFICATION_STATE_UNVERIFIED (2):

The phone is unverified.

class google.shopping.merchant_accounts_v1.types.Pickup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Collection of information related to Pickup.

uri

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.

Type

str

state

Output only. The state of the pickup serving.

Type

google.shopping.merchant_accounts_v1.types.ReviewState.State

class google.shopping.merchant_accounts_v1.types.ProductsManagement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ProductsManagement payload.

class google.shopping.merchant_accounts_v1.types.Program(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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:

• checkout

• free-listings

• shopping-ads

• youtube-shopping-checkout

name

Identifier. The resource name of the program. Format: accounts/{account}/programs/{program}

Type

str

documentation_uri

Output only. The URL of a Merchant Center help page describing the program.

Type

str

state

Output only. The participation state of the account in the program.

Type

google.shopping.merchant_accounts_v1.types.Program.State

active_region_codes

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.

Type

MutableSequence[str]

unmet_requirements

Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Program.Requirement]

class Requirement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines a requirement specified for participation in the program.

title

Output only. Name of the requirement.

Type

str

documentation_uri

Output only. The URL of a help page describing the requirement.

Type

str

affected_region_codes

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.

Type

MutableSequence[str]

class State(value)

Bases: proto.enums.Enum

Possible program participation states for the account.

Values:

STATE_UNSPECIFIED (0):

Default value. This value is unused.

NOT_ELIGIBLE (1):

The account is not eligible to participate in the program.

ELIGIBLE (2):

The account is eligible to participate in the program.

ENABLED (3):

The program is enabled for the account.

class google.shopping.merchant_accounts_v1.types.ProposeAccountServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to propose an account service.

parent

Required. The resource name of the parent account for the service. Format: accounts/{account}

Type

str

provider

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

Type

str

account_service

Required. The account service to propose.

Type

google.shopping.merchant_accounts_v1.types.AccountService

class google.shopping.merchant_accounts_v1.types.RateGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

applicable_shipping_labels

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.

Type

MutableSequence[str]

single_value

The value of the rate group (For example flat rate $10). Can only be set if main_table and subtables are not set.

This field is a member of oneof _single_value.

Type

google.shopping.merchant_accounts_v1.types.Value

main_table

A table defining the rate group, when single_value is not expressive enough. Can only be set if single_value is not set.

This field is a member of oneof _main_table.

Type

google.shopping.merchant_accounts_v1.types.Table

subtables

Optional. A list of subtables referred to by main_table. Can only be set if main_table is set.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Table]

carrier_rates

Optional. A list of carrier rates that can be referred to by main_table or single_value.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.CarrierRate]

name

Optional. Name of the rate group. If set has to be unique within shipping service.

This field is a member of oneof _name.

Type

str

class google.shopping.merchant_accounts_v1.types.Region(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Identifier. The resource name of the region. Format: accounts/{account}/regions/{region}

Type

str

display_name

Optional. The display name of the region.

This field is a member of oneof _display_name.

Type

str

postal_code_area

Optional. A list of postal codes that defines the region area.

Type

google.shopping.merchant_accounts_v1.types.Region.PostalCodeArea

geotarget_area

Optional. A list of geotargets that defines the region area.

Type

google.shopping.merchant_accounts_v1.types.Region.GeoTargetArea

regional_inventory_eligible

Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.

Type

google.protobuf.wrappers_pb2.BoolValue

shipping_eligible

Output only. Indicates if the region is eligible for use in the Shipping Services configuration.

Type

google.protobuf.wrappers_pb2.BoolValue

radius_area

Optional. A radius area that defines the region area.

Type

google.shopping.merchant_accounts_v1.types.Region.RadiusArea

class GeoTargetArea(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of geotargets that defines the region area.

geotarget_criteria_ids

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

Type

MutableSequence[int]

class PostalCodeArea(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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_code

Required. CLDR territory code or the country the postal code group applies to.

Type

str

postal_codes

Required. A range of postal codes.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Region.PostalCodeArea.PostalCodeRange]

class PostalCodeRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A range of postal codes that defines the region area.

begin

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

Type

str

end

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.

Type

str

class RadiusArea(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A radius area that defines the region area.

region_code

Required. CLDR territory code or the country the radius area applies to.

Type

str

lat_lng

Required. The center of the radius area. It represents a latitude/longitude pair in decimal degrees format.

Type

google.type.latlng_pb2.LatLng

radius

Required. The radius distance of the area.

Type

float

radius_units

Optional. The unit of the radius.

Type

google.shopping.merchant_accounts_v1.types.Region.RadiusArea.RadiusUnits

class RadiusUnits(value)

Bases: proto.enums.Enum

The unit of measurement of the radius. Default is KILOMETERS.

Values:

RADIUS_UNITS_UNSPECIFIED (0):

Unused default value

MILES (1):

The distance is measured in miles.

KILOMETERS (2):

The distance is measured in kilometers.

class google.shopping.merchant_accounts_v1.types.RegisterGcpRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the RegisterGCP method.

name

Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: accounts/{account}/developerRegistration

Type

str

developer_email

Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have “API developer” access type and the email preference corresponding to that user will be updated to have the new “API notifications” preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new “API notifications” preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can’t receive emails.

Type

str

class google.shopping.merchant_accounts_v1.types.RejectAccountServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to reject an account service.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.RequestInventoryVerificationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the RequestInventoryVerification method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.RequestInventoryVerificationResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the RequestInventoryVerification method.

omnichannel_setting

The omnichannel setting that was updated.

Type

google.shopping.merchant_accounts_v1.types.OmnichannelSetting

class google.shopping.merchant_accounts_v1.types.Required(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

terms_of_service

Required. The TermsOfService that need to be accepted.

Type

str

tos_file_uri

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.

Type

str

class google.shopping.merchant_accounts_v1.types.RetrieveForApplicationTermsOfServiceAgreementStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the RetrieveForApplicationTermsOfServiceAgreementState method.

parent

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

Type

str

class google.shopping.merchant_accounts_v1.types.RetrieveLatestTermsOfServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the RetrieveLatestTermsOfService method.

region_code

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.

Type

str

kind

Required. The Kind this terms of service version applies to.

Type

google.shopping.merchant_accounts_v1.types.TermsOfServiceKind

class google.shopping.merchant_accounts_v1.types.ReviewState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The state of a omnichannel setting related review process.

class State(value)

Bases: proto.enums.Enum

The state of the review process.

Values:

STATE_UNSPECIFIED (0):

Default value. This value is unused.

ACTIVE (1):

The review process has concluded successfully. The reviewed item is active.

FAILED (2):

The review process failed.

RUNNING (3):

The review process is running.

ACTION_REQUIRED (4):

The review process is waiting for the merchant to take action.

class google.shopping.merchant_accounts_v1.types.Row(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Include a list of cells.

cells

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.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Value]

class google.shopping.merchant_accounts_v1.types.Service(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Shipping service.

service_name

Required. Free-form name of the service. Must be unique within target account.

This field is a member of oneof _service_name.

Type

str

active

Required. A boolean exposing the active status of the shipping service.

This field is a member of oneof _active.

Type

bool

delivery_countries

Required. The CLDR territory code of the countries to which the service applies.

Type

MutableSequence[str]

currency_code

Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.

This field is a member of oneof _currency_code.

Type

str

delivery_time

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

This field is a member of oneof _delivery_time.

Type

google.shopping.merchant_accounts_v1.types.DeliveryTime

rate_groups

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.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.RateGroup]

shipment_type

Optional. Type of locations this service ships orders to.

This field is a member of oneof _shipment_type.

Type

google.shopping.merchant_accounts_v1.types.Service.ShipmentType

minimum_order_value

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.

This field is a member of oneof _minimum_order_value.

Type

google.shopping.type.types.Price

minimum_order_value_table

Optional. Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.

This field is a member of oneof _minimum_order_value_table.

Type

google.shopping.merchant_accounts_v1.types.MinimumOrderValueTable

store_config

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

This field is a member of oneof _store_config.

Type

google.shopping.merchant_accounts_v1.types.Service.StoreConfig

loyalty_programs

Optional. Loyalty programs that this shipping service is limited to.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Service.LoyaltyProgram]

class LoyaltyProgram(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Loyalty program provided by a business.

program_label

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.

This field is a member of oneof _program_label.

Type

str

loyalty_program_tiers

Optional. Loyalty program tier of this shipping service.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Service.LoyaltyProgram.LoyaltyProgramTiers]

class LoyaltyProgramTiers(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Subset of a business’s loyalty program.

tier_label

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.

This field is a member of oneof _tier_label.

Type

str

class ShipmentType(value)

Bases: proto.enums.Enum

Shipment type of shipping service.

Values:

SHIPMENT_TYPE_UNSPECIFIED (0):

This service did not specify shipment type.

DELIVERY (1):

This service ships orders to an address chosen by the customer.

LOCAL_DELIVERY (2):

This service ships orders to an address chosen by the customer. The order is shipped from a local store near by.

COLLECTION_POINT (3):

This service ships orders to an address chosen by the customer. The order is shipped from a collection point.

class StoreConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

store_service_type

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

This field is a member of oneof _store_service_type.

Type

google.shopping.merchant_accounts_v1.types.Service.StoreConfig.StoreServiceType

store_codes

Optional. A list of store codes that provide local delivery. If empty, then all_stores must be true.

Type

MutableSequence[str]

cutoff_config

Configs related to local delivery ends for the day.

This field is a member of oneof _cutoff_config.

Type

google.shopping.merchant_accounts_v1.types.Service.StoreConfig.CutoffConfig

service_radius

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

This field is a member of oneof _service_radius.

Type

google.shopping.merchant_accounts_v1.types.Distance

class CutoffConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configs related to local delivery ends for the day.

local_cutoff_time

Time that local delivery ends for the day.

This field is a member of oneof _local_cutoff_time.

Type

google.shopping.merchant_accounts_v1.types.Service.StoreConfig.CutoffConfig.LocalCutoffTime

store_close_offset_hours

Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with local_cutoff_time.

This field is a member of oneof _store_close_offset_hours.

Type

int

no_delivery_post_cutoff

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.

This field is a member of oneof _no_delivery_post_cutoff.

Type

bool

class LocalCutoffTime(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Time that local delivery ends for the day.

hour

Hour local delivery orders must be placed by to process the same day.

This field is a member of oneof _hour.

Type

int

minute

Minute local delivery orders must be placed by to process the same day.

This field is a member of oneof _minute.

Type

int

class StoreServiceType(value)

Bases: proto.enums.Enum

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

Values:

STORE_SERVICE_TYPE_UNSPECIFIED (0):

Did not specify store service type.

ALL_STORES (1):

Indicates whether all stores, current and future, listed by this business provide local delivery.

SELECTED_STORES (2):

Indicates that only the stores listed in store_codes are eligible for local delivery.

class google.shopping.merchant_accounts_v1.types.ShippingSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Identifier. The resource name of the shipping settings. Format: accounts/{account}/shippingSettings. For example, accounts/123456/shippingSettings.

Type

str

services

Optional. The target account’s list of services.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Service]

warehouses

Optional. A list of warehouses which can be referred to in services.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Warehouse]

etag

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:

1. Set the etag field as an empty string for the initial shipping setting creation.

2. After the initial creation, call the get method to obtain an etag and the current shipping setting data before calling insert.

3. Modify the shipping setting information.

4. Call the insert method with the shipping setting information and the etag obtained in step 2.

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

Type

str

class google.shopping.merchant_accounts_v1.types.Table(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Name of the table. Required for subtables, ignored for the main table.

This field is a member of oneof _name.

Type

str

row_headers

Required. Headers of the table’s rows.

This field is a member of oneof _row_headers.

Type

google.shopping.merchant_accounts_v1.types.Headers

column_headers

Headers of the table’s columns. Optional: if not set then the table has only one dimension.

This field is a member of oneof _column_headers.

Type

google.shopping.merchant_accounts_v1.types.Headers

rows

Required. The list of rows that constitute the table. Must have the same length as row_headers.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.Row]

class google.shopping.merchant_accounts_v1.types.TermsOfService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Identifier. The resource name of the terms of service version. Format: termsOfService/{version}

Type

str

region_code

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

Type

str

kind

The Kind this terms of service version applies to.

Type

google.shopping.merchant_accounts_v1.types.TermsOfServiceKind

file_uri

URI for terms of service file that needs to be displayed to signing users.

This field is a member of oneof _file_uri.

Type

str

external

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.

Type

bool

class google.shopping.merchant_accounts_v1.types.TermsOfServiceAgreementState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

Identifier. The resource name of the terms of service version. Format: accounts/{account}/termsOfServiceAgreementState/{identifier} The identifier format is: {[TermsOfServiceKind][google.shopping.merchant.accounts.v1.TermsOfServiceKind]}-{country} For example, an identifier could be: MERCHANT_CENTER-EU or MERCHANT_CENTER-US.

Type

str

region_code

Required. Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to.

Type

str

terms_of_service_kind

Required. Terms of Service kind associated with the particular version.

Type

google.shopping.merchant_accounts_v1.types.TermsOfServiceKind

accepted

Optional. The accepted terms of service of this kind and for the associated region_code

This field is a member of oneof _accepted.

Type

google.shopping.merchant_accounts_v1.types.Accepted

required

Optional. The required terms of service

This field is a member of oneof _required.

Type

google.shopping.merchant_accounts_v1.types.Required

class google.shopping.merchant_accounts_v1.types.TermsOfServiceKind(value)

Bases: proto.enums.Enum

The TermsOfService Kind.

Values:

TERMS_OF_SERVICE_KIND_UNSPECIFIED (0):

Default value. This value is unused.

MERCHANT_CENTER (1):

Merchant Center application.

class google.shopping.merchant_accounts_v1.types.TransitTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

postal_code_group_names

Required. A list of region names [Region.name][google.shopping.merchant.accounts.v1.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.

Type

MutableSequence[str]

transit_time_labels

Required. A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].

Type

MutableSequence[str]

rows

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.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.TransitTable.TransitTimeRow]

class TransitTimeRow(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

values

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

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.TransitTable.TransitTimeRow.TransitTimeValue]

class TransitTimeValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

min_transit_days

Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.

This field is a member of oneof _min_transit_days.

Type

int

max_transit_days

Must be greater than or equal to min_transit_days.

This field is a member of oneof _max_transit_days.

Type

int

class google.shopping.merchant_accounts_v1.types.UnclaimHomepageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UnclaimHomepage method.

name

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

Type

str

class google.shopping.merchant_accounts_v1.types.UnregisterGcpRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UnregisterGCP method.

name

Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: accounts/{account}/developerRegistration

Type

str

class google.shopping.merchant_accounts_v1.types.UpdateAccountRelationshipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateAccountRelationship method.

account_relationship

Required. The new version of the account relationship.

Type

google.shopping.merchant_accounts_v1.types.AccountRelationship

update_mask

Optional. List of fields being updated.

The following fields are supported (in both snake_case and lowerCamelCase):

• account_id_alias

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateAccount method.

account

Required. The new version of the account.

Type

google.shopping.merchant_accounts_v1.types.Account

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateAutofeedSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateAutofeedSettings method.

autofeed_settings

Required. The new version of the autofeed setting.

Type

google.shopping.merchant_accounts_v1.types.AutofeedSettings

update_mask

Required. List of fields being updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateAutomaticImprovementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateAutomaticImprovements method.

automatic_improvements

Required. The new version of the automatic imrovements.

Type

google.shopping.merchant_accounts_v1.types.AutomaticImprovements

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateBusinessIdentityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateBusinessIdentity method.

business_identity

Required. The new version of the business identity.

Type

google.shopping.merchant_accounts_v1.types.BusinessIdentity

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateBusinessInfoRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateBusinessInfo method.

business_info

Required. The new version of the business info.

Type

google.shopping.merchant_accounts_v1.types.BusinessInfo

update_mask

Optional. List of fields being updated.

The following fields are supported (in both snake_case and lowerCamelCase):

• address

• customer_service

• korean_business_registration_number

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateCheckoutSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateCheckoutSettings method.

checkout_settings

Required. The updated version of the CheckoutSettings. The name field is used to identify the CheckoutSettings. Format: accounts/{account}/programs/{program}/checkoutSettings

Type

google.shopping.merchant_accounts_v1.types.CheckoutSettings

update_mask

Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase):

• eligible_destinations

• uri_settings

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateEmailPreferencesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for UpdateEmailPreferences method.

email_preferences

Required. Email Preferences to be updated.

Type

google.shopping.merchant_accounts_v1.types.EmailPreferences

update_mask

Required. List of fields being updated.

The following fields are supported (in both snake_case and lowerCamelCase):

• news_and_tips

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateHomepageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateHomepage method.

homepage

Required. The new version of the homepage.

Type

google.shopping.merchant_accounts_v1.types.Homepage

update_mask

Optional. List of fields being updated.

The following fields are supported (in both snake_case and lowerCamelCase):

• uri

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateOmnichannelSettingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateOmnichannelSetting method.

omnichannel_setting

Required. The omnichannel setting to update.

The omnichannel setting’s name field is used to identify the omnichannel setting to be updated.

Type

google.shopping.merchant_accounts_v1.types.OmnichannelSetting

update_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateRegionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateRegion method.

region

Required. The updated region.

Type

google.shopping.merchant_accounts_v1.types.Region

update_mask

Optional. The comma-separated field mask indicating the fields to update. Example: "displayName,postalCodeArea.regionCode".

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UpdateUserRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateUser method.

user

Required. The new version of the user.

Use me to refer to your own email address, for example accounts/{account}/users/me.

Type

google.shopping.merchant_accounts_v1.types.User

update_mask

Optional. List of fields being updated.

The following fields are supported (in both snake_case and lowerCamelCase):

• access_rights

Type

google.protobuf.field_mask_pb2.FieldMask

class google.shopping.merchant_accounts_v1.types.UriSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

URL settings for cart or checkout URL.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

checkout_uri_template

Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the help center doc

This field is a member of oneof uri_template.

Type

str

cart_uri_template

Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the help center doc

This field is a member of oneof uri_template.

Type

str

class google.shopping.merchant_accounts_v1.types.User(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The User resource 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.

name

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.

Type

str

state

Output only. The state of the user.

Type

google.shopping.merchant_accounts_v1.types.User.State

access_rights

Required. The access rights the user has.

Type

MutableSequence[google.shopping.merchant_accounts_v1.types.AccessRight]

class State(value)

Bases: proto.enums.Enum

The state represents the possible statuses of a user. It is an output-only field that is set to PENDING when a user is invited to an account and changes to VERIFIED once the user accepts the invitation.

Values:

STATE_UNSPECIFIED (0):

Default value. This value is unused.

PENDING (1):

The user is pending confirmation. In this state, the user first needs to accept the invitation before performing other actions.

VERIFIED (2):

The user is verified.

class google.shopping.merchant_accounts_v1.types.Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

no_shipping

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.

This field is a member of oneof _no_shipping.

Type

bool

flat_rate

A flat rate. Can only be set if all other fields are not set.

This field is a member of oneof _flat_rate.

Type

google.shopping.type.types.Price

price_percentage

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.

This field is a member of oneof _price_percentage.

Type

str

carrier_rate

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.

This field is a member of oneof _carrier_rate.

Type

str

subtable

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.

This field is a member of oneof _subtable.

Type

str

class google.shopping.merchant_accounts_v1.types.VerificationMailSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings related to the verification email that is sent after adding a user.

verification_mail_mode

Optional. Mode of the verification mail. If not set, the default is SEND_VERIFICATION_MAIL.

Type

google.shopping.merchant_accounts_v1.types.VerificationMailSettings.VerificationMailMode

class VerificationMailMode(value)

Bases: proto.enums.Enum

The different configuration options for sending a verification email when adding a user.

Values:

VERIFICATION_MAIL_MODE_UNSPECIFIED (0):

Default first member of every enum. Do not use.

SEND_VERIFICATION_MAIL (1):

An invitation email is sent to the user added shortly after.

SUPPRESS_VERIFICATION_MAIL (2):

No invitation email is sent. This can be useful if the user is expected to accept the invitation through the API without needing another notification.

class google.shopping.merchant_accounts_v1.types.VerifySelfRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the VerifySelf method.

account

Required. The name of the account under which the caller is a user. Format: accounts/{account}

Type

str

class google.shopping.merchant_accounts_v1.types.Warehouse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A fulfillment warehouse, which stores and handles inventory.

name

Required. The name of the warehouse. Must be unique within account.

This field is a member of oneof _name.

Type

str

shipping_address

Required. Shipping address of the warehouse.

This field is a member of oneof _shipping_address.

Type

google.shopping.merchant_accounts_v1.types.Address

cutoff_time

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.

This field is a member of oneof _cutoff_time.

Type

google.shopping.merchant_accounts_v1.types.WarehouseCutoffTime

handling_days

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.

This field is a member of oneof _handling_days.

Type

int

business_day_config

Business days of the warehouse. If not set, will be Monday to Friday by default.

This field is a member of oneof _business_day_config.

Type

google.shopping.merchant_accounts_v1.types.BusinessDayConfig

class google.shopping.merchant_accounts_v1.types.WarehouseBasedDeliveryTime(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

carrier

Required. Carrier, such as "UPS" or "Fedex". supported carriers

This field is a member of oneof _carrier.

Type

str

carrier_service

Required. Carrier service, such as "ground" or "2 days". The name of the service must be in the eddSupportedServices list.

This field is a member of oneof _carrier_service.

Type

str

warehouse

Required. Warehouse name. This should match [warehouse][google.shopping.merchant.accounts.v1.Warehouse].

This field is a member of oneof _warehouse.

Type

str

class google.shopping.merchant_accounts_v1.types.WarehouseCutoffTime(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

hour

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.

This field is a member of oneof _hour.

Type

int

minute

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.

This field is a member of oneof _minute.

Type

int