public final class UserInfo extends GeneratedMessageV3 implements UserInfoOrBuilder
Information of an end user.
Protobuf type google.cloud.retail.v2.UserInfo
Static Fields
DIRECT_USER_REQUEST_FIELD_NUMBER
public static final int DIRECT_USER_REQUEST_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IP_ADDRESS_FIELD_NUMBER
public static final int IP_ADDRESS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_AGENT_FIELD_NUMBER
public static final int USER_AGENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_ID_FIELD_NUMBER
public static final int USER_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static UserInfo getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static UserInfo.Builder newBuilder()
newBuilder(UserInfo prototype)
public static UserInfo.Builder newBuilder(UserInfo prototype)
| Parameter |
|---|
| Name | Description |
prototype | UserInfo
|
public static UserInfo parseDelimitedFrom(InputStream input)
public static UserInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static UserInfo parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UserInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static UserInfo parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UserInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UserInfo parseFrom(CodedInputStream input)
public static UserInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UserInfo parseFrom(InputStream input)
public static UserInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static UserInfo parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UserInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<UserInfo> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public UserInfo getDefaultInstanceForType()
getDirectUserRequest()
public boolean getDirectUserRequest()
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.
bool direct_user_request = 4;
| Returns |
|---|
| Type | Description |
boolean | The directUserRequest.
|
getIpAddress()
public String getIpAddress()
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.
string ip_address = 2;
| Returns |
|---|
| Type | Description |
String | The ipAddress.
|
getIpAddressBytes()
public ByteString getIpAddressBytes()
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.
string ip_address = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for ipAddress.
|
getParserForType()
public Parser<UserInfo> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUserAgent()
public String getUserAgent()
User agent as included in the HTTP header. Required for getting
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.
string user_agent = 3;
| Returns |
|---|
| Type | Description |
String | The userAgent.
|
getUserAgentBytes()
public ByteString getUserAgentBytes()
User agent as included in the HTTP header. Required for getting
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.
string user_agent = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for userAgent.
|
getUserId()
public String getUserId()
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.
string user_id = 1;
| Returns |
|---|
| Type | Description |
String | The userId.
|
getUserIdBytes()
public ByteString getUserIdBytes()
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.
string user_id = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for userId.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public UserInfo.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UserInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public UserInfo.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
