Struct GoogleCloudRetailV2UserInfo 

pub struct GoogleCloudRetailV2UserInfo {
    pub direct_user_request: Option<bool>,
    pub ip_address: Option<String>,
    pub user_agent: Option<String>,
    pub user_id: Option<String>,
}

Information of an end user.

This type is not used in any activity, and only used as part of another schema.

Fields

direct_user_request: Option<bool>

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: Option<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.

user_agent: Option<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 direct_user_request is set.

user_id: Option<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.

Trait Implementations

impl Clone for GoogleCloudRetailV2UserInfo

fn clone(&self) -> GoogleCloudRetailV2UserInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GoogleCloudRetailV2UserInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GoogleCloudRetailV2UserInfo

fn default() -> GoogleCloudRetailV2UserInfo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudRetailV2UserInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GoogleCloudRetailV2UserInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for GoogleCloudRetailV2UserInfo