Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::UserInfo (v0.21.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::UserInfo.

Information of an end user.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#user_agent

def user_agent() -> ::String
Returns
  • (::String) — User agent as included in the HTTP header.

    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 UserEvent.direct_user_request is set.

#user_agent=

def user_agent=(value) -> ::String
Parameter
  • value (::String) — User agent as included in the HTTP header.

    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 UserEvent.direct_user_request is set.

Returns
  • (::String) — User agent as included in the HTTP header.

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