Package com.google.cloud.recommendationengine.v1beta1

Interface EventDetailOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    EventDetail, EventDetail.Builder
    public interface EventDetailOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getUri

        String getUri()
         Optional. Complete url (window.location.href) of the user's current page.
 When using the JavaScript pixel, this value is filled in automatically.
 Maximum length 5KB.
        string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The uri.

      • getUriBytes

        com.google.protobuf.ByteString getUriBytes()
         Optional. Complete url (window.location.href) of the user's current page.
 When using the JavaScript pixel, this value is filled in automatically.
 Maximum length 5KB.
        string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for uri.

      • getReferrerUri

        String getReferrerUri()
         Optional. The referrer url of the current page. When using
 the JavaScript pixel, this value is filled in automatically.
        string referrer_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The referrerUri.

      • getReferrerUriBytes

        com.google.protobuf.ByteString getReferrerUriBytes()
         Optional. The referrer url of the current page. When using
 the JavaScript pixel, this value is filled in automatically.
        string referrer_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for referrerUri.

      • getPageViewId

        String getPageViewId()
         Optional. A unique id of a web page view.
 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page.
 The `pageViewId` property should be kept the same for all these events so
 that they can be grouped together properly. This `pageViewId` will be
 automatically generated if using the JavaScript pixel.
        string page_view_id = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageViewId.

      • getPageViewIdBytes

        com.google.protobuf.ByteString getPageViewIdBytes()
         Optional. A unique id of a web page view.
 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page.
 The `pageViewId` property should be kept the same for all these events so
 that they can be grouped together properly. This `pageViewId` will be
 automatically generated if using the JavaScript pixel.
        string page_view_id = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for pageViewId.

      • getExperimentIdsList

        List<String> getExperimentIdsList()
         Optional. A list of identifiers for the independent experiment groups
 this user event belongs to. This is used to distinguish between user events
 associated with different experiment setups (e.g. using Recommendation
 Engine system, using different recommendation models).
        repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the experimentIds.

      • getExperimentIdsCount

        int getExperimentIdsCount()
         Optional. A list of identifiers for the independent experiment groups
 this user event belongs to. This is used to distinguish between user events
 associated with different experiment setups (e.g. using Recommendation
 Engine system, using different recommendation models).
        repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of experimentIds.

      • getExperimentIds

        String getExperimentIds​(int index)
         Optional. A list of identifiers for the independent experiment groups
 this user event belongs to. This is used to distinguish between user events
 associated with different experiment setups (e.g. using Recommendation
 Engine system, using different recommendation models).
        repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The experimentIds at the given index.

      • getExperimentIdsBytes

        com.google.protobuf.ByteString getExperimentIdsBytes​(int index)
         Optional. A list of identifiers for the independent experiment groups
 this user event belongs to. This is used to distinguish between user events
 associated with different experiment setups (e.g. using Recommendation
 Engine system, using different recommendation models).
        repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experimentIds at the given index.

      • getRecommendationToken

        String getRecommendationToken()
         Optional. Recommendation token included in the recommendation prediction
 response.

 This field enables accurate attribution of recommendation model
 performance.

 This token enables us to accurately attribute page view or purchase back to
 the event and the particular predict response containing this
 clicked/purchased item. If user clicks on product K in the recommendation
 results, pass the `PredictResponse.recommendationToken` property as a url
 parameter to product K's page. When recording events on product K's page,
 log the PredictResponse.recommendation_token to this field.

 Optional, but highly encouraged for user events that are the result of a
 recommendation prediction query.
        string recommendation_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The recommendationToken.

      • getRecommendationTokenBytes

        com.google.protobuf.ByteString getRecommendationTokenBytes()
         Optional. Recommendation token included in the recommendation prediction
 response.

 This field enables accurate attribution of recommendation model
 performance.

 This token enables us to accurately attribute page view or purchase back to
 the event and the particular predict response containing this
 clicked/purchased item. If user clicks on product K in the recommendation
 results, pass the `PredictResponse.recommendationToken` property as a url
 parameter to product K's page. When recording events on product K's page,
 log the PredictResponse.recommendation_token to this field.

 Optional, but highly encouraged for user events that are the result of a
 recommendation prediction query.
        string recommendation_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for recommendationToken.

      • hasEventAttributes

        boolean hasEventAttributes()
         Optional. Extra user event features to include in the recommendation
 model.

 For product recommendation, an example of extra user information is
 traffic_channel, i.e. how user arrives at the site. Users can arrive
 at the site by coming to the site directly, or coming through Google
 search, and etc.
        .google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the eventAttributes field is set.

      • getEventAttributes

        FeatureMap getEventAttributes()
         Optional. Extra user event features to include in the recommendation
 model.

 For product recommendation, an example of extra user information is
 traffic_channel, i.e. how user arrives at the site. Users can arrive
 at the site by coming to the site directly, or coming through Google
 search, and etc.
        .google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The eventAttributes.

      • getEventAttributesOrBuilder

        FeatureMapOrBuilder getEventAttributesOrBuilder()
         Optional. Extra user event features to include in the recommendation
 model.

 For product recommendation, an example of extra user information is
 traffic_channel, i.e. how user arrives at the site. Users can arrive
 at the site by coming to the site directly, or coming through Google
 search, and etc.
        .google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];