Class: Google::Cloud::Retail::V2::UserInfo

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::UserInfo

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/common.rb

Overview

Information of an end user.

Instance Attribute Summary

• #direct_user_request ⇒ ::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.

• #ip_address ⇒ ::String

  The end user's IP address.

• #user_agent ⇒ ::String

  User agent as included in the HTTP header.

• #user_id ⇒ ::String

  Highly recommended for logged-in users.

Instance Attribute Details

#direct_user_request ⇒ ::Boolean

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/common.rb', line 803

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#ip_address ⇒ ::String

Returns 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.
• using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

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:

  • setting SearchRequest.user_info.
  • using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

# File 'proto_docs/google/cloud/retail/v2/common.rb', line 803

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_agent ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/common.rb', line 803

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_id ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/common.rb', line 803

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end