googleapis
Version:
Google APIs Client Library for Node.js
1,648 lines • 224 kB
TypeScript
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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 { AxiosPromise } from 'axios';
import { GoogleApis } from '../..';
import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api';
/**
* 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');
*
* @namespace content
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Content
*/
export declare class Content {
_options: GlobalOptions;
google: GoogleApis;
root: this;
accounts: Resource$Accounts;
accountstatuses: Resource$Accountstatuses;
accounttax: Resource$Accounttax;
datafeeds: Resource$Datafeeds;
datafeedstatuses: Resource$Datafeedstatuses;
inventory: Resource$Inventory;
liasettings: Resource$Liasettings;
orders: Resource$Orders;
pos: Resource$Pos;
products: Resource$Products;
productstatuses: Resource$Productstatuses;
shippingsettings: Resource$Shippingsettings;
constructor(options: GlobalOptions, google: GoogleApis);
getRoot(): this;
}
/**
* Account data.
*/
export interface Schema$Account {
/**
* Indicates whether the merchant sells adult content.
*/
adultContent: boolean;
/**
* List of linked AdWords 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
* AdWords interface or through the AdWords API. To delete an active link, or
* to cancel a link request, remove it from the list.
*/
adwordsLinks: Schema$AccountAdwordsLink[];
/**
* The GMB account which is linked or in the process of being linked with the
* Merchant Center accounnt.
*/
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;
/**
* [DEPRECATED] This field is never returned and will be ignored if provided.
*/
reviewsUrl: 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[];
}
export interface Schema$AccountAdwordsLink {
/**
* Customer ID of the AdWords account.
*/
adwordsId: string;
/**
* Status of the link between this Merchant Center account and the AdWords
* account. Upon retrieval, it represents the actual status of the link and
* can be either active if it was approved in Google AdWords 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;
}
export 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;
}
export 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;
}
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;
}
export interface Schema$AccountsClaimWebsiteResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#accountsClaimWebsiteResponse".
*/
kind: string;
}
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 get, delete
* or claimwebsite.
*/
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;
/**
* The ID of the managing account.
*/
merchantId: string;
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;
}
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;
}
/**
* 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 or claimwebsite.
*/
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;
}
export 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.
*/
export 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[];
/**
* A list of data quality issues.
*/
dataQualityIssues: Schema$AccountStatusDataQualityIssue[];
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#accountStatus".
*/
kind: string;
/**
* Whether the account's website is claimed or not.
*/
websiteClaimed: boolean;
}
export 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;
/**
* Issue identifier.
*/
id: string;
/**
* Severity of the issue.
*/
severity: string;
/**
* Short description of the issue.
*/
title: string;
}
export interface Schema$AccountStatusDataQualityIssue {
/**
* Country for which this issue is reported.
*/
country: string;
/**
* The destination the issue applies to.
*/
destination: string;
/**
* A more detailed description of the issue.
*/
detail: string;
/**
* Actual value displayed on the landing page.
*/
displayedValue: string;
/**
* Example items featuring the issue.
*/
exampleItems: Schema$AccountStatusExampleItem[];
/**
* Issue identifier.
*/
id: string;
/**
* Last time the account was checked for this issue.
*/
lastChecked: string;
/**
* The attribute name that is relevant for the issue.
*/
location: string;
/**
* Number of items in the account found to have the said issue.
*/
numItems: number;
/**
* Severity of the problem.
*/
severity: string;
/**
* Submitted value that causes the issue.
*/
submittedValue: string;
}
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;
/**
* 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;
}
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;
}
/**
* 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;
/**
* 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;
/**
* The token for the retrieval of the next page of account statuses.
*/
nextPageToken: string;
resources: Schema$AccountStatus[];
}
/**
* An example of an item that has poor data quality. An item value on the
* landing page differs from what is submitted, or conflicts with a policy.
*/
export interface Schema$AccountStatusExampleItem {
/**
* Unique item ID as specified in the uploaded product data.
*/
itemId: string;
/**
* Landing page of the item.
*/
link: string;
/**
* The item value that was submitted.
*/
submittedValue: string;
/**
* Title of the item.
*/
title: string;
/**
* The actual value on the landing page.
*/
valueOnLandingPage: string;
}
/**
* The tax settings of a merchant account.
*/
export 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[];
}
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;
/**
* 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;
}
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;
}
/**
* 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;
/**
* 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;
}
export 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).
*/
export 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;
}
export interface Schema$AccountUser {
/**
* Whether user is an admin.
*/
admin: boolean;
/**
* User's email address.
*/
emailAddress: string;
}
export 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;
}
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;
/**
* 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;
}
export 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[];
}
/**
* 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;
/**
* [DEPRECATED] Please use targets[].language instead. The two-letter ISO
* 639-1 language of the items in the feed. Must be a valid language for
* targetCountry.
*/
contentLanguage: 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;
/**
* [DEPRECATED] Please use targets[].includedDestinations instead. The list of
* intended destinations (corresponds to checked check boxes in Merchant
* Center).
*/
intendedDestinations: 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;
/**
* [DEPRECATED] Please use targets[].country instead. The country where the
* items in the feed will be included in the search index, represented as a
* CLDR territory code.
*/
targetCountry: 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.
*/
export 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;
}
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.
*/
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;
}
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;
/**
* 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;
}
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;
}
/**
* 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;
/**
* 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;
}
export 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.
*/
export 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".
*/
export 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;
}
export 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.
*/
export 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;
}
export 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.
*/
export 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;
}
export 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.
*/
export 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;
}
export 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;
}
export interface Schema$DeliveryTime {
/**
* Holiday cutoff definitions. If configured, they specify order cutoff times
* for holiday-specific shipping.
*/
holidayCutoffs: Schema$HolidayCutoff[];
/**
* 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. Required.
*/
maxTransitTimeInDays: number;
/**
* Minimum number of business days that is spent in transit. 0 means same day
* delivery, 1 means next day delivery. Required.
*/
minTransitTimeInDays: number;
}
/**
* An error returned by the API.
*/
export 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.
*/
export 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;
}
export interface Schema$GmbAccounts {
/**
* The ID of the account.
*/
accountId: string;
/**
* A list of GMB accounts which are available to the merchant.
*/
gmbAccounts: Schema$GmbAccountsGmbAccount[];
}
export 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 locations must be set.
*/
export 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[];
}
export 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;
}
export 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;
}
export 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;
}
export interface Schema$Inventory {
/**
* The availability of the product.
*/
availability: string;
/**
* Number and amount of installments to pay for an item. Brazil only.
*/
installment: Schema$Installment;
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#inventory".
*/
kind: string;
/**
* Loyalty points that users receive after purchasing the item. Japan only.
*/
loyaltyPoints: Schema$LoyaltyPoints;
/**
* Store pickup information. Only supported for local inventory. Not setting
* pickup means "don't update" while setting it to the empty
* value ({} in JSON) means "delete". Otherwise, pickupMethod and
* pickupSla must be set together, unless pickupMethod is "not
* supported".
*/
pickup: Schema$InventoryPickup;
/**
* The price of the product.
*/
price: Schema$Price;
/**
* The quantity of the product. Must be equal to or greater than zero.
* Supported only for local products.
*/
quantity: number;
/**
* The sale price of the product. Mandatory if sale_price_effective_date is
* defined.
*/
salePrice: Schema$Price;
/**
* A date range represented by a pair of ISO 8601 dates separated by a space,
* comma, or slash. Both dates might be specified as 'null' if
* undecided.
*/
salePriceEffectiveDate: string;
/**
* The quantity of the product that is reserved for sell-on-google ads.
* Supported only for online products.
*/
sellOnGoogleQuantity: number;
}
export interface Schema$InventoryCustomBatchRequest {
/**
* The request entries to be processed in the batch.
*/
entries: Schema$InventoryCustomBatchRequestEntry[];
}
/**
* A batch entry encoding a single non-batch inventory request.
*/
export interface Schema$InventoryCustomBatchRequestEntry {
/**
* An entry ID, unique within the batch request.
*/
batchId: number;
/**
* Price and availability of the product.
*/
inventory: Schema$Inventory;
/**
* The ID of the managing account.
*/
merchantId: string;
/**
* The ID of the product for which to update price and availability.
*/
productId: string;
/**
* The code of the store for which to update price and availability. Use
* online to update price and availability of an online product.
*/
storeCode: string;
}
export interface Schema$InventoryCustomBatchResponse {
/**
* The result of the execution of the batch requests.
*/
entries: Schema$InventoryCustomBatchResponseEntry[];
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#inventoryCustomBatchResponse".
*/
kind: string;
}
/**
* A batch entry encoding a single non-batch inventory response.
*/
export interface Schema$InventoryCustomBatchResponseEntry {
/**
* 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#inventoryCustomBatchResponseEntry".
*/
kind: string;
}
export interface Schema$InventoryPickup {
/**
* Whether store pickup is available for this offer and whether the pickup
* option should be shown as buy, reserve, or not supported. Only supported
* for local inventory. Unless the value is "not supported", must be
* submitted together with pickupSla.
*/
pickupMethod: string;
/**
* The expected date that an order will be ready for pickup, relative to when
* the order is placed. Only supported for local inventory. Must be submitted
* together with pickupMethod.
*/
pickupSla: string;
}
export interface Schema$InventorySetRequest {
/**
* The availability of the product.
*/
availability: string;
/**
* Number and amount of installments to pay for an item. Brazil only.
*/
installment: Schema$Installment;
/**
* Loyalty points that users receive after purchasing the item. Japan only.
*/
loyaltyPoints: Schema$LoyaltyPoints;
/**
* Store pickup information. Only supported for local inventory. Not setting
* pickup means "don't update" while setting it to the empty
* value ({} in JSON) means "delete". Otherwise, pickupMethod and
* pickupSla must be set together, unless pickupMethod is "not
* supported".
*/
pickup: Schema$InventoryPickup;
/**
* The price of the product.
*/
price: Schema$Price;
/**
* The quantity of the product. Must be equal to or greater than zero.
* Supported only for local products.
*/
quantity: number;
/**
* The sale price of the product. Mandatory if sale_price_effective_date is
* defined.
*/
salePrice: Schema$Price;
/**
* A date range represented by a pair of ISO 8601 dates separated by a space,
* comma, or slash. Both dates might be specified as 'null' if
* undecided.
*/
salePriceEffectiveDate: string;
/**
* The quantity of the product that is reserved for sell-on-google ads.
* Supported only for online products.
*/
sellOnGoogleQuantity: number;
}
export interface Schema$InventorySetResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#inventorySetResponse".
*/
kind: string;
}
export interface Schema$LiaAboutPageSettings {
/**
* The status of the verification process for the About page.
*/
status: string;
/**
* The URL for the About page.
*/
url: string;
}
export 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 status of the "Store pickup" feature.
*/
storePickupActive: boolean;
}
export interface Schema$LiaInventorySettings {
/**
* The email of the contact for the inventory verification process.
*/
inventoryVerificationContactEmail: string;
/**
* The name of the contact for the inventory verification process.
*/
inventoryVerificationContactName: string;
/**
* The status of the verification contact.
*/
inventoryVerificationContactStatus: string;
/**
* The status of the inventory verification process.
*/
status: string;
}
export interface Schema$LiaOnDisplayToOrderSettings {
/**
* Shipping cost and policy URL.
*/
shippingCostPolicyUrl: string;
/**
* The status of the ?On display to order? feature.
*/
status: string;
}
export interface Schema$LiaSettings {
/**
* The ID of the account to which these LIA settings belong. Ignored upon
* update, always present in get request responses.
*/
accountId: string;
/**
* The LIA settings for each country.
*/
countrySettings: Schema$LiaCountrySettings[];
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#liaSettings".
*/
kind: string;
}
export interface Schema$LiasettingsCustomBatchRequest {
/**
* The request entries to be processed in the batch.
*/
entries: Schema$LiasettingsCustomBatchRequestEntry[];
}
export interface Schema$LiasettingsCustomBatchRequestEntry {
/**
* The ID of the account for which to get/update account shipping settings.
*/
accountId: string;
/**
* An entry ID, unique within the batch request.
*/
batchId: number;
/**
* Inventory validation contact email. Required only for
* SetInventoryValidationContact.
*/
contactEmail: string;
/**
* Inventory validation contact name. Required only for
* SetInventoryValidationContact.
*/
contactName: string;
/**
* The country code. Required only for RequestInventoryVerification.
*/
country: string;
/**
* The GMB account. Required only for RequestGmbAccess.
*/
gmbEmail: string;
/**
* The account Lia settings to update. Only defined if the method is update.
*/
liaSettings: Schema$LiaSettings;
/**
* The ID of the managing account.
*/
merchantId: string;
method: string;
}
export interface Schema$LiasettingsCustomBatchResponse {
/**
* The result of the execution of the batch requests.
*/
entries: Schema$LiasettingsCustomBatchResponseEntry[];
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#liasettingsCustomBatchResponse".
*/
kind: string;
}
export interface Schema$LiasettingsCustomBatchResponseEntry {
/**
* The ID of the request entry to which this entry responds.
*/
batchId: number;
/**
* A list of errors defined if, and only if, the request failed.
*/
errors: Schema$Errors;
/**
* The the list of accessible GMB accounts.
*/
gmbAccounts: Schema$GmbAccounts;
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#liasettingsCustomBatchResponseEntry".
*/
kind: string;
/**
* The retrieved or updated Lia settings.
*/
liaSettings: Schema$LiaSettings;
}
export interface Schema$LiasettingsGetAccessibleGmbAccountsResponse {
/**
* The ID of the account.
*/
accountId: string;
/**
* A list of GMB accounts which are available to the merchant.
*/
gmbAccounts: Schema$GmbAccountsGmbAccount[];
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#liasettingsGetAccessibleGmbAccountsResponse".
*/
kind: string;
}
export interface Schema$LiasettingsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#liasettingsListResponse".
*/
kind: string;
/**
* The token for the retrieval of the next page of LIA settings.
*/
nextPageToken: string;
resources: Schema$LiaSettings[];
}
export interface Schema$LiasettingsRequestGmbAccessResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#liasettingsRequestGmbAccessResponse".
*/
kind: string;
}
export interface Schema$LiasettingsRequestInventoryVerificationResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#liasettingsRequestInventoryVerificationResponse".
*/
kind: string;
}
export interface Schema$LiasettingsSetInventoryVerificationContactResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string
* "content#liasettingsSetInventoryVerificationContactResponse".
*/
kind: string;
}
export interface Schema$LocationIdSet {
/**
* A non-empty list of location IDs. They must all be of the same location
* type (e.g., state).
*/
locationIds: string[];
}
export interface Schema$LoyaltyPoints