View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1UserInfo (google_api_discovery_engine v0.27.0)

Information of an end user.

Attributes

  • userAgent (type: String.t, default: nil) - 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.
  • userId (type: String.t, default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1UserInfo{
  userAgent: String.t() | nil,
  userId: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.