Retail v2 API - Class ProductLevelConfig (2.8.0)

public sealed class ProductLevelConfig : IMessage<ProductLevelConfig>, IEquatable<ProductLevelConfig>, IDeepCloneable<ProductLevelConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class ProductLevelConfig.

Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

Inheritance

object > ProductLevelConfig

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ProductLevelConfig()

public ProductLevelConfig()

ProductLevelConfig(ProductLevelConfig)

public ProductLevelConfig(ProductLevelConfig other)
Parameter
NameDescription
otherProductLevelConfig

Properties

IngestionProductType

public string IngestionProductType { get; set; }

The type of [Product][google.cloud.retail.v2.Product]s allowed to be ingested into the catalog. Acceptable values are:

  • primary (default): You can ingest [Product][google.cloud.retail.v2.Product]s of all types. When ingesting a [Product][google.cloud.retail.v2.Product], its type will default to [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] if unset.
  • variant (incompatible with Retail Search): You can only ingest [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s. This means [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id] cannot be empty.

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

If this field is variant and [merchant_center_product_id_field][google.cloud.retail.v2.ProductLevelConfig.merchant_center_product_id_field] is itemGroupId, an INVALID_ARGUMENT error is returned.

See Product levels for more details.

Property Value
TypeDescription
string

MerchantCenterProductIdField

public string MerchantCenterProductIdField { get; set; }

Which field of Merchant Center Product should be imported as [Product.id][google.cloud.retail.v2.Product.id]. Acceptable values are:

  • offerId (default): Import offerId as the product ID.
  • itemGroupId: Import itemGroupId as the product ID. Notice that Retail API will choose one item from the ones with the same itemGroupId, and use it to represent the item group.

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

If this field is itemGroupId and [ingestion_product_type][google.cloud.retail.v2.ProductLevelConfig.ingestion_product_type] is variant, an INVALID_ARGUMENT error is returned.

See Product levels for more details.

Property Value
TypeDescription
string