googleapis
Version:
Google APIs Client Library for Node.js
1,367 lines • 324 kB
TypeScript
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace content_v2_1 {
interface Options extends GlobalOptions {
version: 'v2.1';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: 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;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Content API for Shopping
*
* Manages product items, inventory, and Merchant Center accounts for Google Shopping.
*
* @example
* const {google} = require('googleapis');
* const content = google.content('v2.1');
*
* @namespace content
* @type {Function}
* @version v2.1
* @variation v2.1
* @param {object=} options Options for Content
*/
class Content {
context: APIRequestContext;
accounts: Resource$Accounts;
accountstatuses: Resource$Accountstatuses;
accounttax: Resource$Accounttax;
datafeeds: Resource$Datafeeds;
datafeedstatuses: Resource$Datafeedstatuses;
liasettings: Resource$Liasettings;
orderinvoices: Resource$Orderinvoices;
orderreports: Resource$Orderreports;
orderreturns: Resource$Orderreturns;
orders: Resource$Orders;
pos: Resource$Pos;
products: Resource$Products;
productstatuses: Resource$Productstatuses;
regionalinventory: Resource$Regionalinventory;
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, patch, and update require the admin role.
*/
interface Schema$Account {
/**
* List of 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;
/**
* The business information of the account.
*/
businessInformation?: Schema$AccountBusinessInformation;
/**
* The GMB account which is linked or in the process of being linked with the Merchant Center account.
*/
googleMyBusinessLink?: Schema$AccountGoogleMyBusinessLink;
/**
* Merchant Center account ID.
*/
id?: string;
/**
* Identifies what kind of resource this is. Value: the fixed string "content#account".
*/
kind?: string;
/**
* Display name for the account.
*/
name?: string;
/**
* Client-specific, locally-unique, internal ID for the child account.
*/
sellerId?: string;
/**
* 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;
/**
* List of 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[];
}
interface Schema$AccountAddress {
/**
* CLDR country code (e.g. "US").
*/
country?: string;
/**
* City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
*/
locality?: string;
/**
* Postal code or ZIP (e.g. "94043").
*/
postalCode?: string;
/**
* Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
*/
region?: string;
/**
* Street-level part of the address.
*/
streetAddress?: string;
}
interface Schema$AccountAdsLink {
/**
* Customer ID of the Ads account.
*/
adsId?: string;
/**
* 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.
*/
status?: string;
}
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;
}
interface Schema$AccountCustomerService {
/**
* Customer service email.
*/
email?: string;
/**
* Customer service phone number.
*/
phoneNumber?: string;
/**
* Customer service URL.
*/
url?: string;
}
interface Schema$AccountGoogleMyBusinessLink {
/**
* 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;
/**
* Status of the link between this Merchant Center account and the GMB account.
*/
status?: string;
}
interface Schema$AccountIdentifier {
/**
* The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
*/
aggregatorId?: string;
/**
* The merchant account ID, set for individual accounts and subaccounts.
*/
merchantId?: string;
}
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;
}
interface Schema$AccountsClaimWebsiteResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".
*/
kind?: string;
}
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.
*/
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;
/**
* An entry ID, unique within the batch request.
*/
batchId?: number;
/**
* Whether the account should be deleted if the account has offers. Only applicable if the method is delete.
*/
force?: boolean;
/**
* Details about the link request.
*/
linkRequest?: Schema$AccountsCustomBatchRequestEntryLinkRequest;
/**
* The ID of the managing account.
*/
merchantId?: string;
/**
* The method of the batch entry.
*/
method?: string;
/**
* 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;
}
interface Schema$AccountsCustomBatchRequestEntryLinkRequest {
/**
* Action to perform for this link. The "request" action is only available to select merchants.
*/
action?: string;
/**
* The ID of the linked account.
*/
linkedAccountId?: string;
/**
* Type of the link between the two accounts.
*/
linkType?: string;
}
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;
}
/**
* A batch entry encoding a single non-batch accounts response.
*/
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;
/**
* 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;
}
interface Schema$AccountsLinkRequest {
/**
* Action to perform for this link. The "request" action is only available to select merchants.
*/
action?: string;
/**
* The ID of the linked account.
*/
linkedAccountId?: string;
/**
* Type of the link between the two accounts.
*/
linkType?: string;
}
interface Schema$AccountsLinkResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse".
*/
kind?: string;
}
interface Schema$AccountsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
*/
kind?: string;
/**
* The token for the retrieval of the next page of accounts.
*/
nextPageToken?: string;
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.
*/
interface Schema$AccountStatus {
/**
* The ID of the account for which the status is reported.
*/
accountId?: string;
/**
* A list of account level issues.
*/
accountLevelIssues?: Schema$AccountStatusAccountLevelIssue[];
/**
* Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".
*/
kind?: string;
/**
* 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;
}
interface Schema$AccountStatusAccountLevelIssue {
/**
* Country for which this issue is reported.
*/
country?: string;
/**
* The destination the issue applies to.
*/
destination?: string;
/**
* Additional details about the issue.
*/
detail?: string;
/**
* The URL of a web page to help resolving this issue.
*/
documentation?: string;
/**
* Issue identifier.
*/
id?: string;
/**
* Severity of the issue.
*/
severity?: string;
/**
* Short description of the issue.
*/
title?: string;
}
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.
*/
interface Schema$AccountstatusesCustomBatchRequestEntry {
/**
* The ID of the (sub-)account whose status to get.
*/
accountId?: string;
/**
* An entry ID, unique within the batch request.
*/
batchId?: number;
/**
* If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
*/
destinations?: string[];
/**
* The ID of the managing account.
*/
merchantId?: string;
/**
* The method (get).
*/
method?: string;
}
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;
}
/**
* A batch entry encoding a single non-batch accountstatuses response.
*/
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;
/**
* A list of errors defined if and only if the request failed.
*/
errors?: Schema$Errors;
}
interface Schema$AccountstatusesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse".
*/
kind?: string;
/**
* The token for the retrieval of the next page of account statuses.
*/
nextPageToken?: string;
resources?: Schema$AccountStatus[];
}
interface Schema$AccountStatusItemLevelIssue {
/**
* The attribute's name, if the issue is caused by a single attribute.
*/
attributeName?: string;
/**
* The error code of the issue.
*/
code?: string;
/**
* A short issue description in English.
*/
description?: string;
/**
* A detailed issue description in English.
*/
detail?: string;
/**
* The URL of a web page to help with resolving this issue.
*/
documentation?: string;
/**
* Number of items with this issue.
*/
numItems?: string;
/**
* Whether the issue can be resolved by the merchant.
*/
resolution?: string;
/**
* How this issue affects serving of the offer.
*/
servability?: string;
}
interface Schema$AccountStatusProducts {
/**
* The channel the data applies to.
*/
channel?: string;
/**
* The country the data applies to.
*/
country?: string;
/**
* The destination the data applies to.
*/
destination?: string;
/**
* List of item-level issues.
*/
itemLevelIssues?: Schema$AccountStatusItemLevelIssue[];
/**
* Aggregated product statistics.
*/
statistics?: Schema$AccountStatusStatistics;
}
interface Schema$AccountStatusStatistics {
/**
* Number of active offers.
*/
active?: string;
/**
* Number of disapproved offers.
*/
disapproved?: string;
/**
* Number of expiring offers.
*/
expiring?: string;
/**
* Number of pending offers.
*/
pending?: string;
}
/**
* The tax settings of a merchant account. All methods require the admin role.
*/
interface Schema$AccountTax {
/**
* The ID of the account to which these account tax settings belong.
*/
accountId?: string;
/**
* Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
*/
kind?: string;
/**
* 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[];
}
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.
*/
interface Schema$AccounttaxCustomBatchRequestEntry {
/**
* The ID of the account for which to get/update account tax settings.
*/
accountId?: string;
/**
* 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;
/**
* The ID of the managing account.
*/
merchantId?: string;
method?: string;
}
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;
}
/**
* A batch entry encoding a single non-batch accounttax response.
*/
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;
/**
* 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;
}
interface Schema$AccounttaxListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
*/
kind?: string;
/**
* The token for the retrieval of the next page of account tax settings.
*/
nextPageToken?: string;
resources?: Schema$AccountTax[];
}
/**
* Tax calculation rule to apply in a state or province (USA only).
*/
interface Schema$AccountTaxTaxRule {
/**
* Country code in which tax is applicable.
*/
country?: string;
/**
* State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
*/
locationId?: string;
/**
* Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
*/
ratePercent?: string;
/**
* If true, shipping charges are also taxed.
*/
shippingTaxed?: boolean;
/**
* Whether the tax rate is taken from a global tax table or specified explicitly.
*/
useGlobalRate?: boolean;
}
interface Schema$AccountUser {
/**
* Whether user is an admin.
*/
admin?: boolean;
/**
* User's email address.
*/
emailAddress?: string;
/**
* Whether user is an order manager.
*/
orderManager?: boolean;
/**
* Whether user can access payment statements.
*/
paymentsAnalyst?: boolean;
/**
* Whether user can manage payment settings.
*/
paymentsManager?: boolean;
}
interface Schema$AccountYouTubeChannelLink {
/**
* Channel ID.
*/
channelId?: string;
/**
* 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;
}
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;
}
interface Schema$BusinessDayConfig {
/**
* Regular business days. May not be empty.
*/
businessDays?: string[];
}
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;
/**
* 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;
/**
* 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;
/**
* Shipping origin for this carrier rate. Required.
*/
originPostalCode?: string;
/**
* 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;
}
interface Schema$CarriersCarrier {
/**
* The CLDR country code of the carrier (e.g., "US"). Always present.
*/
country?: string;
/**
* The name of the carrier (e.g., "UPS"). Always present.
*/
name?: string;
/**
* A list of supported services (e.g., "ground") for that carrier. Contains at least one service.
*/
services?: string[];
}
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;
/**
* The value of the attribute.
*/
value?: string;
}
interface Schema$CustomerReturnReason {
description?: string;
reasonCode?: string;
}
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;
/**
* Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
*/
minute?: number;
/**
* 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;
}
/**
* Datafeed configuration data.
*/
interface Schema$Datafeed {
/**
* The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
*/
attributeLanguage?: string;
/**
* The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
*/
contentType?: string;
/**
* Fetch schedule for the feed file.
*/
fetchSchedule?: Schema$DatafeedFetchSchedule;
/**
* The filename of the feed. All feeds must have a unique file name.
*/
fileName?: string;
/**
* Format of the feed file.
*/
format?: Schema$DatafeedFormat;
/**
* The ID of the data feed.
*/
id?: string;
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
*/
kind?: string;
/**
* A descriptive name of the data feed.
*/
name?: string;
/**
* 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.
*/
interface Schema$DatafeedFetchSchedule {
/**
* The day of the month the feed file should be fetched (1-31).
*/
dayOfMonth?: number;
/**
* 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;
/**
* The hour of the day the feed file should be fetched (0-23).
*/
hour?: number;
/**
* The minute of the hour the feed file should be fetched (0-59). Read-only.
*/
minuteOfHour?: number;
/**
* An optional password for fetch_url.
*/
password?: string;
/**
* Whether the scheduled fetch is paused or not.
*/
paused?: boolean;
/**
* Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
*/
timeZone?: string;
/**
* An optional user name for fetch_url.
*/
username?: string;
/**
* The day of the week the feed file should be fetched.
*/
weekday?: string;
}
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.
*/
columnDelimiter?: string;
/**
* Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
*/
fileEncoding?: string;
/**
* Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
*/
quotingMode?: string;
}
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.
*/
interface Schema$DatafeedsCustomBatchRequestEntry {
/**
* An entry ID, unique within the batch request.
*/
batchId?: number;
/**
* The data feed to insert.
*/
datafeed?: Schema$Datafeed;
/**
* The ID of the data feed to get, delete or fetch.
*/
datafeedId?: string;
/**
* The ID of the managing account.
*/
merchantId?: string;
method?: string;
}
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;
}
/**
* A batch entry encoding a single non-batch datafeeds response.
*/
interface Schema$DatafeedsCustomBatchResponseEntry {
/**
* The ID of the request entry this entry responds to.
*/
batchId?: number;
/**
* 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;
}
interface Schema$DatafeedsFetchNowResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".
*/
kind?: string;
}
interface Schema$DatafeedsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
*/
kind?: string;
/**
* The token for the retrieval of the next page of datafeeds.
*/
nextPageToken?: string;
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.
*/
interface Schema$DatafeedStatus {
/**
* The country for which the status is reported, represented as a CLDR territory code.
*/
country?: string;
/**
* The ID of the feed for which the status is reported.
*/
datafeedId?: string;
/**
* The list of errors occurring in the feed.
*/
errors?: Schema$DatafeedStatusError[];
/**
* The number of items in the feed that were processed.
*/
itemsTotal?: string;
/**
* The number of items in the feed that were valid.
*/
itemsValid?: string;
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
*/
kind?: string;
/**
* The two-letter ISO 639-1 language for which the status is reported.
*/
language?: string;
/**
* The last date at which the feed was uploaded.
*/
lastUploadDate?: string;
/**
* The processing status of the feed.
*/
processingStatus?: string;
/**
* The list of errors occurring in the feed.
*/
warnings?: Schema$DatafeedStatusError[];
}
/**
* An error occurring in the feed, like "invalid price".
*/
interface Schema$DatafeedStatusError {
/**
* The code of the error, e.g., "validation/invalid_value".
*/
code?: string;
/**
* The number of occurrences of the error in the feed.
*/
count?: string;
/**
* A list of example occurrences of the error, grouped by product.
*/
examples?: Schema$DatafeedStatusExample[];
/**
* The error message, e.g., "Invalid price".
*/
message?: string;
}
interface Schema$DatafeedstatusesCustomBatchRequest {
/**
* The request entries to be processed in the batch.
*/
entries?: Schema$DatafeedstatusesCustomBatchRequestEntry[];
}
/**
* A batch entry encoding a single non-batch datafeedstatuses request.
*/
interface Schema$DatafeedstatusesCustomBatchRequestEntry {
/**
* An entry ID, unique within the batch request.
*/
batchId?: number;
/**
* The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required.
*/
country?: string;
/**
* The ID of the data feed to get.
*/
datafeedId?: string;
/**
* The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required.
*/
language?: string;
/**
* The ID of the managing account.
*/
merchantId?: string;
method?: string;
}
interface Schema$DatafeedstatusesCustomBatchResponse {
/**
* The result of the execution of the batch requests.
*/
entries?: Schema$DatafeedstatusesCustomBatchResponseEntry[];
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".
*/
kind?: string;
}
/**
* A batch entry encoding a single non-batch datafeedstatuses response.
*/
interface Schema$DatafeedstatusesCustomBatchResponseEntry {
/**
* The ID of the request entry this entry responds to.
*/
batchId?: number;
/**
* The requested data feed status. Defined if and only if the request was successful.
*/
datafeedStatus?: Schema$DatafeedStatus;
/**
* A list of errors defined if and only if the request failed.
*/
errors?: Schema$Errors;
}
interface Schema$DatafeedstatusesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".
*/
kind?: string;
/**
* The token for the retrieval of the next page of datafeed statuses.
*/
nextPageToken?: string;
resources?: Schema$DatafeedStatus[];
}
/**
* An example occurrence for a particular error.
*/
interface Schema$DatafeedStatusExample {
/**
* The ID of the example item.
*/
itemId?: string;
/**
* Line number in the data feed where the example is found.
*/
lineNumber?: string;
/**
* The problematic value.
*/
value?: string;
}
interface Schema$DatafeedTarget {
/**
* The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
*/
country?: string;
/**
* The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
*/
excludedDestinations?: string[];
/**
* The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
*/
includedDestinations?: string[];
/**
* The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
*/
language?: string;
}
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;
/**
* Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
*/
holidayCutoffs?: Schema$HolidayCutoff[];
/**
* 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 minHandlingTimeInDays.
*/
maxHandlingTimeInDays?: number;
/**
* 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 minTransitTimeInDays.
*/
maxTransitTimeInDays?: number;
/**
* Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
*/
minHandlingTimeInDays?: number;
/**
* Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both.
*/
minTransitTimeInDays?: number;
/**
* 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,max}TransitTimeInDays or transitTimeTable can be set, but not both.
*/
transitTimeTable?: Schema$TransitTable;
}
/**
* An error returned by the API.
*/
interface Schema$Error {
/**
* The domain of the error.
*/
domain?: string;
/**
* A description of the error.
*/
message?: string;
/**
* The error code.
*/
reason?: string;
}
/**
* A list of errors returned by a failed batch entry.
*/
interface Schema$Errors {
/**
* The HTTP status of the first error in errors.
*/
code?: number;
/**
* A list of errors.
*/
errors?: Schema$Error[];
/**
* The message of the first error in errors.
*/
message?: string;
}
interface Schema$GmbAccounts {
/**
* The ID of the account.
*/
accountId?: string;
/**
* A list of GMB accounts which are available to the merchant.
*/
gmbAccounts?: Schema$GmbAccountsGmbAccount[];
}
interface Schema$GmbAccountsGmbAccount {
/**
* The email which identifies the GMB account.
*/
email?: string;
/**
* Number of listings under this account.
*/
listingCount?: string;
/**
* The name of the GMB account.
*/
name?: string;
/**
* The type of the GMB account (User or Business).
*/
type?: string;
}
/**
* A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set.
*/
interface Schema$Headers {
/**
* A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
*/
locations?: Schema$LocationIdSet[];
/**
* 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". Must be non-empty. Can only be set if all other fields are not set.
*/
numberOfItems?: string[];
/**
* 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[];
/**
* A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
*/
prices?: Schema$Price[];
/**
* A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
*/
weights?: Schema$Weight[];
}
interface Schema$HolidayCutoff {
/**
* Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
*/
deadlineDate?: string;
/**
* Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
*/
deadlineHour?: number;
/**
* Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
*/
deadlineTimezone?: string;
/**
* Unique identifier for the holiday. Required.
*/
holidayId?: string;
/**
* Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
*/
visibleFromDate?: string;
}
interface Schema$HolidaysHoliday {
/**
* The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.
*/
countryCode?: string;
/**
* Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present.
*/
date?: string;
/**
* Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present.
*/
deliveryGuaranteeDate?: string;
/**
* Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.
*/
deliveryGuaranteeHour?: string;
/**
* Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.
*/
id?: string;
/**
* The holiday type. Always present.
*/
type?: string;
}
interface Schema$Installment {
/**
* The amount the buyer has to pay per month.
*/
amount?: Schema$Price;
/**
* The number of installments the buyer has to pay.
*/
months?: string;
}
interface Schema$InvoiceSummary {
/**
* Summary of the total amounts of the additional charges.
*/
additionalChargeSummaries?: Schema$InvoiceSummaryAdditionalChargeSummary[];
/**
* [required] Total price for the product.
*/
productTotal?: Schema$Amount;
}
interface Schema$InvoiceSummaryAdditionalChargeSummary {
/**
* [required] Total additional charge for this type.
*/
totalAmount?: Schema$Amount;
/**
* [required] Type of the additional charge.
*/
type?: string;
}
interface Schema$LiaAboutPageSettings {
/**
* The status of the verification process for the About page.
*/
status?: string;
/**
* The URL for the About page.
*/
url?: string;
}
interface Schema$LiaCountrySettings {
/**
* The settings for the About page.
*/
about?: Schema$LiaAboutPageSettings;
/**
* CLDR country code (e.g. "US").
*/
country?: string;
/**
* The status of the "Merchant hosted local storefront" feature.
*/
hostedLocalStorefrontActive?: boolean;
/**
* LIA inventory verification settings.
*/
inventory?: Schema$LiaInventorySettings;
/**
* LIA "On Display To Order" settings.
*/
onDisplayToOrder?: Schema$LiaOnDisplayToOrderSettings;
/**
* The POS data provider linked with this country.
*/
posDataProvider?: Schema$LiaPosDataProvider;
/**
* The status of the "Store pickup" feature.
*/
storePickupActive?: boolean;
}
interface Schema$LiaInventorySettings {
/**
* The email of the contact for the inventory verification process.
*/
invent