ShoppingProduct

A shopping product from Google Merchant Center that can be advertised by campaigns.

The resource returns currently existing products from Google Merchant Center accounts linked with the customer. A campaign includes a product by specifying its merchant id (or, if available, the Multi Client Account id of the merchant) in the ShoppingSetting, and can limit the inclusion to products having a specified feed label. Standard Shopping campaigns can also limit the inclusion through a campaign_criterion.listing_scope.

Queries to this resource specify a scope: Account: - Filters on campaigns or ad groups are not specified. - All products from the linked Google Merchant Center accounts are returned. - Metrics and some fields (see the per-field documentation) are aggregated across all Shopping and Performance Max campaigns that include a product. Campaign: - An equality filter on campaign is specified. Supported campaign types are Shopping, Performance Max, Demand Gen, Video. - Only products that are included by the specified campaign are returned. - Metrics and some fields (see the per-field documentation) are restricted to the specified campaign. Ad group: - An equality filter on ad group and campaign is specified. Supported campaign types are Shopping, Demand Gen, Video. - Only products that are included by the specified campaign are returned. - Metrics and some fields (see the per-field documentation) are restricted to the specified ad group. Note that segmentation by date segments is not permitted and will return UNSUPPORTED_DATE_SEGMENTATION error. On the other hand, filtering on date segments is allowed.

Fields

resource_name

string

Output only. The resource name of the shopping product. Shopping product resource names have the form:

customers/{customer_id}/shoppingProducts/{merchant_center_id}~{channel}~{language_code}~{feed_label}~{item_id}

merchant_center_id

int64

Output only. The id of the merchant that owns the product.

channel

ProductChannel

Output only. The product channel describing the locality of the product.

language_code

string

Output only. The language code as provided by the merchant, in BCP 47 format.

feed_label

string

Output only. The product feed label as provided by the merchant.

item_id

string

Output only. The item id of the product as provided by the merchant.

target_countries[]

string

Output only. Upper-case two-letter ISO 3166-1 code of the regions where the product is intended to be shown in ads.

status

ProductStatus

Output only. The status that indicates whether the product can show in ads. The value of this field is restricted to the scope specified in the query, see the documentation of the resource. This field can take up to 24 hours to update.

issues[]

ProductIssue

Output only. The list of issues affecting whether the product can show in ads. The value of this field is restricted to the scope specified in the query, see the documentation of the resource. This field can take up to 24 hours to update.

multi_client_account_id

int64

Output only. The id of the Multi Client Account of the merchant, if present.

title

string

Output only. The title of the product as provided by the merchant.

brand

string

Output only. The brand of the product as provided by the merchant.

price_micros

int64

Output only. The price of the product in micros as provided by the merchant, in the currency specified in currency_code (e.g. $2.97 is reported as 2970000).

currency_code

string

Output only. The currency code as provided by the merchant, in ISO 4217 format.

channel_exclusivity

ProductChannelExclusivity

Output only. The channel exclusivity of the product as provided by the merchant.

condition

ProductCondition

Output only. The condition of the product as provided by the merchant.

availability

ProductAvailability

Output only. The availability of the product as provided by the merchant.

custom_attribute0

string

Output only. The custom attribute 0 of the product as provided by the merchant.

custom_attribute1

string

Output only. The custom attribute 1 of the product as provided by the merchant.

custom_attribute2

string

Output only. The custom attribute 2 of the product as provided by the merchant.

custom_attribute3

string

Output only. The custom attribute 3 of the product as provided by the merchant.

custom_attribute4

string

Output only. The custom attribute 4 of the product as provided by the merchant.

category_level1

string

Output only. The category level 1 of the product.

category_level2

string

Output only. The category level 2 of the product.

category_level3

string

Output only. The category level 3 of the product.

category_level4

string

Output only. The category level 4 of the product.

category_level5

string

Output only. The category level 5 of the product.

product_type_level1

string

Output only. The product type level 1 as provided by the merchant.

product_type_level2

string

Output only. The product type level 2 as provided by the merchant.

product_type_level3

string

Output only. The product type level 3 as provided by the merchant.

product_type_level4

string

Output only. The product type level 4 as provided by the merchant.

product_type_level5

string

Output only. The product type level 5 as provided by the merchant.

effective_max_cpc_micros

int64

Output only. The effective maximum cost-per-click (effective max. CPC) of the product. This field is available only if the query specifies the campaign or ad group scope, and if the campaign uses manual bidding. The value is the highest bid set for the product in product groups across all enabled ad groups. It represents the most you're willing to pay for a click on the product. This field can take up to 24 hours to update.

campaign

string

Output only. A campaign that includes the product. This field is selectable only in the campaign scope, which requires an equality filter on campaign.

ad_group

string

Output only. An ad group of a campaign that includes the product. This field is selectable only in the ad group scope, which requires an equality filter on campaign and ad_group.