merchantapi/accounts_v1 library

Classes

About
Collection of information related to the about page (impressum).
Accepted
Describes the accepted terms of service.
AcceptTermsOfServiceResponse
Response message for the AcceptTermsOfService method.
Account
The Account message represents a business's account within Shopping Ads.
AccountIssue
Issues with your Merchant Center account that can impact all your products.
AccountRelationship
The AccountRelationship message defines a formal connection between a merchant's account and a service provider's account.
AccountsAutofeedSettingsResource
AccountsAutomaticImprovementsResource
AccountsBusinessIdentityResource
AccountsBusinessInfoResource
AccountsDeveloperRegistrationResource
AccountsEmailPreferencesResource
AccountService
The AccountService message represents a specific service that a provider account offers to a Merchant Center account.
AccountsGbpAccountsResource
AccountsHomepageResource
AccountsIssuesResource
AccountsOmnichannelSettingsLfpProvidersResource
AccountsOmnichannelSettingsResource
AccountsOnlineReturnPoliciesResource
AccountsProgramsCheckoutSettingsResource
AccountsProgramsResource
AccountsRegionsResource
AccountsRelationshipsResource
AccountsResource
AccountsServicesResource
AccountsShippingSettingsResource
AccountsTermsOfServiceAgreementStatesResource
AccountsUsersResource
AddAccountService
Additional instructions to add account services during creation of the account.
Address
Shipping address of the warehouse.
AddUser
Instruction for adding a user to the account during creation.
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.
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.
BatchCreateRegionsRequest
Request message for the BatchCreateRegions method.
BatchCreateRegionsResponse
Response message for the BatchCreateRegions method.
BatchDeleteRegionsRequest
Request message for the BatchDeleteRegions method.
BatchUpdateRegionsRequest
Request message for the BatchUpdateRegions method.
BatchUpdateRegionsResponse
Response message for the BatchUpdateRegions method.
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 business.
CarrierRate
A list of carrier rates that can be referred to by main_table or single_value.
CheckoutSettings
CheckoutSettings for a specific merchant.
ClaimHomepageRequest
Request message for the ClaimHomepage method.
CreateAndConfigureAccountRequest
Request message for the CreateAndConfigureAccount method.
CreateRegionRequest
Request message for the CreateRegion method.
CustomerService
Customer service information.
CutoffConfig
Configs related to local delivery ends for the day.
CutoffTime
Business days cutoff time definition.
DeleteRegionRequest
Request message for the DeleteRegion method.
DeliveryTime
Time spent in various aspects from order to the delivery of the product.
DeveloperRegistration
Represents a developer registration owned by a Merchant account.
Distance
Maximum delivery radius.
EmailPreferences
The categories of notifications the user opted into / opted out of.
FindLfpProvidersResponse
Response message for the FindLfpProviders method.
GbpAccount
Collection of information related to a Google Business Profile (GBP) account.
GeoTargetArea
A list of geotargets that defines the region area.
GetAccountForGcpRegistrationResponse
Response message for the GetAccountForGcpRegistration method.
Handshake
The current status of establishing of the service.
Headers
A non-empty list of row or column headers for a table.
Homepage
The Homepage message represents a business's store homepage within the system.
IdentityAttribute
All information related to an identity attribute.
Impact
The impact of the issue on a region.
ImpactedDestination
The impact of the issue on a destination.
InStock
Collection of information related to InStock.
InventoryVerification
Collection of information related to inventory verification.
ItemUpdatesAccountLevelSettings
Settings for the Automatic Item Updates.
Collection of information related to the LFP link.
LfpProvider
Collection of information related to a Local Feed Partnership (LFP) provider.
LinkGbpAccountRequest
Request message for the LinkGbpAccount method.
LinkGbpAccountResponse
Response message for the LinkGbpAccount method.
LinkLfpProviderRequest
Request message for the LinkLfpProvider method.
LinkLfpProviderResponse
Response message for the LinkLfpProvider method.
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 accounts.list method.
ListGbpAccountsResponse
Response message for the ListGbpAccounts method.
ListOmnichannelSettingsResponse
Response message for the ListOmnichannelSettings 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.
LocationIdSet
A list of location ID sets.
LoyaltyProgram
Loyalty program provided by a business.
LoyaltyProgramTiers
Subset of a business's loyalty program.
MerchantApi
Programmatically manage your Merchant Center Accounts.
MinimumOrderValueTable
Table of per store minimum order values for the pickup fulfillment type.
OmnichannelSetting
Collection of information related to the omnichannel settings of a merchant.
OnDisplayToOrder
Collection of information related to the on display to order (ODO).
OnlineReturnPolicy
Online return policy object.
PhoneNumber
An object representing a phone number, suitable as an API wire format.
Pickup
Collection of information related to Pickup.
Policy
The available policies.
PostalCodeArea
A list of postal codes that defines the region area.
PostalCodeRange
A range of postal codes that defines the region area.
Program
Defines participation in a given program for the specified account.
ProposeAccountServiceRequest
Request to propose an account service.
RateGroup
Shipping rate group definitions.
Region
Represents a geographic region that you can use as a target with both the RegionalInventory and ShippingSettings services.
RegisterGcpRequest
Request message for the RegisterGCP method.
RequestInventoryVerificationResponse
Response message for the RequestInventoryVerification method.
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.
ReturnShippingFee
The return shipping fee.
Row
Include a list of cells.
SeasonalOverride
Service
Shipping service.
ShippingSettings
The Merchant Center 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.").
StoreCodeSetWithMov
A list of store code sets sharing the same minimum order value.
StoreConfig
A list of stores your products are delivered from.
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.
TermsOfServiceAgreementState
This resource represents the agreement state for a given account and terms of service kind.
TermsOfServiceResource
TransitTable
Transit time table, number of business days spent in transit based on row and column dimensions.
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.
TransitTimeValue
Transit time range (min-max) in business days.
UpdateRegionRequest
Request message for the UpdateRegion method.
UriSettings
URL settings for cart or checkout URL.
User
The User message represents a user associated with a Merchant Center account.
Value
The single value of a rate group or the value of a rate group table's cell.
Warehouse
A fulfillment warehouse, which stores and handles inventory.
WarehouseBasedDeliveryTime
Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier.
WarehouseCutoffTime
The latest time of day that an order can be accepted and begin processing.
Weight
The weight represented as the value in string and the unit.

