Show / Hide Table of Contents

Class GoogleAdsSearchads360V23ResourcesShoppingProduct

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, App. - 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. - Only the following metrics are supported for Demand Gen, Video, App campaigns: impressions, clicks, ctr. * Ad group: - An equality filter on ad_group and campaign is specified. Supported campaign types are Shopping, Demand Gen, Video, App. - 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. - Only the following metrics are supported for Demand Gen, Video, App campaigns: impressions, clicks, ctr. 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.

Inheritance
object
GoogleAdsSearchads360V23ResourcesShoppingProduct
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.SA360.v23.Data
Assembly: Google.Apis.SA360.v23.dll
Syntax
public class GoogleAdsSearchads360V23ResourcesShoppingProduct : IDirectResponseSchema

Properties

AdGroup

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.

Declaration
[JsonProperty("adGroup")]
public virtual string AdGroup { get; set; }
Property Value
Type Description
string

Availability

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

Declaration
[JsonProperty("availability")]
public virtual string Availability { get; set; }
Property Value
Type Description
string

Brand

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

Declaration
[JsonProperty("brand")]
public virtual string Brand { get; set; }
Property Value
Type Description
string

Campaign

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

Declaration
[JsonProperty("campaign")]
public virtual string Campaign { get; set; }
Property Value
Type Description
string

CategoryLevel1

Output only. The category level 1 of the product.

Declaration
[JsonProperty("categoryLevel1")]
public virtual string CategoryLevel1 { get; set; }
Property Value
Type Description
string

CategoryLevel2

Output only. The category level 2 of the product.

Declaration
[JsonProperty("categoryLevel2")]
public virtual string CategoryLevel2 { get; set; }
Property Value
Type Description
string

CategoryLevel3

Output only. The category level 3 of the product.

Declaration
[JsonProperty("categoryLevel3")]
public virtual string CategoryLevel3 { get; set; }
Property Value
Type Description
string

CategoryLevel4

Output only. The category level 4 of the product.

Declaration
[JsonProperty("categoryLevel4")]
public virtual string CategoryLevel4 { get; set; }
Property Value
Type Description
string

CategoryLevel5

Output only. The category level 5 of the product.

Declaration
[JsonProperty("categoryLevel5")]
public virtual string CategoryLevel5 { get; set; }
Property Value
Type Description
string

Channel

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

Declaration
[JsonProperty("channel")]
public virtual string Channel { get; set; }
Property Value
Type Description
string

ChannelExclusivity

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

Declaration
[JsonProperty("channelExclusivity")]
public virtual string ChannelExclusivity { get; set; }
Property Value
Type Description
string

Condition

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

Declaration
[JsonProperty("condition")]
public virtual string Condition { get; set; }
Property Value
Type Description
string

CurrencyCode

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

Declaration
[JsonProperty("currencyCode")]
public virtual string CurrencyCode { get; set; }
Property Value
Type Description
string

CustomAttribute0

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

Declaration
[JsonProperty("customAttribute0")]
public virtual string CustomAttribute0 { get; set; }
Property Value
Type Description
string

CustomAttribute1

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

Declaration
[JsonProperty("customAttribute1")]
public virtual string CustomAttribute1 { get; set; }
Property Value
Type Description
string

CustomAttribute2

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

Declaration
[JsonProperty("customAttribute2")]
public virtual string CustomAttribute2 { get; set; }
Property Value
Type Description
string

CustomAttribute3

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

Declaration
[JsonProperty("customAttribute3")]
public virtual string CustomAttribute3 { get; set; }
Property Value
Type Description
string

CustomAttribute4

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

Declaration
[JsonProperty("customAttribute4")]
public virtual string CustomAttribute4 { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EffectiveMaxCpcMicros

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.

Declaration
[JsonProperty("effectiveMaxCpcMicros")]
public virtual long? EffectiveMaxCpcMicros { get; set; }
Property Value
Type Description
long?

FeedLabel

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

Declaration
[JsonProperty("feedLabel")]
public virtual string FeedLabel { get; set; }
Property Value
Type Description
string

Issues

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. This field is not supported for App campaigns.

Declaration
[JsonProperty("issues")]
public virtual IList<GoogleAdsSearchads360V23ResourcesShoppingProductProductIssue> Issues { get; set; }
Property Value
Type Description
IList<GoogleAdsSearchads360V23ResourcesShoppingProductProductIssue>

ItemId

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

Declaration
[JsonProperty("itemId")]
public virtual string ItemId { get; set; }
Property Value
Type Description
string

LanguageCode

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

Declaration
[JsonProperty("languageCode")]
public virtual string LanguageCode { get; set; }
Property Value
Type Description
string

MerchantCenterId

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

Declaration
[JsonProperty("merchantCenterId")]
public virtual long? MerchantCenterId { get; set; }
Property Value
Type Description
long?

MultiClientAccountId

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

Declaration
[JsonProperty("multiClientAccountId")]
public virtual long? MultiClientAccountId { get; set; }
Property Value
Type Description
long?

PriceMicros

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).

Declaration
[JsonProperty("priceMicros")]
public virtual long? PriceMicros { get; set; }
Property Value
Type Description
long?

ProductImageUri

Output only. The URI of the product image as provided by the merchant.

Declaration
[JsonProperty("productImageUri")]
public virtual string ProductImageUri { get; set; }
Property Value
Type Description
string

ProductTypeLevel1

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

Declaration
[JsonProperty("productTypeLevel1")]
public virtual string ProductTypeLevel1 { get; set; }
Property Value
Type Description
string

ProductTypeLevel2

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

Declaration
[JsonProperty("productTypeLevel2")]
public virtual string ProductTypeLevel2 { get; set; }
Property Value
Type Description
string

ProductTypeLevel3

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

Declaration
[JsonProperty("productTypeLevel3")]
public virtual string ProductTypeLevel3 { get; set; }
Property Value
Type Description
string

ProductTypeLevel4

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

Declaration
[JsonProperty("productTypeLevel4")]
public virtual string ProductTypeLevel4 { get; set; }
Property Value
Type Description
string

ProductTypeLevel5

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

Declaration
[JsonProperty("productTypeLevel5")]
public virtual string ProductTypeLevel5 { get; set; }
Property Value
Type Description
string

ResourceName

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}

Declaration
[JsonProperty("resourceName")]
public virtual string ResourceName { get; set; }
Property Value
Type Description
string

Status

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. This field is not supported for App campaigns.

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

TargetCountries

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

Declaration
[JsonProperty("targetCountries")]
public virtual IList<string> TargetCountries { get; set; }
Property Value
Type Description
IList<string>

Title

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

Declaration
[JsonProperty("title")]
public virtual string Title { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX