Package com.google.cloud.recommendationengine.v1beta1

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 Detail

      • getVisitorId

        String getVisitorId()
         Required. A unique identifier for tracking visitors with a length limit of
 128 bytes.

 For example, this could be implemented with a http cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.
 Maximum length 128 bytes. Cannot be empty.
        string visitor_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The visitorId.

      • getVisitorIdBytes

        com.google.protobuf.ByteString getVisitorIdBytes()
         Required. A unique identifier for tracking visitors with a length limit of
 128 bytes.

 For example, this could be implemented with a http cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.
 Maximum length 128 bytes. Cannot be empty.
        string visitor_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for visitorId.

      • getUserId

        String getUserId()
         Optional. Unique identifier for logged-in user with a length limit of 128
 bytes. Required only for logged-in users.
        string user_id = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The userId.

      • getUserIdBytes

        com.google.protobuf.ByteString getUserIdBytes()
         Optional. Unique identifier for logged-in user with a length limit of 128
 bytes. Required only for logged-in users.
        string user_id = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for userId.

      • getIpAddress

        String getIpAddress()
         Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or
 IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be
 set when using the javascript pixel or if `direct_user_request` is set.
 Used to extract location information for personalization.
        string ip_address = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The ipAddress.

      • getIpAddressBytes

        com.google.protobuf.ByteString getIpAddressBytes()
         Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or
 IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be
 set when using the javascript pixel or if `direct_user_request` is set.
 Used to extract location information for personalization.
        string ip_address = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for ipAddress.

      • getUserAgent

        String getUserAgent()
         Optional. User agent as included in the HTTP header. UTF-8 encoded string
 with a length limit of 1 KiB.

 This should *not* be set when using the JavaScript pixel or if
 `directUserRequest` is set.
        string user_agent = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The userAgent.

      • getUserAgentBytes

        com.google.protobuf.ByteString getUserAgentBytes()
         Optional. User agent as included in the HTTP header. UTF-8 encoded string
 with a length limit of 1 KiB.

 This should *not* be set when using the JavaScript pixel or if
 `directUserRequest` is set.
        string user_agent = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for userAgent.

      • getDirectUserRequest

        boolean getDirectUserRequest()
         Optional. Indicates if the request is made directly from the end user
 in which case the user_agent and ip_address fields can be populated
 from the HTTP request. This should *not* be set when using the javascript
 pixel. 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).
        bool direct_user_request = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The directUserRequest.