Namespace Google.Apis.Merchant.accounts_v1beta.Data

Classes

AcceptTermsOfServiceResponse

Response message for the AcceptTermsOfService method.

Accepted

Describes the accepted terms of service.

The Account message represents a merchant'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 multi-client account (MCA) structure. In an MCA setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The Account message is the parent entity for many other resources, for example, AccountRelationship, Homepage, BusinessInfo and so on.

AccountAggregation

AccountAggregation payload.

AccountIssue

An AccountIssue.

AccountManagement

AccountManagement payload.

AccountRelationship

The AccountRelationship message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant'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).

AccountService

The AccountService message represents a specific service that a provider account offers to a merchant 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 merchant 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.

AddAccountService

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

AddUser

Instruction for adding a user to the account during creation.

Address

Shipping address of the warehouse.

ApproveAccountServiceRequest

Request to approve an account service.

AutofeedSettings

Collection of information related to the autofeed settings.

AutomaticImageImprovements

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

AutomaticImprovements

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

AutomaticItemUpdates

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

AutomaticShippingImprovements

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

BusinessDayConfig

Business days of the warehouse.

BusinessIdentity

Collection of information related to the identity of a business.

BusinessInfo

The BusinessInfo message contains essential information about a merchant's business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers.

CampaignsManagement

CampaignManagement payload.

CarrierRate

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

ClaimHomepageRequest

Request message for the ClaimHomepage method.

CreateAndConfigureAccountRequest

Request message for the CreateAndConfigureAccount method.

CreateUserRequest

Request message for the CreateUser method.

CustomerService

Customer service information.

CutoffConfig

Configs related to local delivery ends for the day.

CutoffTime

Business days cutoff time definition.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

DeliveryTime

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

DisableProgramRequest

Request message for the DisableProgram method.

Distance

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

EmailPreferences

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

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

EnableProgramRequest

Request message for the EnableProgram method.

GeoTargetArea

A list of geotargets that defines the region area.

Handshake

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

Headers

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

Homepage

The Homepage message represents a merchant's store homepage within the system. A merchant'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 merchant to unlock features that require a verified website. For more information, see Understanding online store URL verification.

IdentityAttribute

All information related to an identity attribute.

ImageImprovementsAccountLevelSettings

Settings for the Automatic Image Improvements.

Impact

The impact of the issue on a region.

ImpactedDestination

The impact of the issue on a destination.

ItemUpdatesAccountLevelSettings

Settings for the Automatic Item Updates.

ListAccountIssuesResponse

Response message for the ListAccountIssues method.

ListAccountRelationshipsResponse

Response after trying to list account relationships.

ListAccountServicesResponse

Response after trying to list account services.

ListAccountsResponse

Response message for the ListAccounts method.

ListOnlineReturnPoliciesResponse

Response message for the ListOnlineReturnPolicies method.

ListProgramsResponse

Response message for the ListPrograms method.

ListRegionsResponse

Response message for the ListRegions method.

ListSubAccountsResponse

Response message for the ListSubAccounts method.

ListUsersResponse

Response message for the ListUsers method.

LocalCutoffTime

Time that local delivery ends for the day.

LocationIdSet

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

LoyaltyProgram

Loyalty program provided by a merchant.

LoyaltyProgramTiers

Subset of a merchants loyalty program.

MinimumOrderValueTable

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

OnlineReturnPolicy

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

PhoneNumber

An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an i18n.phonenumbers.PhoneNumber object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber

Policy

The available policies.

PostalAddress

Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.

PostalCodeArea

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

PostalCodeRange

A range of postal codes that defines the region area.

Price

The price represented as a number and currency.

ProductChange

The change that happened to the product including old value, new value, country code as the region code and reporting context.

ProductStatusChangeMessage

The message that the merchant will receive to notify about product status change event

ProductsManagement

ProductsManagement payload.

Program

Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * free-listings * shopping-ads * youtube-shopping-checkout

ProposeAccountServiceRequest

Request to propose an account service.

RateGroup

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

Region

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

RejectAccountServiceRequest

Request to reject an account service.

Required

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

Requirement

Defines a requirement specified for participation in the program.

RestockingFee

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

ReturnShippingFee

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

Row

Include a list of cells.

SeasonalOverride

Service

Shipping service.

ShippingSettings

The merchant account's shipping settings.

ShortCode

An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA).

StoreCodeSetWithMov

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

StoreConfig

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

Table

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

TermsOfService

The TermsOfService message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see Terms of Service. This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given kind and region through RetrieveLatestTermsOfService, and accept them as required through AcceptTermsOfService.

TermsOfServiceAgreementState

This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service, accepted will be populated, otherwise it will be empty * If the merchant must sign a terms of service, required will be populated, otherwise it will be empty. Note that both required and accepted can be present. In this case the accepted terms of services will have an expiration date set in the valid_until field. The required terms of services need to be accepted before valid_until in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as tos_file_uri). The actual acceptance of the terms of service is done by calling accept on the TermsOfService resource.

TimeZone

Represents a time zone from the IANA Time Zone Database.

TransitTable

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

TransitTimeRow

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