Typedefs

AccountAggregation = $Empty
AccountAggregation payload.
AccountManagement = $Empty
AccountManagement payload.
ApproveAccountServiceRequest = $Empty
Request to approve an account service.
AutomaticShippingImprovements = $ShippingImprovements
Not available for advanced accounts.
CampaignsManagement = $Empty
CampaignManagement payload.
Date = $Date
Represents a whole or partial calendar date, such as a birthday.
DisableProgramRequest = $Empty
Request message for the DisableProgram method.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
EnableProgramRequest = $Empty
Request message for the EnableProgram method.
ImageImprovementsAccountLevelSettings = $Settings
Settings for the Automatic Image Improvements.
LocalCutoffTime = $LocalCutoffTime
Time that local delivery ends for the day.
LocalListingManagement = $Empty
LocalListingManagement payload.
PostalAddress = $PostalAddress
Represents a postal address, such as for postal delivery or payments addresses.
Price = $Price
The price represented as a number and currency.
ProductsManagement = $Empty
ProductsManagement payload.
RejectAccountServiceRequest = $Empty
Request to reject an account service.
RequestInventoryVerificationRequest = $Empty
Request message for the RequestInventoryVerification method.
TimeZone = $TimeZone
Represents a time zone from the IANA Time Zone Database.
UnclaimHomepageRequest = $Empty
Request message for the UnclaimHomepage method.
UnregisterGcpRequest = $Empty
Request message for the UnregisterGCP method.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.