Retail V2 API - Class Google::Cloud::Retail::V2::ProductLevelConfig (v0.8.0)

Version 0.8.0

• 0.20.0 (latest)
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.1
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.4

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ProductLevelConfig.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#ingestion_product_type

def ingestion_product_type() -> ::String

Returns

• (::String) — The type of Products allowed to be ingested into the catalog. Acceptable values are:
  • primary (default): You can ingest Products of all types. When ingesting a Product, its type will default to Product.Type.PRIMARY if unset.
  • variant (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means 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 is itemGroupId, an INVALID_ARGUMENT error is returned.

  See Product levels for more details.

#ingestion_product_type=

def ingestion_product_type=(value) -> ::String

Parameter

• value (::String) — The type of Products allowed to be ingested into the catalog. Acceptable values are:
  • primary (default): You can ingest Products of all types. When ingesting a Product, its type will default to Product.Type.PRIMARY if unset.
  • variant (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means 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 is itemGroupId, an INVALID_ARGUMENT error is returned.

  See Product levels for more details.

Returns

• (::String) — The type of Products allowed to be ingested into the catalog. Acceptable values are:
  • primary (default): You can ingest Products of all types. When ingesting a Product, its type will default to Product.Type.PRIMARY if unset.
  • variant (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means 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 is itemGroupId, an INVALID_ARGUMENT error is returned.

  See Product levels for more details.

#merchant_center_product_id_field

def merchant_center_product_id_field() -> ::String

Returns

• (::String) — Which field of Merchant Center Product should be imported as 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 is variant, an INVALID_ARGUMENT error is returned.

  See Product levels for more details.

#merchant_center_product_id_field=

def merchant_center_product_id_field=(value) -> ::String

Parameter

• value (::String) — Which field of Merchant Center Product should be imported as 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 is variant, an INVALID_ARGUMENT error is returned.

  See Product levels for more details.

Returns

• (::String) — Which field of Merchant Center Product should be imported as 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 is variant, an INVALID_ARGUMENT error is returned.

  See Product levels for more details.