Package com.google.cloud.retail.v2alpha

Interface ProductLevelConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ProductLevelConfig, ProductLevelConfig.Builder
@Generated public interface ProductLevelConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getIngestionProductType()
    The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be ingested into the catalog.
    com.google.protobuf.ByteString
    getIngestionProductTypeBytes()
    The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be ingested into the catalog.
    String
    getMerchantCenterProductIdField()
    Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2alpha.Product.id].
    com.google.protobuf.ByteString
    getMerchantCenterProductIdFieldBytes()
    Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2alpha.Product.id].

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getIngestionProductType

      String getIngestionProductType()
       The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
 ingested into the catalog. Acceptable values are:

 * `primary` (default): You can ingest
 [Product][google.cloud.retail.v2alpha.Product]s of all types. When
 ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
 default to
 [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
 if unset.
 * `variant` (incompatible with Retail Search): You can only
 ingest
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s. This means
 [Product.primary_product_id][google.cloud.retail.v2alpha.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.v2alpha.ProductLevelConfig.merchant_center_product_id_field]
 is `itemGroupId`, an INVALID_ARGUMENT error is returned.

 See [Product
 levels](https://cloud.google.com/retail/docs/catalog#product-levels)
 for more details.
      string ingestion_product_type = 1;
      Returns:
      The ingestionProductType.

    • getIngestionProductTypeBytes

      com.google.protobuf.ByteString getIngestionProductTypeBytes()
       The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
 ingested into the catalog. Acceptable values are:

 * `primary` (default): You can ingest
 [Product][google.cloud.retail.v2alpha.Product]s of all types. When
 ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
 default to
 [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
 if unset.
 * `variant` (incompatible with Retail Search): You can only
 ingest
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s. This means
 [Product.primary_product_id][google.cloud.retail.v2alpha.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.v2alpha.ProductLevelConfig.merchant_center_product_id_field]
 is `itemGroupId`, an INVALID_ARGUMENT error is returned.

 See [Product
 levels](https://cloud.google.com/retail/docs/catalog#product-levels)
 for more details.
      string ingestion_product_type = 1;
      Returns:
      The bytes for ingestionProductType.

    • getMerchantCenterProductIdField

      String getMerchantCenterProductIdField()
       Which field of [Merchant Center
 Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
 imported as [Product.id][google.cloud.retail.v2alpha.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.v2alpha.ProductLevelConfig.ingestion_product_type]
 is `variant`, an INVALID_ARGUMENT error is returned.

 See [Product
 levels](https://cloud.google.com/retail/docs/catalog#product-levels)
 for more details.
      string merchant_center_product_id_field = 2;
      Returns:
      The merchantCenterProductIdField.

    • getMerchantCenterProductIdFieldBytes

      com.google.protobuf.ByteString getMerchantCenterProductIdFieldBytes()
       Which field of [Merchant Center
 Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
 imported as [Product.id][google.cloud.retail.v2alpha.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.v2alpha.ProductLevelConfig.ingestion_product_type]
 is `variant`, an INVALID_ARGUMENT error is returned.

 See [Product
 levels](https://cloud.google.com/retail/docs/catalog#product-levels)
 for more details.
      string merchant_center_product_id_field = 2;
      Returns:
      The bytes for merchantCenterProductIdField.