Retail V2 API - Class Google::Cloud::Retail::V2::UserInfo (v1.2.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::UserInfo.

Information of an end user.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#direct_user_request

def direct_user_request() -> ::Boolean
Returns
  • (::Boolean) — True if the request is made directly from the end user, in which case the ip_address and 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.

#direct_user_request=

def direct_user_request=(value) -> ::Boolean
Parameter
  • value (::Boolean) — True if the request is made directly from the end user, in which case the ip_address and 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.

Returns
  • (::Boolean) — True if the request is made directly from the end user, in which case the ip_address and 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.

#ip_address

def ip_address() -> ::String
Returns
  • (::String) —

    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:

#ip_address=

def ip_address=(value) -> ::String
Parameter
  • value (::String) —

    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:

Returns
  • (::String) —

    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:

#user_agent

def user_agent() -> ::String
Returns
  • (::String) — User agent as included in the HTTP header. Required for getting [SearchResponse.sponsored_results][google.cloud.retail.v2.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 or if direct_user_request is set.

#user_agent=

def user_agent=(value) -> ::String
Parameter
  • value (::String) — User agent as included in the HTTP header. Required for getting [SearchResponse.sponsored_results][google.cloud.retail.v2.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 or if direct_user_request is set.

Returns
  • (::String) — User agent as included in the HTTP header. Required for getting [SearchResponse.sponsored_results][google.cloud.retail.v2.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 or if direct_user_request is set.

#user_id

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

#user_id=

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

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