Package com.google.cloud.recommendationengine.v1beta1

Class EventDetail

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.recommendationengine.v1beta1.EventDetail
All Implemented Interfaces:
EventDetailOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class EventDetail extends com.google.protobuf.GeneratedMessage implements EventDetailOrBuilder
 User event details shared by all recommendation types.
Protobuf type google.cloud.recommendationengine.v1beta1.EventDetail
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    EventDetail.Builder
    User event details shared by all recommendation types.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EVENT_ATTRIBUTES_FIELD_NUMBER
     
    static final int
    EXPERIMENT_IDS_FIELD_NUMBER
     
    static final int
    PAGE_VIEW_ID_FIELD_NUMBER
     
    static final int
    RECOMMENDATION_TOKEN_FIELD_NUMBER
     
    static final int
    REFERRER_URI_FIELD_NUMBER
     
    static final int
    URI_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static EventDetail
    getDefaultInstance()
     
    EventDetail
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    FeatureMap
    getEventAttributes()
    Optional.
    FeatureMapOrBuilder
    getEventAttributesOrBuilder()
    Optional.
    String
    getExperimentIds(int index)
    Optional.
    com.google.protobuf.ByteString
    getExperimentIdsBytes(int index)
    Optional.
    int
    getExperimentIdsCount()
    Optional.
    com.google.protobuf.ProtocolStringList
    getExperimentIdsList()
    Optional.
    String
    getPageViewId()
    Optional.
    com.google.protobuf.ByteString
    getPageViewIdBytes()
    Optional.
    com.google.protobuf.Parser<EventDetail>
    getParserForType()
     
    String
    getRecommendationToken()
    Optional.
    com.google.protobuf.ByteString
    getRecommendationTokenBytes()
    Optional.
    String
    getReferrerUri()
    Optional.
    com.google.protobuf.ByteString
    getReferrerUriBytes()
    Optional.
    int
    getSerializedSize()
     
    String
    getUri()
    Optional.
    com.google.protobuf.ByteString
    getUriBytes()
    Optional.
    boolean
    hasEventAttributes()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EventDetail.Builder
    newBuilder()
     
    static EventDetail.Builder
    newBuilder(EventDetail prototype)
     
    EventDetail.Builder
    newBuilderForType()
     
    protected EventDetail.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static EventDetail
    parseDelimitedFrom(InputStream input)
     
    static EventDetail
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventDetail
    parseFrom(byte[] data)
     
    static EventDetail
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventDetail
    parseFrom(com.google.protobuf.ByteString data)
     
    static EventDetail
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventDetail
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EventDetail
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventDetail
    parseFrom(InputStream input)
     
    static EventDetail
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventDetail
    parseFrom(ByteBuffer data)
     
    static EventDetail
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EventDetail>
    parser()
     
    EventDetail.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • URI_FIELD_NUMBER

      public static final int URI_FIELD_NUMBER
      See Also:

    • REFERRER_URI_FIELD_NUMBER

      public static final int REFERRER_URI_FIELD_NUMBER
      See Also:

    • PAGE_VIEW_ID_FIELD_NUMBER

      public static final int PAGE_VIEW_ID_FIELD_NUMBER
      See Also:

    • EXPERIMENT_IDS_FIELD_NUMBER

      public static final int EXPERIMENT_IDS_FIELD_NUMBER
      See Also:

    • RECOMMENDATION_TOKEN_FIELD_NUMBER

      public static final int RECOMMENDATION_TOKEN_FIELD_NUMBER
      See Also:

    • EVENT_ATTRIBUTES_FIELD_NUMBER

      public static final int EVENT_ATTRIBUTES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getUri

      public 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];
      Specified by:
      getUri in interface EventDetailOrBuilder
      Returns:
      The uri.

    • getUriBytes

      public 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];
      Specified by:
      getUriBytes in interface EventDetailOrBuilder
      Returns:
      The bytes for uri.

    • getReferrerUri

      public 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];
      Specified by:
      getReferrerUri in interface EventDetailOrBuilder
      Returns:
      The referrerUri.

    • getReferrerUriBytes

      public 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];
      Specified by:
      getReferrerUriBytes in interface EventDetailOrBuilder
      Returns:
      The bytes for referrerUri.

    • getPageViewId

      public 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];
      Specified by:
      getPageViewId in interface EventDetailOrBuilder
      Returns:
      The pageViewId.

    • getPageViewIdBytes

      public 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];
      Specified by:
      getPageViewIdBytes in interface EventDetailOrBuilder
      Returns:
      The bytes for pageViewId.

    • getExperimentIdsList

      public com.google.protobuf.ProtocolStringList 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];
      Specified by:
      getExperimentIdsList in interface EventDetailOrBuilder
      Returns:
      A list containing the experimentIds.

    • getExperimentIdsCount

      public 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];
      Specified by:
      getExperimentIdsCount in interface EventDetailOrBuilder
      Returns:
      The count of experimentIds.

    • getExperimentIds

      public 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];
      Specified by:
      getExperimentIds in interface EventDetailOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The experimentIds at the given index.

    • getExperimentIdsBytes

      public 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];
      Specified by:
      getExperimentIdsBytes in interface EventDetailOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the experimentIds at the given index.

    • getRecommendationToken

      public 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];
      Specified by:
      getRecommendationToken in interface EventDetailOrBuilder
      Returns:
      The recommendationToken.

    • getRecommendationTokenBytes

      public 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];
      Specified by:
      getRecommendationTokenBytes in interface EventDetailOrBuilder
      Returns:
      The bytes for recommendationToken.

    • hasEventAttributes

      public 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];
      Specified by:
      hasEventAttributes in interface EventDetailOrBuilder
      Returns:
      Whether the eventAttributes field is set.

    • getEventAttributes

      public 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];
      Specified by:
      getEventAttributes in interface EventDetailOrBuilder
      Returns:
      The eventAttributes.

    • getEventAttributesOrBuilder

      public 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];
      Specified by:
      getEventAttributesOrBuilder in interface EventDetailOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static EventDetail parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventDetail parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventDetail parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventDetail parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventDetail parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventDetail parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventDetail parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventDetail parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EventDetail parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EventDetail parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventDetail parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventDetail parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public EventDetail.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static EventDetail.Builder newBuilder()

    • newBuilder

      public static EventDetail.Builder newBuilder(EventDetail prototype)

    • toBuilder

      public EventDetail.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected EventDetail.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static EventDetail getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EventDetail> parser()

    • getParserForType

      public com.google.protobuf.Parser<EventDetail> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public EventDetail getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder