Package com.google.cloud.retail.v2alpha

Interface Model.PageOptimizationConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Model.PageOptimizationConfig, Model.PageOptimizationConfig.Builder
Enclosing class:
Model
public static interface Model.PageOptimizationConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getPageOptimizationEventType

      String getPageOptimizationEventType()
       Required. The type of [UserEvent][google.cloud.retail.v2alpha.UserEvent]
 this page optimization is shown for.

 Each page has an associated event type - this will be the
 corresponding event type for the page that the page optimization
 model is used on.

 Supported types:

 * `add-to-cart`: Products being added to cart.
 * `detail-page-view`: Products detail page viewed.
 * `home-page-view`: Homepage viewed
 * `category-page-view`: Homepage viewed
 * `shopping-cart-page-view`: User viewing a shopping cart.

 `home-page-view` only allows models with type `recommended-for-you`.
 All other page_optimization_event_type allow all
 [Model.types][google.cloud.retail.v2alpha.Model.type].
      string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The pageOptimizationEventType.

    • getPageOptimizationEventTypeBytes

      com.google.protobuf.ByteString getPageOptimizationEventTypeBytes()
       Required. The type of [UserEvent][google.cloud.retail.v2alpha.UserEvent]
 this page optimization is shown for.

 Each page has an associated event type - this will be the
 corresponding event type for the page that the page optimization
 model is used on.

 Supported types:

 * `add-to-cart`: Products being added to cart.
 * `detail-page-view`: Products detail page viewed.
 * `home-page-view`: Homepage viewed
 * `category-page-view`: Homepage viewed
 * `shopping-cart-page-view`: User viewing a shopping cart.

 `home-page-view` only allows models with type `recommended-for-you`.
 All other page_optimization_event_type allow all
 [Model.types][google.cloud.retail.v2alpha.Model.type].
      string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for pageOptimizationEventType.

    • getPanelsList

      List<Model.PageOptimizationConfig.Panel> getPanelsList()
       Required. A list of panel configurations.

 Limit = 5.
      repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];

    • getPanels

      Model.PageOptimizationConfig.Panel getPanels(int index)
       Required. A list of panel configurations.

 Limit = 5.
      repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];

    • getPanelsCount

      int getPanelsCount()
       Required. A list of panel configurations.

 Limit = 5.
      repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];

    • getPanelsOrBuilderList

      List<? extends Model.PageOptimizationConfig.PanelOrBuilder> getPanelsOrBuilderList()
       Required. A list of panel configurations.

 Limit = 5.
      repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];

    • getPanelsOrBuilder

      Model.PageOptimizationConfig.PanelOrBuilder getPanelsOrBuilder(int index)
       Required. A list of panel configurations.

 Limit = 5.
      repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];

    • getRestrictionValue

      int getRestrictionValue()
       Optional. How to restrict results across panels e.g. can the same
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] be shown on
 multiple panels at once.

 If unspecified, default to `UNIQUE_MODEL_RESTRICTION`.
      .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Restriction restriction = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for restriction.

    • getRestriction

      Model.PageOptimizationConfig.Restriction getRestriction()
       Optional. How to restrict results across panels e.g. can the same
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] be shown on
 multiple panels at once.

 If unspecified, default to `UNIQUE_MODEL_RESTRICTION`.
      .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Restriction restriction = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The restriction.