Google Cloud Retail V2 Client - Class ProductLevelConfig (1.6.3)

Version latest

• 1.6.3 (latest)
• 1.6.2
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.1

Reference documentation and code samples for the Google Cloud Retail V2 Client 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.

Generated from protobuf message google.cloud.retail.v2.ProductLevelConfig

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ ingestion_product_type	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	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.

getIngestionProductType

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
Type	Description
string

setIngestionProductType

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMerchantCenterProductIdField

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
Type	Description
string

setMerchantCenterProductIdField

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this