REST Resource: accounts.productInputs

    • ProductInput represents data submitted for a product, which is combined with rules and supplemental data to create the processed Product visible in Google Merchant Center and Shopping ads.

    • Required attributes for ProductInput include feedLabel, contentLanguage, and offerId, primarily defined in the Products Data Specification.

    • After any ProductInput operation (insert, update, delete), it may take several minutes for the processed product to become retrievable.

    • ProductInput attributes generally match their corresponding attribute names in the vertical spec, with some exceptions documented in the provided link.

    • ProductInput offers methods to delete and insert product data within your Merchant Center account.

    Resource: ProductInput

    This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product . For more information, see Manage products .

    Required product input attributes to pass data validation checks are primarily defined in the Products Data Specification .

    The following attributes are required: feedLabel , contentLanguage and offerId .

    After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

    All fields in the product input and its sub-messages match the English name of their corresponding attribute in the Products Data Specification with some exceptions . The following reference documentation lists the field names in the camelCasecasing style while the Products Data Specification lists the names in the snake_casecasing style.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "product" 
 : 
 string 
 , 
 "channel" 
 : 
 enum (  ChannelEnum 
 
) 
 , 
 "offerId" 
 : 
 string 
 , 
 "contentLanguage" 
 : 
 string 
 , 
 "feedLabel" 
 : 
 string 
 , 
 "attributes" 
 : 
 { 
 object (  Attributes 
 
) 
 } 
 , 
 "customAttributes" 
 : 
 [ 
 { 
 object (  CustomAttribute 
 
) 
 } 
 ] 
 , 
 "versionNumber" 
 : 
 string 
 }
    Fields
    name

    string

    Identifier. The name of the product. Format: accounts/{account}/productInputs/{productinput}

    The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: contentLanguage~feedLabel~offerId . Example: en~US~sku123 For legacy local products, the structure is: local~contentLanguage~feedLabel~offerId . Example: local~en~US~sku123

    The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options:

    1. Encoded Format: The {productinput} segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the contentLanguage~feedLabel~offerId structure. This encoding MUST be used if any part of the product identifier (like offerId ) contains characters such as / , % , or ~ .

      • Example: To represent the product ID en~US~sku/123 , the {productinput} segment must be the base64url encoding of this string, which is ZW5-VVMtc2t1LzEyMw . The full resource name for the product would be accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw .

    2. Plain Format: The {productinput} segment is the tilde-separated string contentLanguage~feedLabel~offerId . This format is suitable only when contentLanguage , feedLabel , and offerId do not contain URL-problematic characters like / , % , or ~ .

    We recommend using the Encoded Formatfor all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde ( ~ ) characters in the {productinput} segment is used to differentiate between the two formats.

    Note: For calls to the v1beta version, the plain format is channel~contentLanguage~feedLabel~offerId , for example: accounts/123/productinputs/online~en~US~sku123 .

    product

    string

    Output only. The name of the processed product. Format: accounts/{account}/products/{product}

    channel

    enum ( ChannelEnum )

    Immutable. The channel of the product.

    offerId

    string

    Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the products data specification for details.

    contentLanguage

    string

    Required. Immutable. The two-letter ISO 639-1 language code for the product.

    feedLabel

    string

    Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are A-Z , 0-9 , hyphen, and underscore. The feed label must not include any spaces. For more information, see Using feed labels .

    attributes

    object ( Attributes )

    Optional. A list of product attributes.

    customAttributes[]

    object ( CustomAttribute )

    Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" } ). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.

    versionNumber

    string ( int64 format)

    Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time.

    If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current versionNumber .

    Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources.

    If the operation is prevented, the aborted exception will be thrown.

    Methods

    delete

    		Deletes a product input from your Merchant Center account.

    insert

    		Uploads a product input to your Merchant Center account .

    patch

    		Updates the existing product input in your Merchant Center account.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: