Skip to main content

Gcp/content

@swamp/gcp/contentv2026.05.27.1· 3d agoMODELS
01README

Google Cloud content infrastructure models

02Release Notes
  • Updated: products
03Models25
accounts.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
adsLinks?arrayCustomer ID of the Ads account.
adultContent?booleanIndicates whether the merchant sells adult content.
automaticImprovements?objectEnables automatic image improvements.
automaticLabelIds?arrayAutomatically created label IDs that are assigned to the account by CSS Center.
businessIdentity?objectOptional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
businessInformation?objectCLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
conversionSettings?objectWhen enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
cssId?stringID of CSS the account belongs to.
googleMyBusinessLink?objectThe ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
id?stringRequired. 64-bit Merchant Center account ID.
labelIds?arrayManually created label IDs that are assigned to the account by CSS.
name?stringRequired. Display name for the account.
sellerId?stringClient-specific, locally-unique, internal ID for the child account.
users?arrayWhether user is an admin.
websiteUrl?stringThe merchant's website.
youtubeChannelLinks?arrayChannel ID.
merchantIdstringThe ID of the managing account. This must be a multi-client account.
fn create()
Create a accounts
fn get(identifier: string)
Get a accounts
ArgumentTypeDescription
identifierstringThe name of the accounts
fn update()
Update accounts attributes
fn delete(identifier: string)
Delete the accounts
ArgumentTypeDescription
identifierstringThe name of the accounts
fn sync()
Sync accounts state from GCP
fn list(label?: string, maxResults?: number, name?: string, view?: string, maxPages?: number)
List accounts resources
ArgumentTypeDescription
label?stringIf view is set to "css", only return accounts that are assigned label with given ID.
maxResults?numberThe maximum number of accounts to return in the response, used for paging.
name?stringIf set, only the accounts with the given name (case sensitive) will be returned.
view?stringControls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".
maxPages?numberMaximum number of pages to fetch (default: 10)
fn authinfo()
authinfo
fn claimwebsite()
claimwebsite
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
fn link(action?: any, eCommercePlatformLinkInfo?: any, linkType?: any, linkedAccountId?: any, paymentServiceProviderLinkInfo?: any, services?: any)
link
ArgumentTypeDescription
action?any
eCommercePlatformLinkInfo?any
linkType?any
linkedAccountId?any
paymentServiceProviderLinkInfo?any
services?any
fn listlinks()
listlinks
fn requestphoneverification(languageCode?: any, phoneNumber?: any, phoneRegionCode?: any, phoneVerificationMethod?: any)
requestphoneverification
ArgumentTypeDescription
languageCode?any
phoneNumber?any
phoneRegionCode?any
phoneVerificationMethod?any
fn updatelabels(labelIds?: any)
updatelabels
ArgumentTypeDescription
labelIds?any
fn verifyphonenumber(phoneVerificationMethod?: any, verificationCode?: any, verificationId?: any)
verifyphonenumber
ArgumentTypeDescription
phoneVerificationMethod?any
verificationCode?any
verificationId?any
accounts_labels.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
accountId?stringImmutable. The ID of account this label belongs to.
description?stringThe description of this label.
name?stringThe display name of this label.
fn create()
Create a labels
fn get(identifier: string)
Get a labels
ArgumentTypeDescription
identifierstringThe name of the labels
fn update()
Update labels attributes
fn delete(identifier: string)
Delete the labels
ArgumentTypeDescription
identifierstringThe name of the labels
fn sync()
Sync labels state from GCP
fn list(pageSize?: number, maxPages?: number)
List labels resources
ArgumentTypeDescription
pageSize?numberThe maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
accounts_returncarrier.tsv2026.05.25.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
carrierAccountName?stringName of the carrier account.
carrierAccountNumber?stringNumber of the carrier account.
carrierCode?enumThe carrier code enum. Accepts the values FEDEX or UPS.
accountIdstringRequired. The Merchant Center Account Id under which the Return Carrier is to be linked.
fn create()
Create a returncarrier
fn get(identifier: string)
Get a returncarrier
ArgumentTypeDescription
identifierstringThe name of the returncarrier
fn update()
Update returncarrier attributes
fn delete(identifier: string)
Delete the returncarrier
ArgumentTypeDescription
identifierstringThe name of the returncarrier
fn sync()
Sync returncarrier state from GCP
fn list(maxPages?: number)
List returncarrier resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
accountstatuses.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a accountstatuses
ArgumentTypeDescription
identifierstringThe name of the accountstatuses
fn sync()
Sync accountstatuses state from GCP
fn list(destinations?: string, maxResults?: number, name?: string, maxPages?: number)
List accountstatuses resources
ArgumentTypeDescription
destinations?stringIf set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
maxResults?numberThe maximum number of account statuses to return in the response, used for paging.
name?stringIf set, only the accounts with the given name (case sensitive) will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
accounttax.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accountId?stringRequired. The ID of the account to which these account tax settings belong.
kind?stringIdentifies what kind of resource this is. Value: the fixed string "`content#accountTax`".
rules?arrayCountry code in which tax is applicable.
fn get(identifier: string)
Get a accounttax
ArgumentTypeDescription
identifierstringThe name of the accounttax
fn update()
Update accounttax attributes
fn sync()
Sync accounttax state from GCP
fn list(maxResults?: number, maxPages?: number)
List accounttax resources
ArgumentTypeDescription
maxResults?numberThe maximum number of tax settings to return in the response, used for paging.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
collections.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
customLabel0?stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)
customLabel1?stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
customLabel2?stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
customLabel3?stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
customLabel4?stringLabel that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
featuredProduct?arrayThe unique identifier for the product item.
headline?arrayYour collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)
id?stringRequired. 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)
imageLink?arrayThe URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)
language?stringThe language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)
link?stringA collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)
mobileLink?stringA 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)
productCountry?string[product_country attribute](https://support.google.com/merchants/answer/9674155)
merchantIdstringRequired. The ID of the account that contains the collection. This account cannot be a multi-client account.
fn create()
Create a collections
fn get(identifier: string)
Get a collections
ArgumentTypeDescription
identifierstringThe name of the collections
fn delete(identifier: string)
Delete the collections
ArgumentTypeDescription
identifierstringThe name of the collections
fn sync()
Sync collections state from GCP
fn list(pageSize?: number, maxPages?: number)
List collections resources
ArgumentTypeDescription
pageSize?numberThe maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
collectionstatuses.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a collectionstatuses
ArgumentTypeDescription
identifierstringThe name of the collectionstatuses
fn sync()
Sync collectionstatuses state from GCP
fn list(pageSize?: number, maxPages?: number)
List collectionstatuses resources
ArgumentTypeDescription
pageSize?numberThe maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
conversionsources.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
googleAnalyticsLink?objectRequired. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40.
merchantCenterDestination?objectRequired. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40.
merchantIdstringRequired. The ID of the account that owns the new conversion source.
fn create(waitForReady?: boolean)
Create a conversionsources
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a conversionsources
ArgumentTypeDescription
identifierstringThe name of the conversionsources
fn update(waitForReady?: boolean)
Update conversionsources attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the conversionsources
ArgumentTypeDescription
identifierstringThe name of the conversionsources
fn sync()
Sync conversionsources state from GCP
fn list(pageSize?: number, showDeleted?: boolean, maxPages?: number)
List conversionsources resources
ArgumentTypeDescription
pageSize?numberThe maximum number of conversion sources to return in a page. If no `page_size` is specified, `100` is used as the default value. The maximum value is `200`. Values above `200` will be coerced to `200`. Regardless of pagination, at most `200` conversion sources are returned in total.
showDeleted?booleanIf true, also returns archived conversion sources.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn undelete()
undelete
csses.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a csses
ArgumentTypeDescription
identifierstringThe name of the csses
fn sync()
Sync csses state from GCP
fn list(pageSize?: number, maxPages?: number)
List csses resources
ArgumentTypeDescription
pageSize?numberThe maximum number of CSS domains to return. The service may return fewer than this value. If unspecified, at most 50 CSS domains will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn updatelabels(labelIds?: any)
updatelabels
ArgumentTypeDescription
labelIds?any
datafeeds.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
attributeLanguage?stringThe two-letter ISO 639-1 language in which the attributes are defined in the data feed.
contentType?stringRequired. 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`"
fetchSchedule?objectThe day of the month the feed file should be fetched (1-31).
fileName?stringRequired. The filename of the feed. All feeds must have a unique file name.
format?objectDelimiter 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`"
id?stringRequired for update. The ID of the data feed.
name?stringRequired for insert. A descriptive name of the data feed.
targets?arrayDeprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
merchantIdstringThe ID of the account that manages the datafeed. This account cannot be a multi-client account.
fn create()
Create a datafeeds
fn get(identifier: string)
Get a datafeeds
ArgumentTypeDescription
identifierstringThe name of the datafeeds
fn update()
Update datafeeds attributes
fn delete(identifier: string)
Delete the datafeeds
ArgumentTypeDescription
identifierstringThe name of the datafeeds
fn sync()
Sync datafeeds state from GCP
fn list(maxResults?: number, maxPages?: number)
List datafeeds resources
ArgumentTypeDescription
maxResults?numberThe maximum number of products to return in the response, used for paging.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
fn fetchnow()
fetchnow
datafeedstatuses.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a datafeedstatuses
ArgumentTypeDescription
identifierstringThe name of the datafeedstatuses
fn sync()
Sync datafeedstatuses state from GCP
fn list(maxResults?: number, maxPages?: number)
List datafeedstatuses resources
ArgumentTypeDescription
maxResults?numberThe maximum number of products to return in the response, used for paging.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
freelistingsprogram.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a freelistingsprogram
ArgumentTypeDescription
identifierstringThe name of the freelistingsprogram
fn sync()
Sync freelistingsprogram state from GCP
fn requestreview(regionCode?: any)
requestreview
ArgumentTypeDescription
regionCode?any
freelistingsprogram_checkoutsettings.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
uriSettings?objectURL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
merchantIdstringRequired. The ID of the account.
fn create()
Create a checkoutsettings
fn get(identifier: string)
Get a checkoutsettings
ArgumentTypeDescription
identifierstringThe name of the checkoutsettings
fn delete(identifier: string)
Delete the checkoutsettings
ArgumentTypeDescription
identifierstringThe name of the checkoutsettings
fn sync()
Sync checkoutsettings state from GCP
liasettings.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accountId?stringThe ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
countrySettings?arrayThe status of the verification process for the About page. Supported values are: - "`active`" - "`inactive`" - "`pending`"
kind?stringIdentifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
fn get(identifier: string)
Get a liasettings
ArgumentTypeDescription
identifierstringThe name of the liasettings
fn update()
Update liasettings attributes
fn sync()
Sync liasettings state from GCP
fn list(maxResults?: number, maxPages?: number)
List liasettings resources
ArgumentTypeDescription
maxResults?numberThe maximum number of LIA settings to return in the response, used for paging.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
fn getaccessiblegmbaccounts()
getaccessiblegmbaccounts
fn listposdataproviders()
listposdataproviders
fn requestgmbaccess()
requestgmbaccess
fn requestinventoryverification()
requestinventoryverification
fn setinventoryverificationcontact()
setinventoryverificationcontact
fn setomnichannelexperience()
setomnichannelexperience
fn setposdataprovider()
setposdataprovider
pos.tsv2026.05.25.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
gcidCategory?arrayThe business type of the store.
phoneNumber?stringThe store phone number.
placeId?stringThe Google Place Id of the store location.
storeAddress?stringRequired. The street address of the store.
storeCode?stringRequired. A store identifier that is unique for the given merchant.
storeName?stringThe merchant or store name.
websiteUrl?stringThe website url for the store or merchant.
merchantIdstringThe ID of the POS or inventory data provider.
targetMerchantIdstringThe ID of the target merchant.
fn create()
Create a pos
fn get(identifier: string)
Get a pos
ArgumentTypeDescription
identifierstringThe name of the pos
fn delete(identifier: string)
Delete the pos
ArgumentTypeDescription
identifierstringThe name of the pos
fn sync()
Sync pos state from GCP
fn list(maxPages?: number)
List pos resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
fn inventory(contentLanguage?: any, gtin?: any, itemId?: any, pickupMethod?: any, pickupSla?: any, price?: any, quantity?: any, storeCode?: any, targetCountry?: any, timestamp?: any)
inventory
ArgumentTypeDescription
contentLanguage?any
gtin?any
itemId?any
pickupMethod?any
pickupSla?any
price?any
quantity?any
storeCode?any
targetCountry?any
timestamp?any
fn sale(contentLanguage?: any, gtin?: any, itemId?: any, price?: any, quantity?: any, saleId?: any, storeCode?: any, targetCountry?: any, timestamp?: any)
sale
ArgumentTypeDescription
contentLanguage?any
gtin?any
itemId?any
price?any
quantity?any
saleId?any
storeCode?any
targetCountry?any
timestamp?any
productdeliverytime.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
areaDeliveryTimes?arrayRequired. The country that the product can be delivered to. Submit a [unicode CLDR region](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) such as `US` or `CH`.
productId?objectThe Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.
merchantIdstringThe Google merchant ID of the account that contains the product. This account cannot be a multi-client account.
fn create()
Create a productdeliverytime
fn get(identifier: string)
Get a productdeliverytime
ArgumentTypeDescription
identifierstringThe name of the productdeliverytime
fn delete(identifier: string)
Delete the productdeliverytime
ArgumentTypeDescription
identifierstringThe name of the productdeliverytime
fn sync()
Sync productdeliverytime state from GCP
products.tsv2026.05.27.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
additionalImageLinks?arrayAdditional URLs of images of the item.
additionalSizeType?stringAdditional cut of the item. Used together with size_type to represent combined size types for apparel items.
adsGrouping?stringUsed to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
adsLabels?arraySimilar to ads_grouping, but only works on CPC.
adsRedirect?stringAllows advertisers to override the item URL when the product is shown within the context of Product Ads.
adult?booleanShould be set to true if the item is targeted towards adults.
ageGroup?stringTarget age group of the item.
autoPricingMinPrice?objectThe currency of the price.
availability?stringAvailability status of the item.
availabilityDate?stringThe day a pre-ordered product becomes available for delivery, in ISO 8601 format.
brand?stringBrand of the item.
canonicalLink?stringURL for the canonical version of your item's landing page.
certifications?arrayThe certification authority, for example "European_Commission". Maximum length is 2000 characters.
channel?stringRequired. The item\'s channel (online or local). Acceptable values are: - "`local`" - "`online`"
cloudExportAdditionalProperties?arrayBoolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.
color?stringColor of the item.
condition?stringCondition or state of the item.
contentLanguage?stringRequired. The two-letter ISO 639-1 language code for the item.
costOfGoodsSold?objectThe currency of the price.
customAttributes?arraySubattributes within this attribute group. Exactly one of value or groupValues must be provided.
customLabel0?stringCustom label 0 for custom grouping of items in a Shopping campaign.
customLabel1?stringCustom label 1 for custom grouping of items in a Shopping campaign.
customLabel2?stringCustom label 2 for custom grouping of items in a Shopping campaign.
customLabel3?stringCustom label 3 for custom grouping of items in a Shopping campaign.
customLabel4?stringCustom label 4 for custom grouping of items in a Shopping campaign.
description?stringDescription of the item.
disclosureDate?stringThe date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date](https://support.google.com/merchants/answer/13034208) for more information.
displayAdsId?stringAn identifier for an item for dynamic remarketing campaigns.
displayAdsLink?stringURL directly to your item's landing page for dynamic remarketing campaigns.
displayAdsSimilarIds?arrayAdvertiser-specified recommendations.
displayAdsTitle?stringTitle of an item for dynamic remarketing campaigns.
displayAdsValue?numberOffer margin for dynamic remarketing campaigns.
energyEfficiencyClass?stringThe energy efficiency class as defined in EU directive 2010/30/EU.
excludedDestinations?arrayThe list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
expirationDate?stringDate on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.
externalSellerId?stringRequired for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
feedLabel?stringFeed label for the item. Either `targetCountry` or `feedLabel` is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
freeShippingThreshold?arrayRequired. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.
gender?stringTarget gender of the item.
googleProductCategory?stringGoogle's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
gtin?stringGlobal Trade Item Number (GTIN) of the item.
id?stringThe REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product has one of the 2 forms channel:contentLanguage: targetCountry: offerId or channel:contentLanguage:feedLabel: offerId.
identifierExists?booleanFalse when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
imageLink?stringURL of an image of the item.
includedDestinations?arrayThe list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
installment?objectThe currency of the price.
isBundle?booleanWhether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
itemGroupId?stringShared identifier for all variants of the same product.
lifestyleImageLinks?arrayAdditional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
link?stringURL directly linking to your item's page on your website.
linkTemplate?stringURL template for merchant hosted local storefront.
loyaltyProgram?objectThe currency of the price.
loyaltyPrograms?arrayThe currency of the price.
material?stringThe material of which the item is made.
maxEnergyEfficiencyClass?stringThe energy efficiency class as defined in EU directive 2010/30/EU.
maxHandlingTime?stringMaximal product handling time (in business days).
maximumRetailPrice?objectThe currency of the price.
minEnergyEfficiencyClass?stringThe energy efficiency class as defined in EU directive 2010/30/EU.
minHandlingTime?stringMinimal product handling time (in business days).
mobileLink?stringURL for the mobile-optimized version of your item's landing page.
mobileLinkTemplate?stringURL template for merchant hosted local storefront optimized for mobile devices.
mpn?stringManufacturer Part Number (MPN) of the item.
multipack?stringThe number of identical products in a merchant-defined multipack.
offerId?stringRequired. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
pattern?stringThe item's pattern (for example, polka dots).
pause?stringPublication of this item should be temporarily paused. Acceptable values are: - "`ads`"
pickupMethod?stringThe pick up option for the item. Acceptable values are: - "`buy`" - "`reserve`" - "`ship to store`" - "`not supported`"
pickupSla?stringItem store pickup timeline. Acceptable values are: - "`same day`" - "`next day`" - "`2-day`" - "`3-day`" - "`4-day`" - "`5-day`" - "`6-day`" - "`7-day`" - "`multi-week`"
price?objectThe currency of the price.
productDetails?arrayThe name of the product detail.
productHeight?objectRequired. The length units. Acceptable values are: - "`in`" - "`cm`"
productHighlights?arrayBullet points describing the most relevant highlights of a product.
productLength?objectRequired. The length units. Acceptable values are: - "`in`" - "`cm`"
productTypes?arrayCategories of the item (formatted as in product data specification).
productWeight?objectRequired. The weight unit. Acceptable values are: - "`g`" - "`kg`" - "`oz`" - "`lb`"
productWidth?objectRequired. The length units. Acceptable values are: - "`in`" - "`cm`"
promotionIds?arrayThe unique ID of a promotion.
salePrice?objectThe currency of the price.
salePriceEffectiveDate?stringDate range during which the item is on sale (see product data specification).
sellOnGoogleQuantity?stringThe quantity of the product that is available for selling on Google. Supported only for online products.
shipping?arrayThe CLDR territory code of the country to which an item will ship.
shippingHeight?objectThe unit of value.
shippingLabel?stringThe shipping label of the product, used to group product in account-level shipping rules.
shippingLength?objectThe unit of value.
shippingWeight?objectThe unit of value.
shippingWidth?objectThe unit of value.
shoppingAdsExcludedCountries?arrayList of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.
sizeSystem?stringSystem in which the size is specified. Recommended for apparel items.
sizeType?stringThe cut of the item. Recommended for apparel items.
sizes?arraySize of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition).
structuredDescription?objectRequired. The description text. Maximum length is 5000 characters.
structuredTitle?objectRequired. The title text. Maximum length is 150 characters.
subscriptionCost?objectThe currency of the price.
sustainabilityIncentives?arrayThe currency of the price.
targetCountry?stringRequired. The CLDR territory code for the item's country of sale.
taxCategory?stringThe tax category of the product, used to configure detailed tax nexus in account-level tax settings.
taxes?arrayThe country within which the item is taxed, specified as a CLDR territory code.
title?stringTitle of the item.
transitTimeLabel?stringThe transit time label of the product, used to group product in account-level transit time tables.
unitPricingBaseMeasure?objectThe unit of the denominator.
unitPricingMeasure?objectThe unit of the measure.
virtualModelLink?stringURL of the 3D model of the item to provide more visuals.
merchantIdstringThe ID of the account that contains the product. This account cannot be a multi-client account.
feedId?stringThe Content API Supplemental Feed ID. If present then product insertion applies to the data in a supplemental feed.
fn create()
Create a products
fn get(identifier: string)
Get a products
ArgumentTypeDescription
identifierstringThe name of the products
fn update()
Update products attributes
fn delete(identifier: string)
Delete the products
ArgumentTypeDescription
identifierstringThe name of the products
fn sync()
Sync products state from GCP
fn list(maxResults?: number, maxPages?: number)
List products resources
ArgumentTypeDescription
maxResults?numberThe maximum number of products to return in the response, used for paging. The default value is 25. The maximum value is 250.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
productstatuses.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a productstatuses
ArgumentTypeDescription
identifierstringThe name of the productstatuses
fn sync()
Sync productstatuses state from GCP
fn list(destinations?: string, maxResults?: number, maxPages?: number)
List productstatuses resources
ArgumentTypeDescription
destinations?stringIf set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
maxResults?numberThe maximum number of product statuses to return in the response, used for paging. The default value is 25. The maximum value is 250.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
promotions.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
brand?arrayProduct filter by brand for the promotion.
brandExclusion?arrayProduct filter by brand exclusion for the promotion.
contentLanguage?stringRequired. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
couponValueType?enumRequired. Coupon value type for the promotion.
customRedemptionRestriction?stringThe custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
freeGiftDescription?stringFree gift description for the promotion.
freeGiftItemId?stringFree gift item ID for the promotion.
freeGiftValue?objectThe currency of the price.
genericRedemptionCode?stringGeneric redemption code for the promotion. To be used with the `offerType` field.
getThisQuantityDiscounted?numberThe number of items discounted in the promotion.
itemGroupId?arrayProduct filter by item group ID for the promotion.
itemGroupIdExclusion?arrayProduct filter by item group ID exclusion for the promotion.
itemId?arrayProduct filter by item ID for the promotion.
itemIdExclusion?arrayProduct filter by item ID exclusion for the promotion.
limitQuantity?numberMaximum purchase quantity for the promotion.
limitValue?objectThe currency of the price.
longTitle?stringRequired. Long title for the promotion.
maxDiscountAmount?objectThe currency of the price.
minimumPurchaseAmount?objectThe currency of the price.
minimumPurchaseQuantity?numberMinimum purchase quantity for the promotion.
moneyBudget?objectThe currency of the price.
moneyOffAmount?objectThe currency of the price.
offerType?enumRequired. Type of the promotion.
orderLimit?numberOrder limit for the promotion.
percentOff?numberThe percentage discount offered in the promotion.
productApplicability?enumRequired. Applicability of the promotion to either all products or only specific products.
productType?arrayProduct filter by product type for the promotion.
productTypeExclusion?arrayProduct filter by product type exclusion for the promotion.
promotionDestinationIds?arrayDestination ID for the promotion.
promotionDisplayTimePeriod?objectThe ending timestamp.
promotionEffectiveTimePeriod?objectThe ending timestamp.
promotionId?stringRequired. The user provided promotion ID to uniquely identify the promotion.
promotionStatus?objectDate on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
promotionUrl?stringURL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
redemptionChannel?arrayRequired. Redemption channel for the promotion. At least one channel is required.
redemptionRestriction?enumThe redemption restriction for the promotion.
shippingServiceNames?arrayShipping service names for the promotion.
storeApplicability?enumWhether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.
storeCode?arrayStore codes to include for the promotion.
storeCodeExclusion?arrayStore codes to exclude for the promotion.
targetCountry?stringRequired. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
merchantIdstringRequired. The ID of the account that contains the collection.
fn create()
Create a promotions
fn get(identifier: string)
Get a promotions
ArgumentTypeDescription
identifierstringThe id of the promotions
fn sync()
Sync promotions state from GCP
fn list(countryCode?: string, languageCode?: string, pageSize?: number, maxPages?: number)
List promotions resources
ArgumentTypeDescription
countryCode?string[CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US"), used as a filter on promotions target country.
languageCode?stringThe two-letter ISO 639-1 language code associated with the promotions, used as a filter.
pageSize?numberThe maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
pubsubnotificationsettings.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
cloudTopicName?stringCloud pub/sub topic to which notifications are sent (read-only).
kind?stringIdentifies what kind of resource this is. Value: the fixed string "`content#pubsubNotificationSettings`"
registeredEvents?arrayList of event types. Acceptable values are: - "`orderPendingShipment`"
fn get(identifier: string)
Get a pubsubnotificationsettings
ArgumentTypeDescription
identifierstringThe name of the pubsubnotificationsettings
fn update()
Update pubsubnotificationsettings attributes
fn sync()
Sync pubsubnotificationsettings state from GCP
quotas.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a quotas
ArgumentTypeDescription
identifierstringThe name of the quotas
fn sync()
Sync quotas state from GCP
fn list(pageSize?: number, maxPages?: number)
List quotas resources
ArgumentTypeDescription
pageSize?numberThe maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
regions.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
displayName?stringThe display name of the region.
geotargetArea?objectRequired. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state).
merchantId?stringOutput only. Immutable. Merchant that owns the region.
postalCodeArea?objectRequired. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*".
fn create()
Create a regions
fn get(identifier: string)
Get a regions
ArgumentTypeDescription
identifierstringThe name of the regions
fn update()
Update regions attributes
fn delete(identifier: string)
Delete the regions
ArgumentTypeDescription
identifierstringThe name of the regions
fn sync()
Sync regions state from GCP
fn list(pageSize?: number, maxPages?: number)
List regions resources
ArgumentTypeDescription
pageSize?numberThe maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
returnpolicyonline.tsv2026.05.25.2

Global Arguments

ArgumentTypeDescription
countries?arrayThe countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. "US".
itemConditions?arrayThe item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.
label?stringThe unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.
name?stringThe name of the policy as shown in Merchant Center.
policy?objectThe number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.
restockingFee?objectThe currency of the price.
returnMethods?arrayThe return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
returnPolicyUri?stringThe return policy uri. This can used by Google to do a sanity check for the policy.
returnReasonCategoryInfo?arrayThe corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.
merchantIdstringRequired. The id of the merchant for which to retrieve the return policy online object.
fn create()
Create a returnpolicyonline
fn get(identifier: string)
Get a returnpolicyonline
ArgumentTypeDescription
identifierstringThe name of the returnpolicyonline
fn update()
Update returnpolicyonline attributes
fn delete(identifier: string)
Delete the returnpolicyonline
ArgumentTypeDescription
identifierstringThe name of the returnpolicyonline
fn sync()
Sync returnpolicyonline state from GCP
fn list(maxPages?: number)
List returnpolicyonline resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
shippingsettings.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accountId?stringThe ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
postalCodeGroups?arrayThe CLDR territory code of the country the postal code group applies to. Required.
services?arrayA boolean exposing the active status of the shipping service. Required.
warehouses?arrayRegular business days, such as '\"monday\"'. May not be empty.
fn get(identifier: string)
Get a shippingsettings
ArgumentTypeDescription
identifierstringThe name of the shippingsettings
fn update()
Update shippingsettings attributes
fn sync()
Sync shippingsettings state from GCP
fn list(maxResults?: number, maxPages?: number)
List shippingsettings resources
ArgumentTypeDescription
maxResults?numberThe maximum number of shipping settings to return in the response, used for paging.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn custombatch(entries?: any)
custombatch
ArgumentTypeDescription
entries?any
fn getsupportedcarriers()
getsupportedcarriers
fn getsupportedholidays()
getsupportedholidays
fn getsupportedpickupservices()
getsupportedpickupservices
shoppingadsprogram.tsv2026.05.25.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a shoppingadsprogram
ArgumentTypeDescription
identifierstringThe name of the shoppingadsprogram
fn sync()
Sync shoppingadsprogram state from GCP
fn requestreview(regionCode?: any)
requestreview
ArgumentTypeDescription
regionCode?any
04Previous Versions12
2026.05.25.2May 25, 2026
  • Updated: accounts_returncarrier, pos, returnpolicyonline
