Recommendations AI V1beta1 API - Class Google::Cloud::RecommendationEngine::V1beta1::UserInfo (v0.9.2)

Version 0.9.2

• 0.10.0 (latest)
• 0.9.2
• 0.8.2
• 0.7.0
• 0.6.1
• 0.5.0
• 0.4.1
• 0.3.7

Reference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::UserInfo.

Information of end users.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#direct_user_request

def direct_user_request() -> ::Boolean

Returns

• (::Boolean) — 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).

#direct_user_request=

def direct_user_request=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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).

Returns

• (::Boolean) — 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).

#ip_address

def ip_address() -> ::String

Returns

• (::String) — 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.

#ip_address=

def ip_address=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#user_agent

def user_agent() -> ::String

Returns

• (::String) — 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.

#user_agent=

def user_agent=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#user_id

def user_id() -> ::String

Returns

• (::String) — Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.

#user_id=

def user_id=(value) -> ::String

Parameter

• value (::String) — Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.

Returns

• (::String) — Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.

#visitor_id

def visitor_id() -> ::String

Returns

• (::String) — 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.

#visitor_id=

def visitor_id=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.