Package com.google.cloud.retail.v2alpha

Interface UserInfoOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getDirectUserRequest()
      True if the request is made directly from the end user, in which case the [ip_address][google.cloud.retail.v2alpha.UserInfo.ip_address] and [user_agent][google.cloud.retail.v2alpha.UserInfo.user_agent] can be populated from the HTTP request.
      String getIpAddress()
      The end user's IP address.
      com.google.protobuf.ByteString getIpAddressBytes()
      The end user's IP address.
      String getUserAgent()
      User agent as included in the HTTP header.
      com.google.protobuf.ByteString getUserAgentBytes()
      User agent as included in the HTTP header.
      String getUserId()
      Highly recommended for logged-in users.
      com.google.protobuf.ByteString getUserIdBytes()
      Highly recommended for logged-in users.

      • 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 Detail

      • getUserId

        String getUserId()
         Highly recommended for logged-in users. Unique identifier for logged-in
 user, such as a user name. Don't set for anonymous users.

 Always use a hashed value for this ID.

 Don't set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded
 model quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string user_id = 1;
        Returns:
        The userId.

      • getUserIdBytes

        com.google.protobuf.ByteString getUserIdBytes()
         Highly recommended for logged-in users. Unique identifier for logged-in
 user, such as a user name. Don't set for anonymous users.

 Always use a hashed value for this ID.

 Don't set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded
 model quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string user_id = 1;
        Returns:
        The bytes for userId.

      • getIpAddress

        String getIpAddress()
         The end user's IP address. This field is used to extract location
 information for personalization.

 This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
 INVALID_ARGUMENT error is returned.

 This should not be set when:

 * setting
 [SearchRequest.user_info][google.cloud.retail.v2alpha.SearchRequest.user_info].
 * using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
 or if
 [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
 is set.
        string ip_address = 2;
        Returns:
        The ipAddress.

      • getIpAddressBytes

        com.google.protobuf.ByteString getIpAddressBytes()
         The end user's IP address. This field is used to extract location
 information for personalization.

 This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
 INVALID_ARGUMENT error is returned.

 This should not be set when:

 * setting
 [SearchRequest.user_info][google.cloud.retail.v2alpha.SearchRequest.user_info].
 * using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
 or if
 [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
 is set.
        string ip_address = 2;
        Returns:
        The bytes for ipAddress.

      • getUserAgent

        String getUserAgent()
         User agent as included in the HTTP header. Required for getting
 [SearchResponse.sponsored_results][google.cloud.retail.v2alpha.SearchResponse.sponsored_results].

 The field must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 This should not be set when using the client side event reporting with
 GTM or JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
 or if
 [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
 is set.
        string user_agent = 3;
        Returns:
        The userAgent.

      • getUserAgentBytes

        com.google.protobuf.ByteString getUserAgentBytes()
         User agent as included in the HTTP header. Required for getting
 [SearchResponse.sponsored_results][google.cloud.retail.v2alpha.SearchResponse.sponsored_results].

 The field must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 This should not be set when using the client side event reporting with
 GTM or JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
 or if
 [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
 is set.
        string user_agent = 3;
        Returns:
        The bytes for userAgent.

      • getDirectUserRequest

        boolean getDirectUserRequest()
         True if the request is made directly from the end user, in which case the
 [ip_address][google.cloud.retail.v2alpha.UserInfo.ip_address] and
 [user_agent][google.cloud.retail.v2alpha.UserInfo.user_agent] can be
 populated from the HTTP request. This flag should be set only if the API
 request is made directly from the end user such as a mobile app (and not if
 a gateway or a server is processing and pushing the user events).

 This should not be set when using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent].
        bool direct_user_request = 4;
        Returns:
        The directUserRequest.