googleapis
Version:
Google APIs Client Library for Node.js
929 lines • 435 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace merchantapi_accounts_v1 {
export interface Options extends GlobalOptions {
version: 'accounts_v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Merchant API
*
* Programmatically manage your Merchant Center Accounts.
*
* @example
* ```js
* const {google} = require('googleapis');
* const merchantapi = google.merchantapi('accounts_v1');
* ```
*/
export class Merchantapi {
context: APIRequestContext;
accounts: Resource$Accounts;
termsOfService: Resource$Termsofservice;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)).
*/
export interface Schema$About {
/**
* Output only. The state of the URI.
*/
state?: string | null;
/**
* Required. The about page URI.
*/
uri?: string | null;
}
/**
* Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service).
*/
export interface Schema$Accepted {
/**
* Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account.
*/
acceptedBy?: string | null;
/**
* Required. The accepted termsOfService.
*/
termsOfService?: string | null;
/**
* 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.
*/
validUntil?: Schema$Date;
}
/**
* Response message for the `AcceptTermsOfService` method.
*/
export interface Schema$AcceptTermsOfServiceResponse {
/**
* The agreement state after accepting the ToS.
*/
termsOfServiceAgreementState?: Schema$TermsOfServiceAgreementState;
}
/**
* The `Account` message represents a business's account within Merchant Center. 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.
*/
export interface Schema$Account {
/**
* Output only. The ID of the account.
*/
accountId?: string | null;
/**
* Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information.
*/
accountName?: string | null;
/**
* Optional. Whether this account contains adult content.
*/
adultContent?: boolean | null;
/**
* Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
*/
languageCode?: string | null;
/**
* Identifier. The resource name of the account. Format: `accounts/{account\}`
*/
name?: string | null;
/**
* Output only. Whether this is a test account.
*/
testAccount?: boolean | null;
/**
* 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.
*/
timeZone?: Schema$TimeZone;
}
/**
* `AccountAggregation` payload.
*/
export interface Schema$AccountAggregation {
}
/**
* Issues with your Merchant Center account that can impact all your products. For more information, see [Account-level issues in Merchant Center](https://support.google.com/merchants/answer/12153802?sjid=17798438912526418908-EU#account).
*/
export interface Schema$AccountIssue {
/**
* Further localized details about the issue.
*/
detail?: string | null;
/**
* Link to Merchant Center Help Center providing further information about the issue and how to fix it.
*/
documentationUri?: string | null;
/**
* The impact this issue has on various destinations.
*/
impactedDestinations?: Schema$ImpactedDestination[];
/**
* 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`.
*/
name?: string | null;
/**
* The overall severity of the issue.
*/
severity?: string | null;
/**
* The localized title of the issue.
*/
title?: string | null;
}
/**
* `AccountManagement` payload.
*/
export interface Schema$AccountManagement {
}
/**
* 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).
*/
export interface Schema$AccountRelationship {
/**
* 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.
*/
accountIdAlias?: string | null;
/**
* Identifier. The resource name of the account relationship. Format: `accounts/{account\}/relationships/{relationship\}`. For example, `accounts/123456/relationships/567890`.
*/
name?: string | null;
/**
* 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`).
*/
provider?: string | null;
/**
* Output only. The human-readable display name of the provider account.
*/
providerDisplayName?: string | null;
}
/**
* 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.
*/
export interface Schema$AccountService {
/**
* 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.
*/
accountAggregation?: Schema$AccountAggregation;
/**
* 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.
*/
accountManagement?: Schema$AccountManagement;
/**
* 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.
*/
campaignsManagement?: Schema$CampaignsManagement;
/**
* Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197
*/
comparisonShopping?: Schema$ComparisonShopping;
/**
* 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.
*/
externalAccountId?: string | null;
/**
* Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
*/
handshake?: Schema$Handshake;
/**
* 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.
*/
localListingManagement?: Schema$LocalListingManagement;
/**
* 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.
*/
mutability?: string | null;
/**
* Identifier. The resource name of the account service. Format: `accounts/{account\}/services/{service\}`
*/
name?: string | null;
/**
* 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.
*/
productsManagement?: Schema$ProductsManagement;
/**
* 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`).
*/
provider?: string | null;
/**
* Output only. The human-readable display name of the provider account.
*/
providerDisplayName?: string | null;
/**
* Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant.
*/
ucpCheckoutManagement?: Schema$UcpCheckoutManagement;
}
/**
* Additional instructions to add account services during creation of the account.
*/
export interface Schema$AddAccountService {
/**
* The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation.
*/
accountAggregation?: Schema$AccountAggregation;
/**
* The provider manages this account. Payload for service type Account Management.
*/
accountManagement?: Schema$AccountManagement;
/**
* The provider manages campaigns for this account. Payload for service type campaigns management.
*/
campaignsManagement?: Schema$CampaignsManagement;
/**
* The provider is a CSS (Comparison Shopping Service) of this account. Payload for service type Comparison Shopping.
*/
comparisonShopping?: Schema$ComparisonShopping;
/**
* 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.
*/
externalAccountId?: string | null;
/**
* The provider manages products for this account. Payload for service type products management.
*/
productsManagement?: Schema$ProductsManagement;
/**
* 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`).
*/
provider?: string | null;
}
/**
* Shipping address of the warehouse.
*/
export interface Schema$Address {
/**
* Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
*/
administrativeArea?: string | null;
/**
* Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
*/
city?: string | null;
/**
* Required. Postal code or ZIP (For example "94043").
*/
postalCode?: string | null;
/**
* Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US").
*/
regionCode?: string | null;
/**
* Street-level part of the address. For example: `111w 31st Street`.
*/
streetAddress?: string | null;
}
/**
* Instruction for adding a user to the account during creation.
*/
export interface Schema$AddUser {
/**
* Optional. Details about the user to be added. At the moment, only access rights may be specified.
*/
user?: Schema$User;
/**
* Required. The email address of the user (for example, `john.doe@gmail.com`).
*/
userId?: string | null;
/**
* Optional. Settings related to configuring the verification email that is sent after adding a user.
*/
verificationMailSettings?: Schema$VerificationMailSettings;
}
/**
* Request to approve an account service.
*/
export interface Schema$ApproveAccountServiceRequest {
}
/**
* Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.
*/
export interface Schema$AutofeedSettings {
/**
* Output only. Determines whether the business is eligible for being enrolled into an autofeed.
*/
eligible?: boolean | null;
/**
* Required. Enables or disables product crawling through the autofeed for the given account. Autofeed accounts must meet [certain conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience), 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.
*/
enableProducts?: boolean | null;
/**
* Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`.
*/
name?: string | null;
}
/**
* This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), 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](https://support.google.com/merchants/answer/9242973)
*/
export interface Schema$AutomaticImageImprovements {
/**
* 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.
*/
accountImageImprovementsSettings?: Schema$ImageImprovementsAccountLevelSettings;
/**
* 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.
*/
effectiveAllowAutomaticImageImprovements?: boolean | null;
}
/**
* Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account.
*/
export interface Schema$AutomaticImprovements {
/**
* This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), 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](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided in the update mask.
*/
imageImprovements?: Schema$AutomaticImageImprovements;
/**
* Turning on [item updates](https://support.google.com/merchants/answer/3246284) 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.
*/
itemUpdates?: Schema$AutomaticItemUpdates;
/**
* Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`.
*/
name?: string | null;
/**
* Not available for [advanced accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), 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.
*/
shippingImprovements?: Schema$AutomaticShippingImprovements;
}
/**
* Turning on [item updates](https://support.google.com/merchants/answer/3246284) 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.
*/
export interface Schema$AutomaticItemUpdates {
/**
* 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.
*/
accountItemUpdatesSettings?: Schema$ItemUpdatesAccountLevelSettings;
/**
* 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.
*/
effectiveAllowAvailabilityUpdates?: boolean | null;
/**
* 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.
*/
effectiveAllowConditionUpdates?: boolean | null;
/**
* 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.
*/
effectiveAllowPriceUpdates?: boolean | null;
/**
* 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.
*/
effectiveAllowStrictAvailabilityUpdates?: boolean | null;
}
/**
* Not available for [advanced accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), 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
*/
export interface Schema$AutomaticShippingImprovements {
/**
* Enables automatic shipping improvements.
*/
allowShippingImprovements?: boolean | null;
}
/**
* Request message for the `BatchCreateRegions` method.
*/
export interface Schema$BatchCreateRegionsRequest {
/**
* Required. The region(s) to create. The maximum number of regions that can be created in a batch is 100.
*/
requests?: Schema$CreateRegionRequest[];
}
/**
* Response message for the `BatchCreateRegions` method.
*/
export interface Schema$BatchCreateRegionsResponse {
/**
* The created region(s).
*/
regions?: Schema$Region[];
}
/**
* Request message for the `BatchDeleteRegions` method.
*/
export interface Schema$BatchDeleteRegionsRequest {
/**
* Required. The names of the regions to delete. A maximum of 100 regions can be deleted in a batch.
*/
requests?: Schema$DeleteRegionRequest[];
}
/**
* Request message for the `BatchUpdateRegions` method.
*/
export interface Schema$BatchUpdateRegionsRequest {
/**
* Required. The region(s) to update. The maximum number of regions that can be updated in a batch is 100.
*/
requests?: Schema$UpdateRegionRequest[];
}
/**
* Response message for the `BatchUpdateRegions` method.
*/
export interface Schema$BatchUpdateRegionsResponse {
/**
* The updated region(s).
*/
regions?: Schema$Region[];
}
/**
* Business days of the warehouse.
*/
export interface Schema$BusinessDayConfig {
/**
* Required. Regular business days. May not be empty.
*/
businessDays?: string[] | null;
}
/**
* Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
*/
export interface Schema$BusinessIdentity {
/**
* 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.
*/
blackOwned?: Schema$IdentityAttribute;
/**
* 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.
*/
latinoOwned?: Schema$IdentityAttribute;
/**
* Identifier. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity`
*/
name?: string | null;
/**
* Required. Whether the identity attributes may be used for promotions.
*/
promotionsConsent?: string | null;
/**
* 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.
*/
smallBusiness?: Schema$IdentityAttribute;
/**
* 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.
*/
veteranOwned?: Schema$IdentityAttribute;
/**
* 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.
*/
womenOwned?: Schema$IdentityAttribute;
}
/**
* 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.
*/
export interface Schema$BusinessInfo {
/**
* 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.
*/
address?: Schema$PostalAddress;
/**
* Optional. The customer service of the business.
*/
customerService?: Schema$CustomerService;
/**
* Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX.
*/
koreanBusinessRegistrationNumber?: string | null;
/**
* Identifier. The resource name of the business info. Format: `accounts/{account\}/businessInfo`
*/
name?: string | null;
/**
* Output only. The phone number of the business.
*/
phone?: Schema$PhoneNumber;
/**
* Output only. The phone verification state of the business.
*/
phoneVerificationState?: string | null;
}
/**
* `CampaignManagement` payload.
*/
export interface Schema$CampaignsManagement {
}
/**
* 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.
*/
export interface Schema$CarrierRate {
/**
* Required. Carrier service, such as `"UPS"` or `"Fedex"`.
*/
carrier?: string | null;
/**
* Required. Carrier service, such as `"ground"` or `"2 days"`.
*/
carrierService?: string | null;
/**
* 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.
*/
flatAdjustment?: Schema$Price;
/**
* Required. Name of the carrier rate. Must be unique per rate group.
*/
name?: string | null;
/**
* Required. Shipping origin for this carrier rate.
*/
originPostalCode?: string | null;
/**
* 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%.
*/
percentageAdjustment?: string | null;
}
/**
* [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant.
*/
export interface Schema$CheckoutSettings {
/**
* 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).
*/
effectiveEnrollmentState?: string | null;
/**
* 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).
*/
effectiveReviewState?: string | null;
/**
* 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).
*/
effectiveUriSettings?: Schema$UriSettings;
/**
* Optional. Required for the create operation. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies. Valid destination values are `SHOPPING_ADS` and `FREE_LISTINGS`.
*/
eligibleDestinations?: string[] | null;
/**
* Output only. Reflects the merchant enrollment state in `Checkout` program.
*/
enrollmentState?: string | null;
/**
* Identifier. The resource name of the program configuration settings. Format: `accounts/{account\}/programs/{program\}/checkoutSettings`
*/
name?: string | null;
/**
* 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.
*/
reviewState?: string | null;
/**
* URI settings for cart or checkout URL.
*/
uriSettings?: Schema$UriSettings;
}
/**
* Request message for the `ClaimHomepage` method.
*/
export interface Schema$ClaimHomepageRequest {
/**
* 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.
*/
overwrite?: boolean | null;
}
/**
* `ComparisonShopping` payload.
*/
export interface Schema$ComparisonShopping {
}
/**
* Request message for the `CreateAndConfigureAccount` method.
*/
export interface Schema$CreateAndConfigureAccountRequest {
/**
* Required. The account to be created.
*/
account?: Schema$Account;
/**
* 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 `products_management` services may be provided.
*/
service?: Schema$AddAccountService[];
/**
* 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.
*/
setAlias?: Schema$SetAliasForRelationship[];
/**
* Optional. Users to be added to the account.
*/
user?: Schema$AddUser[];
}
/**
* Request message for the `CreateRegion` method.
*/
export interface Schema$CreateRegionRequest {
/**
* Required. The account to create a region for. Format: `accounts/{account\}`
*/
parent?: string | null;
/**
* Required. The region to create.
*/
region?: Schema$Region;
/**
* Required. The identifier for the region, unique over all regions of the same account.
*/
regionId?: string | null;
}
/**
* Customer service information.
*/
export interface Schema$CustomerService {
/**
* Optional. The email address where customer service may be reached.
*/
email?: string | null;
/**
* Optional. The phone number where customer service may be called.
*/
phone?: Schema$PhoneNumber;
/**
* Optional. The URI where customer service may be found.
*/
uri?: string | null;
}
/**
* Configs related to local delivery ends for the day.
*/
export interface Schema$CutoffConfig {
/**
* Time that local delivery ends for the day.
*/
localCutoffTime?: Schema$LocalCutoffTime;
/**
* 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.
*/
noDeliveryPostCutoff?: boolean | null;
/**
* Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`.
*/
storeCloseOffsetHours?: string | null;
}
/**
* Business days cutoff time definition.
*/
export interface Schema$CutoffTime {
/**
* Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
*/
hour?: number | null;
/**
* Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
*/
minute?: number | null;
/**
* Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich".
*/
timeZone?: string | null;
}
/**
* 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
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* Request message for the `DeleteRegion` method.
*/
export interface Schema$DeleteRegionRequest {
/**
* Required. The name of the region to delete. Format: `accounts/{account\}/regions/{region\}`
*/
name?: string | null;
}
/**
* Time spent in various aspects from order to the delivery of the product.
*/
export interface Schema$DeliveryTime {
/**
* Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
*/
cutoffTime?: Schema$CutoffTime;
/**
* The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
*/
handlingBusinessDayConfig?: Schema$BusinessDayConfig;
/**
* 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.
*/
maxHandlingDays?: number | null;
/**
* 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`.
*/
maxTransitDays?: number | null;
/**
* 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.
*/
minHandlingDays?: number | null;
/**
* 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.
*/
minTransitDays?: number | null;
/**
* The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
*/
transitBusinessDayConfig?: Schema$BusinessDayConfig;
/**
* 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.
*/
transitTimeTable?: Schema$TransitTable;
/**
* 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 should be set.
*/
warehouseBasedDeliveryTimes?: Schema$WarehouseBasedDeliveryTime[];
}
/**
* Represents a developer registration owned by a Merchant account.
*/
export interface Schema$DeveloperRegistration {
/**
* Output only. The GCP ids attached to this developer registration
*/
gcpIds?: string[] | null;
/**
* Identifier. The `name` (ID) of the developer registration. Generated upon creation of a new `DeveloperRegistration`. The `account` represents the merchant ID of the merchant that owns the registration.
*/
name?: string | null;
}
/**
* Request message for the DisableProgram method.
*/
export interface Schema$DisableProgramRequest {
}
/**
* Maximum delivery radius. This is only required for the local delivery shipment type.
*/
export interface Schema$Distance {
/**
* Unit can differ based on country, it is parameterized to include miles and kilometers.
*/
unit?: string | null;
/**
* Integer value of distance.
*/
value?: string | null;
}
/**
* 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.
*/
export interface Schema$EmailPreferences {
/**
* Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
*/
name?: string | null;
/**
* Optional. Updates on new features, tips and best practices.
*/
newsAndTips?: string | null;
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* Request message for the EnableProgram method.
*/
export interface Schema$EnableProgramRequest {
}
/**
* Response message for the FindLfpProviders method.
*/
export interface Schema$FindLfpProvidersResponse {
/**
* The LFP providers from the specified merchant in the specified country.
*/
lfpProviders?: Schema$LfpProvider[];
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
}
/**
* Collection of information related to a Google Business Profile (GBP) account.
*/
export interface Schema$GbpAccount {
/**
* The id of the GBP account.
*/
gbpAccountId?: string | null;
/**
* The name of the Business Profile. For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account.
*/
gbpAccountName?: string | null;
/**
* Number of listings under this account.
*/
listingCount?: string | null;
/**
* Identifier. The resource name of the GBP account. Format: `accounts/{account\}/gbpAccount/{gbp_account\}`
*/
name?: string | null;
/**
* The type of the Business Profile.
*/
type?: string | null;
}
/**
* A list of geotargets that defines the region area.
*/
export interface Schema$GeoTargetArea {
/**
* Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state).
*/
geotargetCriteriaIds?: string[] | null;
}
/**
* Response message for the GetAccountForGcpRegistration method.
*/
export interface Schema$GetAccountForGcpRegistrationResponse {
/**
* The name of the merchant account id that the GCP is registered with.
*/
name?: string | null;
}
/**
* The current status of establishing of the service. (for example, pending approval, approved, established).
*/
export interface Schema$Handshake {
/**
* Output only. The most recent account to modify the account service's `approval_status`.
*/
actor?: string | null;
/**
* Output only. The approval state of this handshake.
*/
approvalState?: string | null;
}
/**
* 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.
*/
export interface Schema$Headers {
/**
* Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
*/
locations?: Schema$LocationIdSet[];
/**
* 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.
*/
numberOfItems?: string[] | null;
/**
* 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.
*/
postalCodeGroupNames?: string[] | null;
/**
* 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.
*/
prices?: Schema$Price[];
/**
* Required. A list of inclusive order we