2026.05.24.1May 24, 2026
  • Updated: accounts, accounts_labels, accounts_returncarrier, accountstatuses, accounttax, collections, collectionstatuses, conversionsources, csses, datafeeds, datafeedstatuses, freelistingsprogram, freelistingsprogram_checkoutsettings, liasettings, pos, productdeliverytime, products, productstatuses, promotions, pubsubnotificationsettings, quotas, regions, returnpolicyonline, shippingsettings, shoppingadsprogram
2026.05.21.2May 21, 2026
  • Updated: accounts, accounts_labels, accounts_returncarrier, accountstatuses, accounttax, collections, collectionstatuses, conversionsources, csses, datafeeds, datafeedstatuses, freelistingsprogram, freelistingsprogram_checkoutsettings, liasettings, pos, productdeliverytime, products, productstatuses, promotions, pubsubnotificationsettings, quotas, regions, returnpolicyonline, shippingsettings, shoppingadsprogram
2026.05.21.1May 21, 2026
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026

Modified 1 models

2026.04.23.1Apr 23, 2026

Modified 1 models

2026.04.04.1Apr 4, 2026
  • Updated: shippingsettings
2026.04.03.3Apr 3, 2026
  • Updated: accounts, accounts_labels, accounts_returncarrier, accountstatuses, accounttax, collections, collectionstatuses, conversionsources, csses, datafeeds, datafeedstatuses, freelistingsprogram, freelistingsprogram_checkoutsettings, liasettings, pos, productdeliverytime, products, productstatuses, promotions, pubsubnotificationsettings, quotas, regions, returnpolicyonline, shippingsettings, shoppingadsprogram
2026.04.03.1Apr 3, 2026
  • Updated: accounts, accounts_labels, accounts_returncarrier, accountstatuses, accounttax, collections, collectionstatuses, conversionsources, csses, datafeeds, datafeedstatuses, freelistingsprogram, freelistingsprogram_checkoutsettings, liasettings, pos, productdeliverytime, products, productstatuses, promotions, pubsubnotificationsettings, quotas, regions, returnpolicyonline, shippingsettings, shoppingadsprogram
2026.04.02.2Apr 2, 2026

Modified 1 models

2026.03.27.1Mar 27, 2026
  • Added: accounts, accounts_labels, accounts_returncarrier, accountstatuses, accounttax, collections, collectionstatuses, conversionsources, csses, datafeeds, datafeedstatuses, freelistingsprogram, freelistingsprogram_checkoutsettings, liasettings, pos, productdeliverytime, products, productstatuses, promotions, pubsubnotificationsettings, quotas, regions, returnpolicyonline, shippingsettings, shoppingadsprogram
05Stats
A
100 / 100
Downloads
0
Archive size
248.1 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels