googleapis
Version:
Google APIs Client Library for Node.js
1,005 lines • 843 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 content_v2_1 {
export interface Options extends GlobalOptions {
version: 'v2.1';
}
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;
}
/**
* Content API for Shopping
*
* This API is deprecated. Please use Merchant API instead: https://developers.google.com/merchant/api.
*
* @example
* ```js
* const {google} = require('googleapis');
* const content = google.content('v2.1');
* ```
*/
export class Content {
context: APIRequestContext;
accounts: Resource$Accounts;
accountstatuses: Resource$Accountstatuses;
accounttax: Resource$Accounttax;
collections: Resource$Collections;
collectionstatuses: Resource$Collectionstatuses;
conversionsources: Resource$Conversionsources;
csses: Resource$Csses;
datafeeds: Resource$Datafeeds;
datafeedstatuses: Resource$Datafeedstatuses;
freelistingsprogram: Resource$Freelistingsprogram;
liasettings: Resource$Liasettings;
localinventory: Resource$Localinventory;
merchantsupport: Resource$Merchantsupport;
ordertrackingsignals: Resource$Ordertrackingsignals;
pos: Resource$Pos;
productdeliverytime: Resource$Productdeliverytime;
products: Resource$Products;
productstatuses: Resource$Productstatuses;
promotions: Resource$Promotions;
pubsubnotificationsettings: Resource$Pubsubnotificationsettings;
quotas: Resource$Quotas;
recommendations: Resource$Recommendations;
regionalinventory: Resource$Regionalinventory;
regions: Resource$Regions;
reports: Resource$Reports;
returnpolicyonline: Resource$Returnpolicyonline;
shippingsettings: Resource$Shippingsettings;
shoppingadsprogram: Resource$Shoppingadsprogram;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
*/
export interface Schema$Account {
/**
* Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
*/
accountManagement?: string | null;
/**
* Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
*/
adsLinks?: Schema$AccountAdsLink[];
/**
* Indicates whether the merchant sells adult content.
*/
adultContent?: boolean | null;
/**
* The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
*/
automaticImprovements?: Schema$AccountAutomaticImprovements;
/**
* Automatically created label IDs that are assigned to the account by CSS Center.
*/
automaticLabelIds?: string[] | null;
/**
* The business identity attributes can be used to self-declare attributes that let customers know more about your business.
*/
businessIdentity?: Schema$AccountBusinessIdentity;
/**
* The business information of the account.
*/
businessInformation?: Schema$AccountBusinessInformation;
/**
* Settings for conversion tracking.
*/
conversionSettings?: Schema$AccountConversionSettings;
/**
* ID of CSS the account belongs to.
*/
cssId?: string | null;
/**
* The Business Profile which is linked or in the process of being linked with the Merchant Center account.
*/
googleMyBusinessLink?: Schema$AccountGoogleMyBusinessLink;
/**
* Required. 64-bit Merchant Center account ID.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#account`".
*/
kind?: string | null;
/**
* Manually created label IDs that are assigned to the account by CSS.
*/
labelIds?: string[] | null;
/**
* Required. Display name for the account.
*/
name?: string | null;
/**
* Client-specific, locally-unique, internal ID for the child account.
*/
sellerId?: string | null;
/**
* Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
*/
users?: Schema$AccountUser[];
/**
* The merchant's website.
*/
websiteUrl?: string | null;
/**
* Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
*/
youtubeChannelLinks?: Schema$AccountYouTubeChannelLink[];
}
export interface Schema$AccountAddress {
/**
* CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
*/
country?: string | null;
/**
* City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
*/
locality?: string | null;
/**
* Postal code or ZIP (for example, "94043").
*/
postalCode?: string | null;
/**
* Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
*/
region?: string | null;
/**
* Street-level part of the address. Use `\n` to add a second line.
*/
streetAddress?: string | null;
}
export interface Schema$AccountAdsLink {
/**
* Customer ID of the Ads account.
*/
adsId?: string | null;
/**
* Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
*/
status?: string | null;
}
/**
* The automatic improvements of the account can be used to automatically update items, improve images and shipping.
*/
export interface Schema$AccountAutomaticImprovements {
/**
* 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.
*/
imageImprovements?: Schema$AccountImageImprovements;
/**
* 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.
*/
itemUpdates?: Schema$AccountItemUpdates;
/**
* Not available for MCAs [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.
*/
shippingImprovements?: Schema$AccountShippingImprovements;
}
/**
* The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business.
*/
export interface Schema$AccountBusinessIdentity {
/**
* Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
*/
blackOwned?: Schema$AccountIdentityType;
/**
* Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
*/
includeForPromotions?: boolean | null;
/**
* Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
*/
latinoOwned?: Schema$AccountIdentityType;
/**
* Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
*/
smallBusiness?: Schema$AccountIdentityType;
/**
* Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
*/
veteranOwned?: Schema$AccountIdentityType;
/**
* Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
*/
womenOwned?: Schema$AccountIdentityType;
}
export interface Schema$AccountBusinessInformation {
/**
* The address of the business. Use `\n` to add a second address line.
*/
address?: Schema$AccountAddress;
/**
* The customer service information of the business.
*/
customerService?: Schema$AccountCustomerService;
/**
* The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
*/
koreanBusinessRegistrationNumber?: string | null;
/**
* The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
*/
phoneNumber?: string | null;
/**
* Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
*/
phoneVerificationStatus?: string | null;
}
/**
* Settings for conversion tracking.
*/
export interface Schema$AccountConversionSettings {
/**
* When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
*/
freeListingsAutoTaggingEnabled?: boolean | null;
}
/**
* Credentials allowing Google to call a partner's API on behalf of a merchant.
*/
export interface Schema$AccountCredentials {
/**
* An OAuth access token.
*/
accessToken?: string | null;
/**
* The amount of time, in seconds, after which the access token is no longer valid.
*/
expiresIn?: string | null;
/**
* Indicates to Google how Google should use these OAuth tokens.
*/
purpose?: string | null;
}
export interface Schema$AccountCustomerService {
/**
* Customer service email.
*/
email?: string | null;
/**
* Customer service phone number.
*/
phoneNumber?: string | null;
/**
* Customer service URL.
*/
url?: string | null;
}
export interface Schema$AccountGoogleMyBusinessLink {
/**
* The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
*/
gmbAccountId?: string | null;
/**
* The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
*/
gmbEmail?: string | null;
/**
* Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
*/
status?: string | null;
}
export interface Schema$AccountIdentifier {
/**
* The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
*/
aggregatorId?: string | null;
/**
* The merchant account ID, set for individual accounts and subaccounts.
*/
merchantId?: string | null;
}
/**
* The account identity type used to specify attributes.
*/
export interface Schema$AccountIdentityType {
/**
* Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
*/
selfIdentified?: boolean | 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$AccountImageImprovements {
/**
* Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
*/
accountImageImprovementsSettings?: Schema$AccountImageImprovementsSettings;
/**
* 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;
}
/**
* Settings for the Automatic Image Improvements.
*/
export interface Schema$AccountImageImprovementsSettings {
/**
* Enables automatic image improvements.
*/
allowAutomaticImageImprovements?: boolean | null;
}
/**
* An issue affecting specific merchant.
*/
export interface Schema$AccountIssue {
/**
* A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when merchant disagrees with the issue. Actions that are supported in (your) third-party application can be rendered as buttons and should be available to merchant when they expand the issue.
*/
actions?: Schema$Action[];
/**
* Clarifies the severity of the issue. The summarizing message, if present, should be shown right under the title for each issue. It helps merchants to quickly understand the impact of the issue. The detailed breakdown helps the merchant to fully understand the impact of the issue. It can be rendered as dialog that opens when the merchant mouse over the summarized impact statement. Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between `ERROR`, `WARNING` and `INFO`.
*/
impact?: Schema$AccountIssueImpact;
/**
* Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.
*/
prerenderedContent?: string | null;
/**
* Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.
*/
prerenderedOutOfCourtDisputeSettlement?: string | null;
/**
* Title of the issue.
*/
title?: string | null;
}
/**
* Overall impact of the issue.
*/
export interface Schema$AccountIssueImpact {
/**
* Detailed impact breakdown. Explains the types of restriction the issue has in different shopping destinations and territory. If present, it should be rendered to the merchant. Can be shown as a mouse over dropdown or a dialog. Each breakdown item represents a group of regions with the same impact details.
*/
breakdowns?: Schema$Breakdown[];
/**
* Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the merchant. For example: "Disapproves 90k offers in 25 countries"
*/
message?: string | null;
/**
* The severity of the issue.
*/
severity?: string | null;
}
/**
* 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$AccountItemUpdates {
/**
* Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
*/
accountItemUpdatesSettings?: Schema$AccountItemUpdatesSettings;
/**
* 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. 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. 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. 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. Read-only.
*/
effectiveAllowStrictAvailabilityUpdates?: boolean | null;
}
/**
* Settings for the Automatic Item Updates.
*/
export interface Schema$AccountItemUpdatesSettings {
/**
* 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_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
*/
allowAvailabilityUpdates?: boolean | null;
/**
* If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
*/
allowConditionUpdates?: boolean | null;
/**
* If price updates are enabled, Google always updates the active price with the crawled information.
*/
allowPriceUpdates?: boolean | null;
/**
* If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
*/
allowStrictAvailabilityUpdates?: boolean | null;
}
/**
* Label assigned by CSS domain or CSS group to one of its sub-accounts.
*/
export interface Schema$AccountLabel {
/**
* Immutable. The ID of account this label belongs to.
*/
accountId?: string | null;
/**
* The description of this label.
*/
description?: string | null;
/**
* Output only. The ID of the label.
*/
labelId?: string | null;
/**
* Output only. The type of this label.
*/
labelType?: string | null;
/**
* The display name of this label.
*/
name?: string | null;
}
/**
* The return carrier information. This service is designed for merchants enrolled in the Buy on Google program.
*/
export interface Schema$AccountReturnCarrier {
/**
* Output only. Immutable. The Google-provided unique carrier ID, used to update the resource.
*/
carrierAccountId?: string | null;
/**
* Name of the carrier account.
*/
carrierAccountName?: string | null;
/**
* Number of the carrier account.
*/
carrierAccountNumber?: string | null;
/**
* The carrier code enum. Accepts the values FEDEX or UPS.
*/
carrierCode?: string | null;
}
export interface Schema$AccountsAuthInfoResponse {
/**
* The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
*/
accountIdentifiers?: Schema$AccountIdentifier[];
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsAuthInfoResponse`".
*/
kind?: string | null;
}
export interface Schema$AccountsClaimWebsiteResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsClaimWebsiteResponse`".
*/
kind?: string | null;
}
export interface Schema$AccountsCustomBatchRequest {
/**
* The request entries to be processed in the batch.
*/
entries?: Schema$AccountsCustomBatchRequestEntry[];
}
/**
* A batch entry encoding a single non-batch accounts request.
*/
export interface Schema$AccountsCustomBatchRequestEntry {
/**
* The account to create or update. Only defined if the method is `insert` or `update`.
*/
account?: Schema$Account;
/**
* The ID of the targeted account. Only defined if the method is not `insert`.
*/
accountId?: string | null;
/**
* An entry ID, unique within the batch request.
*/
batchId?: number | null;
/**
* Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.
*/
force?: boolean | null;
/**
* Label IDs for the 'updatelabels' request.
*/
labelIds?: string[] | null;
/**
* Details about the `link` request.
*/
linkRequest?: Schema$AccountsCustomBatchRequestEntryLinkRequest;
/**
* The ID of the managing account.
*/
merchantId?: string | null;
/**
* The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "`delete`" - "`get`" - "`insert`" - "`link`" - "`update`"
*/
method?: string | null;
/**
* Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.
*/
overwrite?: boolean | null;
/**
* Controls which fields are visible. Only applicable if the method is 'get'.
*/
view?: string | null;
}
export interface Schema$AccountsCustomBatchRequestEntryLinkRequest {
/**
* Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
*/
action?: string | null;
/**
* The ID of the linked account.
*/
linkedAccountId?: string | null;
/**
* Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`" - "`localProductManager`"
*/
linkType?: string | null;
/**
* Provided services. Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`" - "`localProductManagement`"
*/
services?: string[] | null;
}
export interface Schema$AccountsCustomBatchResponse {
/**
* The result of the execution of the batch requests.
*/
entries?: Schema$AccountsCustomBatchResponseEntry[];
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponse`".
*/
kind?: string | null;
}
/**
* A batch entry encoding a single non-batch accounts response.
*/
export interface Schema$AccountsCustomBatchResponseEntry {
/**
* The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`.
*/
account?: Schema$Account;
/**
* The ID of the request entry this entry responds to.
*/
batchId?: number | null;
/**
* A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request.
*/
errors?: Schema$Errors;
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`"
*/
kind?: string | null;
}
/**
* Not available for MCAs [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$AccountShippingImprovements {
/**
* Enables automatic shipping improvements.
*/
allowShippingImprovements?: boolean | null;
}
export interface Schema$AccountsLinkRequest {
/**
* Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
*/
action?: string | null;
/**
* Additional information required for `eCommercePlatform` link type.
*/
eCommercePlatformLinkInfo?: Schema$ECommercePlatformLinkInfo;
/**
* The ID of the linked account.
*/
linkedAccountId?: string | null;
/**
* Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`"
*/
linkType?: string | null;
/**
* Additional information required for `paymentServiceProvider` link type.
*/
paymentServiceProviderLinkInfo?: Schema$PaymentServiceProviderLinkInfo;
/**
* Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`"
*/
services?: string[] | null;
}
export interface Schema$AccountsLinkResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsLinkResponse`".
*/
kind?: string | null;
}
export interface Schema$AccountsListLinksResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsListLinksResponse`".
*/
kind?: string | null;
/**
* The list of available links.
*/
links?: Schema$LinkedAccount[];
/**
* The token for the retrieval of the next page of links.
*/
nextPageToken?: string | null;
}
export interface Schema$AccountsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsListResponse`".
*/
kind?: string | null;
/**
* The token for the retrieval of the next page of accounts.
*/
nextPageToken?: string | null;
resources?: Schema$Account[];
}
/**
* The status of an account, that is, information about its products, which is computed offline and not returned immediately at insertion time.
*/
export interface Schema$AccountStatus {
/**
* The ID of the account for which the status is reported.
*/
accountId?: string | null;
/**
* A list of account level issues.
*/
accountLevelIssues?: Schema$AccountStatusAccountLevelIssue[];
/**
* How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
*/
accountManagement?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`"
*/
kind?: string | null;
/**
* List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
*/
products?: Schema$AccountStatusProducts[];
/**
* Whether the account's website is claimed or not.
*/
websiteClaimed?: boolean | null;
}
export interface Schema$AccountStatusAccountLevelIssue {
/**
* Country for which this issue is reported.
*/
country?: string | null;
/**
* The destination the issue applies to. If this field is empty then the issue applies to all available destinations.
*/
destination?: string | null;
/**
* Additional details about the issue.
*/
detail?: string | null;
/**
* The URL of a web page to help resolving this issue.
*/
documentation?: string | null;
/**
* Issue identifier.
*/
id?: string | null;
/**
* Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "`suggestion`"
*/
severity?: string | null;
/**
* Short description of the issue.
*/
title?: string | null;
}
export interface Schema$AccountstatusesCustomBatchRequest {
/**
* The request entries to be processed in the batch.
*/
entries?: Schema$AccountstatusesCustomBatchRequestEntry[];
}
/**
* A batch entry encoding a single non-batch accountstatuses request.
*/
export interface Schema$AccountstatusesCustomBatchRequestEntry {
/**
* The ID of the (sub-)account whose status to get.
*/
accountId?: string | null;
/**
* An entry ID, unique within the batch request.
*/
batchId?: number | null;
/**
* If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
*/
destinations?: string[] | null;
/**
* The ID of the managing account.
*/
merchantId?: string | null;
/**
* The method of the batch entry. Acceptable values are: - "`get`"
*/
method?: string | null;
}
export interface Schema$AccountstatusesCustomBatchResponse {
/**
* The result of the execution of the batch requests.
*/
entries?: Schema$AccountstatusesCustomBatchResponseEntry[];
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountstatusesCustomBatchResponse`".
*/
kind?: string | null;
}
/**
* A batch entry encoding a single non-batch accountstatuses response.
*/
export interface Schema$AccountstatusesCustomBatchResponseEntry {
/**
* The requested account status. Defined if and only if the request was successful.
*/
accountStatus?: Schema$AccountStatus;
/**
* The ID of the request entry this entry responds to.
*/
batchId?: number | null;
/**
* A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request.
*/
errors?: Schema$Errors;
}
export interface Schema$AccountstatusesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountstatusesListResponse`".
*/
kind?: string | null;
/**
* The token for the retrieval of the next page of account statuses.
*/
nextPageToken?: string | null;
resources?: Schema$AccountStatus[];
}
export interface Schema$AccountStatusItemLevelIssue {
/**
* The attribute's name, if the issue is caused by a single attribute.
*/
attributeName?: string | null;
/**
* The error code of the issue.
*/
code?: string | null;
/**
* A short issue description in English.
*/
description?: string | null;
/**
* A detailed issue description in English.
*/
detail?: string | null;
/**
* The URL of a web page to help with resolving this issue.
*/
documentation?: string | null;
/**
* Number of items with this issue.
*/
numItems?: string | null;
/**
* Whether the issue can be resolved by the merchant.
*/
resolution?: string | null;
/**
* How this issue affects serving of the offer.
*/
servability?: string | null;
}
export interface Schema$AccountStatusProducts {
/**
* The channel the data applies to. Acceptable values are: - "`local`" - "`online`"
*/
channel?: string | null;
/**
* The country the data applies to.
*/
country?: string | null;
/**
* The destination the data applies to.
*/
destination?: string | null;
/**
* List of item-level issues.
*/
itemLevelIssues?: Schema$AccountStatusItemLevelIssue[];
/**
* Aggregated product statistics.
*/
statistics?: Schema$AccountStatusStatistics;
}
export interface Schema$AccountStatusStatistics {
/**
* Number of active offers.
*/
active?: string | null;
/**
* Number of disapproved offers.
*/
disapproved?: string | null;
/**
* Number of expiring offers.
*/
expiring?: string | null;
/**
* Number of pending offers.
*/
pending?: string | null;
}
export interface Schema$AccountsUpdateLabelsRequest {
/**
* The IDs of labels that should be assigned to the account.
*/
labelIds?: string[] | null;
}
export interface Schema$AccountsUpdateLabelsResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsUpdateLabelsResponse`".
*/
kind?: string | null;
}
/**
* The tax settings of a merchant account. All methods require the admin role.
*/
export interface Schema$AccountTax {
/**
* Required. The ID of the account to which these account tax settings belong.
*/
accountId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountTax`".
*/
kind?: string | null;
/**
* Tax rules. Updating the tax rules will enable "US" taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
*/
rules?: Schema$AccountTaxTaxRule[];
}
export interface Schema$AccounttaxCustomBatchRequest {
/**
* The request entries to be processed in the batch.
*/
entries?: Schema$AccounttaxCustomBatchRequestEntry[];
}
/**
* A batch entry encoding a single non-batch accounttax request.
*/
export interface Schema$AccounttaxCustomBatchRequestEntry {
/**
* The ID of the account for which to get/update account tax settings.
*/
accountId?: string | null;
/**
* The account tax settings to update. Only defined if the method is `update`.
*/
accountTax?: Schema$AccountTax;
/**
* An entry ID, unique within the batch request.
*/
batchId?: number | null;
/**
* The ID of the managing account.
*/
merchantId?: string | null;
/**
* The method of the batch entry. Acceptable values are: - "`get`" - "`update`"
*/
method?: string | null;
}
export interface Schema$AccounttaxCustomBatchResponse {
/**
* The result of the execution of the batch requests.
*/
entries?: Schema$AccounttaxCustomBatchResponseEntry[];
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accounttaxCustomBatchResponse`".
*/
kind?: string | null;
}
/**
* A batch entry encoding a single non-batch accounttax response.
*/
export interface Schema$AccounttaxCustomBatchResponseEntry {
/**
* The retrieved or updated account tax settings.
*/
accountTax?: Schema$AccountTax;
/**
* The ID of the request entry this entry responds to.
*/
batchId?: number | null;
/**
* A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request.
*/
errors?: Schema$Errors;
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accounttaxCustomBatchResponseEntry`"
*/
kind?: string | null;
}
export interface Schema$AccounttaxListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accounttaxListResponse`".
*/
kind?: string | null;
/**
* The token for the retrieval of the next page of account tax settings.
*/
nextPageToken?: string | null;
resources?: Schema$AccountTax[];
}
/**
* Tax calculation rule to apply in a state or province (US only).
*/
export interface Schema$AccountTaxTaxRule {
/**
* Country code in which tax is applicable.
*/
country?: string | null;
/**
* Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
*/
locationId?: string | null;
/**
* Explicit tax rate in percent, represented as a floating point number without