googleapis
Version:
Google APIs Client Library for Node.js
1,316 lines • 865 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, 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
*
* Manage your product listings and accounts for Google Shopping
*
* @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;
buyongoogleprograms: Resource$Buyongoogleprograms;
collections: Resource$Collections;
collectionstatuses: Resource$Collectionstatuses;
csses: Resource$Csses;
datafeeds: Resource$Datafeeds;
datafeedstatuses: Resource$Datafeedstatuses;
liasettings: Resource$Liasettings;
localinventory: Resource$Localinventory;
orderinvoices: Resource$Orderinvoices;
orderreports: Resource$Orderreports;
orderreturns: Resource$Orderreturns;
orders: Resource$Orders;
ordertrackingsignals: Resource$Ordertrackingsignals;
pos: Resource$Pos;
products: Resource$Products;
productstatuses: Resource$Productstatuses;
pubsubnotificationsettings: Resource$Pubsubnotificationsettings;
regionalinventory: Resource$Regionalinventory;
regions: Resource$Regions;
reports: Resource$Reports;
repricingrules: Resource$Repricingrules;
returnaddress: Resource$Returnaddress;
returnpolicy: Resource$Returnpolicy;
returnpolicyonline: Resource$Returnpolicyonline;
settlementreports: Resource$Settlementreports;
settlementtransactions: Resource$Settlementtransactions;
shippingsettings: Resource$Shippingsettings;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.
*/
export interface Schema$Account {
/**
* 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 AdWords 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;
/**
* Automatically created label IDs that are assigned to the account by CSS Center.
*/
automaticLabelIds?: string[] | null;
/**
* The business information of the account.
*/
businessInformation?: Schema$AccountBusinessInformation;
/**
* ID of CSS the account belongs to.
*/
cssId?: string | null;
/**
* The GMB account which is linked or in the process of being linked with the Merchant Center account.
*/
googleMyBusinessLink?: Schema$AccountGoogleMyBusinessLink;
/**
* Required for update. 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 (e.g. "US"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
*/
country?: string | null;
/**
* City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
*/
locality?: string | null;
/**
* Postal code or ZIP (e.g. "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.
*/
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;
}
export interface Schema$AccountBusinessInformation {
/**
* The address of the business.
*/
address?: Schema$AccountAddress;
/**
* The customer service information of the business.
*/
customerService?: Schema$AccountCustomerService;
/**
* The phone number of the business.
*/
phoneNumber?: string | 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 GMB account. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the GMB API.
*/
gmbAccountId?: string | null;
/**
* The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
*/
gmbEmail?: string | null;
/**
* Status of the link between this Merchant Center account and the GMB account. 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;
}
/**
* 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`"
*/
linkType?: string | null;
/**
* Provided services. Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`"
*/
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 defined if and only if the request failed.
*/
errors?: Schema$Errors;
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`"
*/
kind?: string | 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;
/**
* The ID of the linked account.
*/
linkedAccountId?: string | null;
/**
* Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`"
*/
linkType?: string | null;
/**
* Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingAdsOther`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`shoppingActionsOther`"
*/
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, i.e., 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[];
/**
* 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 defined if and only if the request failed.
*/
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 defined if and only if the request failed.
*/
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 (USA 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 the percentage character. Must not be negative.
*/
ratePercent?: string | null;
/**
* If true, shipping charges are also taxed.
*/
shippingTaxed?: boolean | null;
/**
* Whether the tax rate is taken from a global tax table or specified explicitly.
*/
useGlobalRate?: boolean | null;
}
export interface Schema$AccountUser {
/**
* Whether user is an admin.
*/
admin?: boolean | null;
/**
* User's email address.
*/
emailAddress?: string | null;
/**
* Whether user is an order manager.
*/
orderManager?: boolean | null;
/**
* Whether user can access payment statements.
*/
paymentsAnalyst?: boolean | null;
/**
* Whether user can manage payment settings.
*/
paymentsManager?: boolean | null;
}
export interface Schema$AccountYouTubeChannelLink {
/**
* Channel ID.
*/
channelId?: string | null;
/**
* Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio 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.
*/
status?: string | null;
}
export interface Schema$Amount {
/**
* [required] The pre-tax or post-tax price depending on the location of the order.
*/
priceAmount?: Schema$Price;
/**
* [required] Tax value.
*/
taxAmount?: Schema$Price;
}
export interface Schema$BusinessDayConfig {
/**
* Regular business days. May not be empty.
*/
businessDays?: string[] | null;
}
/**
* Response message for the GetProgramStatus method.
*/
export interface Schema$BuyOnGoogleProgramStatus {
/**
* The customer service pending email.
*/
customerServicePendingEmail?: string | null;
/**
* The customer service verified email.
*/
customerServiceVerifiedEmail?: string | null;
/**
* The current participation stage for the program.
*/
participationStage?: string | null;
}
export interface Schema$CarrierRate {
/**
* Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.
*/
carrierName?: string | null;
/**
* Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.
*/
carrierService?: string | null;
/**
* Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" \}` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" \}` removes $3 from the rate. Optional.
*/
flatAdjustment?: Schema$Price;
/**
* Name of the carrier rate. Must be unique per rate group. Required.
*/
name?: string | null;
/**
* Shipping origin for this carrier rate. Required.
*/
originPostalCode?: string | null;
/**
* 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%. Optional.
*/
percentageAdjustment?: string | null;
}
export interface Schema$CarriersCarrier {
/**
* The CLDR country code of the carrier (e.g., "US"). Always present.
*/
country?: string | null;
/**
* The name of the carrier (e.g., `"UPS"`). Always present.
*/
name?: string | null;
/**
* A list of supported services (e.g., `"ground"`) for that carrier. Contains at least one service.
*/
services?: string[] | null;
}
/**
* The collection message.
*/
export interface Schema$Collection {
/**
* Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)
*/
customLabel0?: string | null;
/**
* Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
*/
customLabel1?: string | null;
/**
* Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
*/
customLabel2?: string | null;
/**
* Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
*/
customLabel3?: string | null;
/**
* Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
*/
customLabel4?: string | null;
/**
* This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)
*/
featuredProduct?: Schema$CollectionFeaturedProduct[];
/**
* Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)
*/
headline?: string[] | null;
/**
* Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)
*/
id?: string | null;
/**
* The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)
*/
imageLink?: string[] | null;
/**
* The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)
*/
language?: string | null;
/**
* A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)
*/
link?: string | null;
/**
* A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)
*/
mobileLink?: string | null;
/**
* [product_country attribute](https://support.google.com/merchants/answer/9674155)
*/
productCountry?: string | null;
}
/**
* The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)
*/
export interface Schema$CollectionFeaturedProduct {
/**
* The unique identifier for the product item.
*/
offerId?: string | null;
/**
* Required. X-coordinate of the product callout on the Shoppable Image.
*/
x?: number | null;
/**
* Required. Y-coordinate of the product callout on the Shoppable Image.
*/
y?: number | null;
}
/**
* The collectionstatus message.
*/
export interface Schema$CollectionStatus {
/**
* A list of all issues associated with the collection.
*/
collectionLevelIssuses?: Schema$CollectionStatusItemLevelIssue[];
/**
* Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
*/
creationDate?: string | null;
/**
* The intended destinations for the collection.
*/
destinationStatuses?: Schema$CollectionStatusDestinationStatus[];
/**
* Required. The ID of the collection for which status is reported.
*/
id?: string | null;
/**
* Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
*/
lastUpdateDate?: string | null;
}
/**
* Destination status message.
*/
export interface Schema$CollectionStatusDestinationStatus {
/**
* The name of the destination
*/
destination?: string | null;
/**
* The status for the specified destination.
*/
status?: string | null;
}
/**
* Issue associated with the collection.
*/
export interface Schema$CollectionStatusItemLevelIssue {
/**
* 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;
/**
* The destination the issue applies to.
*/
destination?: 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;
/**
* Whether the issue can be resolved by the merchant.
*/
resolution?: string | null;
/**
* How this issue affects the serving of the collection.
*/
servability?: string | null;
}
/**
* Information about CSS domain.
*/
export interface Schema$Css {
/**
* Output only. Immutable. The CSS domain ID.
*/
cssDomainId?: string | null;
/**
* Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.
*/
cssGroupId?: string | null;
/**
* Output only. Immutable. The CSS domain's display name, used when space is constrained.
*/
displayName?: string | null;
/**
* Output only. Immutable. The CSS domain's full name.
*/
fullName?: string | null;
/**
* Output only. Immutable. The CSS domain's homepage.
*/
homepageUri?: string | null;
/**
* A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.
*/
labelIds?: string[] | null;
}
export interface Schema$CustomAttribute {
/**
* Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
*/
groupValues?: Schema$CustomAttribute[];
/**
* The name of the attribute. Underscores will be replaced by spaces upon insertion.
*/
name?: string | null;
/**
* The value of the attribute.
*/
value?: string | null;
}
export interface Schema$CustomerReturnReason {
/**
* Description of the reason.
*/
description?: string | null;
/**
* Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "`changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "`doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`undeliverable`"
*/
reasonCode?: string | null;
}
export interface Schema$CutoffTime {
/**
* Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
*/
hour?: number | null;
/**
* Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
*/
minute?: number | null;
/**
* Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
*/
timezone?: string | null;
}
/**
* Datafeed configuration data.
*/
export interface Schema$Datafeed {
/**
* The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
*/
attributeLanguage?: string | null;
/**
* Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
*/
contentType?: string | null;
/**
* Fetch schedule for the feed file.
*/
fetchSchedule?: Schema$DatafeedFetchSchedule;
/**
* Required. The filename of the feed. All feeds must have a unique file name.
*/
fileName?: string | null;
/**
* Format of the feed file.
*/
format?: Schema$DatafeedFormat;
/**
* Required for update. The ID of the data feed.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
*/
kind?: string | null;
/**
* Required for insert. A descriptive name of the data feed.
*/
name?: string | null;
/**
* The targets this feed should apply to (country, language, destinations).
*/
targets?: Schema$DatafeedTarget[];
}
/**
* The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.
*/
export interface Schema$DatafeedFetchSchedule {
/**
* The day of the month the feed file should be fetched (1-31).
*/
dayOfMonth?: number | null;
/**
* The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
*/
fetchUrl?: string | null;
/**
* The hour of the day the feed file should be fetched (0-23).
*/
hour?: number | null;
/**
* The minute of the hour the feed file should be fetched (0-59). Read-only.
*/
minuteOfHour?: number | null;
/**
* An optional password for fetch_url.
*/
password?: string | null;
/**
* Whether the scheduled fetch is paused or not.
*/
paused?: boolean | null;
/**
* Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
*/
timeZone?: string | null;
/**
* An optional user name for fetch_url.
*/
username?: string | null;
/**
* The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
*/
weekday?: string | null;
}
export interface Schema$DatafeedFormat {
/**
* Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
*/
columnDelimiter?: string | null;
/**
* Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
*/
fileEncoding?: string | null;
/**
* Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
*/
quotingMode?: string | null;
}
export interface Schema$DatafeedsCustomBatchRequest {
/**
* The request entries to be processed in the batch.
*/
entries?: Schema$DatafeedsCustomBatchRequestEntry[];
}
/**
* A batch entry encoding a single non-batch datafeeds request.
*/
export interface Schema$DatafeedsCustomBatchRequestEntry {
/**
* An entry ID, unique within the batch request.
*/
batchId?: number | null;
/**
* The data feed to insert.
*/
datafeed?: Schema$Datafeed;
/**
* The ID of the data feed to get, delete or fetch.
*/
datafeedId?: string | null;
/**
* The ID of the managing account.
*/
merchantId?: string | null;
/**
* The method of the batch entry. Acceptable values are: - "`delete`" - "`fetchNow`" - "`get`" - "`insert`" - "`update`"
*/
method?: string | null;
}
export interface Schema$DatafeedsCustomBatchResponse {
/**
* The result of the execution of the batch requests.
*/
entries?: Schema$DatafeedsCustomBatchResponseEntry[];
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".
*/
kind?: string | null;
}
/**
* A batch entry encoding a single non-batch datafeeds response.
*/
export interface Schema$DatafeedsCustomBatchResponseEntry {
/**
* The ID of the request entry this entry responds to.
*/
batchId?: number | null;
/**
* The requested data feed. Defined if and only if the request was successful.
*/
datafeed?: Schema$Datafeed;
/**
* A list of errors defined if and only if the request failed.
*/
errors?: Schema$Errors;
}
export interface Schema$DatafeedsFetchNowResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".
*/
kind?: string | null;
}
export interface Schema$DatafeedsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
*/
kind?: string | null;
/**
* The token for the retrieval of the next page of datafeeds.
*/
nextPageToken?: string | null;
resources?: Schema$Datafeed[];
}
/**
* The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
*/
export interface Schema$DatafeedStatus {
/**
* The country for which the status is reported, represented as a CLDR territory code.
*/
country?: string | null;
/**
* The ID of the feed for which the status is reported.
*/
datafeedId?: string | null;
/**
* The list of errors occurring in the feed.
*/
errors?: Schema$DatafeedStatusError[];
/**
* The number of items in the feed that were processed.
*/
itemsTotal?: string | null;
/**
* The number of items in the feed that were valid.
*/
itemsValid?: string | nul