Index
About(message)AcceptTermsOfServiceRequest(message)AcceptTermsOfServiceResponse(message)Accepted(message)AccessRight(enum)Account(message)AccountAggregation(message)AccountIssue(message)AccountManagement(message)AccountRelationship(message)AccountService(message)Address(message)ApproveAccountServiceRequest(message)AutofeedSettings(message)AutomaticImageImprovements(message)AutomaticImprovements(message)AutomaticItemUpdates(message)AutomaticShippingImprovements(message)BatchCreateRegionsRequest(message)BatchCreateRegionsResponse(message)BatchDeleteRegionsRequest(message)BatchUpdateRegionsRequest(message)BatchUpdateRegionsResponse(message)BusinessDayConfig(message)BusinessIdentity(message)BusinessInfo(message)CampaignsManagement(message)CarrierRate(message)CheckoutSettings(message)ClaimHomepageRequest(message)ComparisonShopping(message)CreateAndConfigureAccountRequest(message)CreateCheckoutSettingsRequest(message)CreateOmnichannelSettingRequest(message)CreateOnlineReturnPolicyRequest(message)CreateRegionRequest(message)CreateTestAccountRequest(message)CreateUserRequest(message)CustomerService(message)CutoffTime(message)DeleteAccountRequest(message)DeleteCheckoutSettingsRequest(message)DeleteOnlineReturnPolicyRequest(message)DeleteRegionRequest(message)DeleteUserRequest(message)DeliveryTime(message)DeveloperRegistration(message)DisableProgramRequest(message)Distance(message)EmailPreferences(message)EnableProgramRequest(message)FindLfpProvidersRequest(message)FindLfpProvidersResponse(message)GbpAccount(message)GetAccountForGcpRegistrationResponse(message)GetAccountRelationshipRequest(message)GetAccountRequest(message)GetAccountServiceRequest(message)GetAutofeedSettingsRequest(message)GetAutomaticImprovementsRequest(message)GetBusinessIdentityRequest(message)GetBusinessInfoRequest(message)GetCheckoutSettingsRequest(message)GetDeveloperRegistrationRequest(message)GetEmailPreferencesRequest(message)GetHomepageRequest(message)GetOmnichannelSettingRequest(message)GetOnlineReturnPolicyRequest(message)GetProgramRequest(message)GetRegionRequest(message)GetShippingSettingsRequest(message)GetTermsOfServiceAgreementStateRequest(message)GetTermsOfServiceRequest(message)GetUserRequest(message)Handshake(message)Headers(message)Homepage(message)InStock(message)InsertShippingSettingsRequest(message)InventoryVerification(message)LfpLink(message)LfpProvider(message)LinkGbpAccountRequest(message)LinkGbpAccountResponse(message)LinkLfpProviderRequest(message)LinkLfpProviderResponse(message)ListAccountIssuesRequest(message)ListAccountIssuesResponse(message)ListAccountRelationshipsRequest(message)ListAccountRelationshipsResponse(message)ListAccountServicesRequest(message)ListAccountServicesResponse(message)ListAccountsRequest(message)ListAccountsResponse(message)ListGbpAccountsRequest(message)ListGbpAccountsResponse(message)ListOmnichannelSettingsRequest(message)ListOmnichannelSettingsResponse(message)ListOnlineReturnPoliciesRequest(message)ListOnlineReturnPoliciesResponse(message)ListProgramsRequest(message)ListProgramsResponse(message)ListRegionsRequest(message)ListRegionsResponse(message)ListSubAccountsRequest(message)ListSubAccountsResponse(message)ListUsersRequest(message)ListUsersResponse(message)LocalListingManagement(message)LocationIdSet(message)MinimumOrderValueTable(message)OmnichannelSetting(message)OnDisplayToOrder(message)OnlineReturnPolicy(message)PhoneVerificationState(enum)Pickup(message)ProductAttributePredicate(message)ProductFilter(message)ProductsManagement(message)Program(message)ProposeAccountServiceRequest(message)RateGroup(message)Region(message)RegisterGcpRequest(message)RejectAccountServiceRequest(message)RequestInventoryVerificationRequest(message)RequestInventoryVerificationResponse(message)Required(message)RetrieveForApplicationTermsOfServiceAgreementStateRequest(message)RetrieveLatestTermsOfServiceRequest(message)ReviewState(message)Row(message)Service(message)ShippingSettings(message)Table(message)TermsOfService(message)TermsOfServiceAgreementState(message)TermsOfServiceKind(enum)TransitTable(message)UnclaimHomepageRequest(message)UnregisterGcpRequest(message)UpdateAccountRelationshipRequest(message)UpdateAccountRequest(message)UpdateAutofeedSettingsRequest(message)UpdateAutomaticImprovementsRequest(message)UpdateBusinessIdentityRequest(message)UpdateBusinessInfoRequest(message)UpdateCheckoutSettingsRequest(message)UpdateEmailPreferencesRequest(message)UpdateHomepageRequest(message)UpdateOmnichannelSettingRequest(message)UpdateRegionRequest(message)UpdateUserRequest(message)UriSettings(message)User(message)Value(message)VerificationMailSettings(message)VerifySelfRequest(message)Warehouse(message)WarehouseBasedDeliveryTime(message)WarehouseCutoffTime(message)
ImpactedDestination
The impact of the issue on a destination.
| Fields | |
|---|---|
impacts[] |
The (negative) impact for various regions on the given destination. |
reporting_context |
The impacted reporting context. |
Impact
The impact of the issue on a region.
| Fields | |
|---|---|
region_code |
The CLDR region code where this issue applies. |
severity |
The severity of the issue on the destination and region. |
Severity
All possible issue severities.
| Enums | |
|---|---|
SEVERITY_UNSPECIFIED |
The severity is unknown. |
CRITICAL |
The issue causes offers to not serve. |
ERROR |
The issue might affect offers (in the future) or might be an indicator of issues with offers. |
SUGGESTION |
The issue is a suggestion for improvement. |
Mutability
The list of mutability option settings a service can have.
| Enums | |
|---|---|
MUTABILITY_UNSPECIFIED |
Unused default value |
MUTABLE |
The service can be mutated without restrictions. |
IMMUTABLE |
The service is read-only and must not be mutated. |
ImageImprovementsAccountLevelSettings
Settings for the Automatic Image Improvements.
| Fields | |
|---|---|
allow_automatic_image_improvements |
Enables automatic image improvements. |
ItemUpdatesAccountLevelSettings
Settings for the Automatic Item Updates.
| Fields | |
|---|---|
allow_price_updates |
If price updates are enabled, Google always updates the active price with the crawled information. |
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 |
If |
allow_condition_updates |
If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product. |
Weekday
| Enums | |
|---|---|
WEEKDAY_UNSPECIFIED |
|
MONDAY |
|
TUESDAY |
|
WEDNESDAY |
|
THURSDAY |
|
FRIDAY |
|
SATURDAY |
|
SUNDAY |
|
IdentityAttribute
All information related to an identity attribute.
| Fields | |
|---|---|
identity_declaration |
Required. The declaration of identity for this attribute. |
IdentityDeclaration
All possible settings regarding the declaration of an identity.
| Enums | |
|---|---|
IDENTITY_DECLARATION_UNSPECIFIED |
Default value indicating that no selection was made. |
SELF_IDENTIFIES_AS |
Indicates that the account identifies with the attribute. |
DOES_NOT_SELF_IDENTIFY_AS |
Indicates that the account does not identify with the attribute. |
PromotionsConsent
All possible settings regarding promotions related to the business identity.
| Enums | |
|---|---|
PROMOTIONS_CONSENT_UNSPECIFIED |
Default value indicating that no selection was made. |
PROMOTIONS_CONSENT_GIVEN |
Indicates that the account consented to having their business identity used for promotions. |
PROMOTIONS_CONSENT_DENIED |
Indicates that the account did not consent to having their business identity used for promotions. |
CheckoutEnrollmentState
Enum indicating the enrollment state of merchant in Checkout program.
| Enums | |
|---|---|
CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED |
Default enrollment state when enrollment state is not specified. |
INACTIVE |
Merchant has not enrolled into the program. |
ENROLLED |
Merchant has enrolled into the program by providing either an account level URL or checkout URLs as part of their feed. |
OPTED_OUT |
Merchant has previously enrolled but opted out of the program. |
CheckoutReviewState
Enum indicating the review state of merchant in Checkout program.
| Enums | |
|---|---|
CHECKOUT_REVIEW_STATE_UNSPECIFIED |
Default review state when review state is not specified. |
IN_REVIEW |
Merchant provided URLs are being reviewed for data quality issues. |
APPROVED |
Merchant account has been approved. Indicates the data quality checks have passed. |
DISAPPROVED |
Merchant account has been disapproved due to data quality issues. |
Proposal
Details about the proposal for a comparison_shopping instance.
| Fields | |
|---|---|
new_mca_account |
Optional. Immutable. The name of the advanced account under which the account would be moved once the instance has been established. If provided the account will be moved under this advanced account as part of the switch. Note that the provided advanced account must be a member of the CSS the account will be switched to. If no new_mca_account is provided the account will be made standalone after the switch is executed. Format: |
waiting_until_time |
Output only. The time in the future when proposal in WAITING state will be executed and moved to ESTABLISHED. |
AddAccountService
Additional instructions to add account services during creation of the account.
| Fields | |
|---|---|
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 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. |
Union field service_type. The service type to be added. service_type can be only one of the following: |
|
account_aggregation |
The provider is an aggregator for the account. Payload for service type Account Aggregation. |
account_management |
The provider manages this account. Payload for service type Account Management. |
comparison_shopping |
The provider is a CSS (Comparison Shopping Service) of this account. Payload for service type Comparison Shopping. |
products_management |
The provider manages products for this account. Payload for service type products management. |
campaigns_management |
The provider manages campaigns for this account. Payload for service type campaigns management. |
provider |
Required. The provider of the service. Either the reference to an account such as |
AddUser
Instruction for adding a user to the account during creation.
| Fields | |
|---|---|
user_id |
Required. The email address of the user (for example, |
user |
Optional. Details about the user to be added. At the moment, only access rights may be specified. |
verification_mail_settings |
Optional. Settings related to configuring the verification email that is sent after adding a user. |
SetAliasForRelationship
Set an alias for a relationship between a provider and the account to be created.
| Fields | |
|---|---|
provider |
Required. The provider of the service. This is a reference to an account such as |
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. |
Unit
Unit can differ based on country, it is parameterized to include miles and kilometers.
| Enums | |
|---|---|
UNIT_UNSPECIFIED |
Unit unspecified |
MILES |
Unit in miles |
KILOMETERS |
Unit in kilometers |
OptInState
Opt in state of the email preference.
| Enums | |
|---|---|
OPT_IN_STATE_UNSPECIFIED |
Opt-in status is not specified. |
OPTED_OUT |
User has opted out of receiving this type of email. |
OPTED_IN |
User has opted in to receiving this type of email. |
UNCONFIRMED |
User has opted in to receiving this type of email and the confirmation email has been sent, but user has not yet confirmed the opt in (applies only to certain countries). |
Type
The type of the GBP account.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Default value. This value is unused. |
USER |
The GBP account is a user account. |
BUSINESS_ACCOUNT |
The GBP account is a business account. |
Actor
The various actors that can be involved in a handshake.
| Enums | |
|---|---|
ACTOR_UNSPECIFIED |
Unspecified actor. |
ACCOUNT |
The last change was done by the account who has this service. |
OTHER_PARTY |
The last change was done by the other party who this service points to. |
ApprovalState
The approal state of a handshake.
| Enums | |
|---|---|
APPROVAL_STATE_UNSPECIFIED |
Unspecified approval status. |
PENDING |
The service was proposed and is waiting to be confirmed. |
WAITING |
Indicates that the service proposal has been accepted and will be established after a fixed delay set by the service provider. |
ESTABLISHED |
Both parties have confirmed the service. |
REJECTED |
The service proposal was rejected. |
State
The state of the inventory verification process.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
ACTION_REQUIRED |
When the merchant needs to initiate the inventory verification process. The next state is INACTIVE. |
INACTIVE |
When the merchant is ready to request inventory verification. |
RUNNING |
The inventory verification process is running. If the merchant is rejected, the next state is INACTIVE. |
SUCCEEDED |
The inventory verification process succeeded. |
SUSPENDED |
When merchant fails the inventory verification process and all attempts are exhausted. |
StoreCodeSetWithMov
A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
| Fields | |
|---|---|
store_codes[] |
Optional. A list of unique store codes or empty for the catch all. |
value |
The minimum order value for the given stores. |
LsfType
The product page experience type, which is also called the Local Store Front (LSF) type. Check the HC article for more details.
| Enums | |
|---|---|
LSF_TYPE_UNSPECIFIED |
Default value. This value is unused. |
GHLSF |
Google-Hosted Local Store Front. Check the HC article for more details. |
MHLSF_BASIC |
Merchant-Hosted Local Store Front Basic. Check the HC article for more details. |
MHLSF_FULL |
Merchant-Hosted Local Store Front Full. Check the HC article for more details. |
ItemCondition
The available item conditions.
| Enums | |
|---|---|
ITEM_CONDITION_UNSPECIFIED |
Default value. This value is unused. |
NEW |
New. |
USED |
Used. |
Policy
The available policies.
| Fields | |
|---|---|
type |
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 |
Type
Return policy types.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Default value. This value is unused. |
NUMBER_OF_DAYS_AFTER_DELIVERY |
The number of days within which a return is valid after delivery. |
NO_RETURNS |
No returns. |
LIFETIME_RETURNS |
Life time returns. |
RestockingFee
The restocking fee. This can be a flat fee or a micro percent.
| Fields | |
|---|---|
Union field
|
|
fixed_fee |
Fixed restocking fee. |
micro_percent |
Percent of total price in micros. 15,000,000 means 15% of the total price would be charged. |
ReturnLabelSource
The available return label sources.
| Enums | |
|---|---|
RETURN_LABEL_SOURCE_UNSPECIFIED |
Default value. This value is unused. |
DOWNLOAD_AND_PRINT |
Download and print. |
IN_THE_PACKAGE |
Label include in the package. |
CUSTOMER_RESPONSIBILITY |
Customer to provide. |
ReturnMethod
The available return methods.
| Enums | |
|---|---|
RETURN_METHOD_UNSPECIFIED |
Default value. This value is unused. |
BY_MAIL |
Return by mail. |
IN_STORE |
Return in store. |
AT_A_KIOSK |
Return at a kiosk. |
ReturnShippingFee
The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.
| Fields | |
|---|---|
type |
Required. Type of return shipping fee. |
fixed_fee |
Fixed return shipping fee amount. This value is only applicable when type is |
Type
Return shipping fee types.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Default value. This value is unused. |
FIXED |
The return shipping fee is a fixed value. |
CUSTOMER_PAYING_ACTUAL_FEE |
Customers will pay the actual return shipping fee. |
SeasonalOverride
| Fields | |
|---|---|
label |
Required. Display name of this seasonal override in Merchant Center. |
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. |
end_date |
Required. seasonal override end date (inclusive). |
Union field return_window. ReturnWindow: Specifies either a fixed return date or the number of days (from the delivery date) until which a product can be returned. Merchant Return Days return_window can be only one of the following: |
|
return_days |
Number of days (from the delivery date) that the product can be returned. |
return_until_date |
Fixed end date until which the product can be returned. |
ProductAttribute
The type of the product attribute to filter by.
| Enums | |
|---|---|
PRODUCT_ATTRIBUTE_UNSPECIFIED |
Unspecified product attribute. |
BRAND |
The brand of the product. |
CUSTOM_LABEL_0 |
The custom label 0 of the product. |
CUSTOM_LABEL_1 |
The custom label 1 of the product. |
CUSTOM_LABEL_2 |
The custom label 2 of the product. |
CUSTOM_LABEL_3 |
The custom label 3 of the product. |
CUSTOM_LABEL_4 |
The custom label 4 of the product. |
Requirement
Defines a requirement specified for participation in the program.
| Fields | |
|---|---|
title |
Output only. Name of the requirement. |
documentation_uri |
Output only. The URL of a help page describing the requirement. |
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 |
State
Possible program participation states for the account.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
NOT_ELIGIBLE |
The account is not eligible to participate in the program. |
ELIGIBLE |
The account is eligible to participate in the program. |
ENABLED |
The program is enabled for the account. |
GeoTargetArea
A list of geotargets that defines the region area.
| Fields | |
|---|---|
geotarget_criteria_ids[] |
Required. A non-empty list of location IDs. They must all be of the same location type (for example, state). |
PostalCodeArea
A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible through the account's ShippingSettings.postalCodeGroups resource.
| Fields | |
|---|---|
region_code |
Required. CLDR territory code or the country the postal code group applies to. |
postal_codes[] |
Required. A range of postal codes. |
PostalCodeRange
A range of postal codes that defines the region area.
| Fields | |
|---|---|
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: |
end |
Optional. A postal code or a pattern of the form |
RadiusArea
A radius area that defines the region area.
| Fields | |
|---|---|
region_code |
Required. CLDR territory code or the country the radius area applies to. |
lat_lng |
Required. The center of the radius area. It represents a latitude/longitude pair in decimal degrees format. |
radius |
Required. The radius distance of the area. |
radius_units |
Optional. The unit of the radius. |
RadiusUnits
The unit of measurement of the radius. Default is KILOMETERS.
| Enums | |
|---|---|
RADIUS_UNITS_UNSPECIFIED |
Unused default value |
MILES |
The distance is measured in miles. |
KILOMETERS |
The distance is measured in kilometers. |
State
The state of the review process.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
ACTIVE |
The review process has concluded successfully. The reviewed item is active. |
FAILED |
The review process failed. |
RUNNING |
The review process is running. |
ACTION_REQUIRED |
The review process is waiting for the merchant to take action. |
LoyaltyProgram
Loyalty program provided by a business.
| Fields | |
|---|---|
loyalty_program_tiers[] |
Optional. Loyalty program tier of this shipping service. |
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. |
LoyaltyProgramTiers
Subset of a business's loyalty program.
| Fields | |
|---|---|
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. |
ShipmentType
Shipment type of shipping service.
| Enums | |
|---|---|
SHIPMENT_TYPE_UNSPECIFIED |
This service did not specify shipment type. |
DELIVERY |
This service ships orders to an address chosen by the customer. |
LOCAL_DELIVERY |
This service ships orders to an address chosen by the customer. The order is shipped from a local store near by. |
COLLECTION_POINT |
This service ships orders to an address chosen by the customer. The order is shipped from a collection point. |
StoreConfig
A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
| Fields | |
|---|---|
store_codes[] |
Optional. A list of store codes that provide local delivery. If empty, then |
store_service_type |
Indicates whether all stores, or selected stores, listed by this business provide local delivery. |
cutoff_config |
Configs related to local delivery ends for the day. |
service_radius |
Maximum delivery radius. This is only required for the local delivery shipment type. |
CutoffConfig
Configs related to local delivery ends for the day.
| Fields | |
|---|---|
local_cutoff_time |
Time that local delivery ends for the day. |
store_close_offset_hours |
Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with |
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 |
LocalCutoffTime
Time that local delivery ends for the day.
| Fields | |
|---|---|
hour |
Hour local delivery orders must be placed by to process the same day. |
minute |
Minute local delivery orders must be placed by to process the same day. |
StoreServiceType
Indicates whether all stores, or selected stores, listed by the business provide local delivery.
| Enums | |
|---|---|
STORE_SERVICE_TYPE_UNSPECIFIED |
Did not specify store service type. |
ALL_STORES |
Indicates whether all stores, current and future, listed by this business provide local delivery. |
SELECTED_STORES |
Indicates that only the stores listed in store_codes are eligible for local delivery. |
TransitTimeRow
If there's only one dimension set of postal_code_group_names or transit_time_labels, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a postal_code_group_names, and columns (values) to a transit_time_labels.
| Fields | |
|---|---|
values[] |
Required. Transit time range (min-max) in business days. |
TransitTimeValue
Transit time range (min-max) in business days.
| Fields | |
|---|---|
min_transit_days |
Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery. |
max_transit_days |
Must be greater than or equal to |
State
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.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
PENDING |
The user is pending confirmation. In this state, the user first needs to accept the invitation before performing other actions. |
VERIFIED |
The user is verified. |
VerificationMailMode
The different configuration options for sending a verification email when adding a user.
| Enums | |
|---|---|
VERIFICATION_MAIL_MODE_UNSPECIFIED |
Default first member of every enum. Do not use. |
SEND_VERIFICATION_MAIL |
An invitation email is sent to the user added shortly after. |
SUPPRESS_VERIFICATION_MAIL |
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. |