- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class UserInfo.Builder extends GeneratedMessageV3.Builder<UserInfo.Builder> implements UserInfoOrBuilderInformation of an end user.
Protobuf type google.cloud.retail.v2beta.UserInfo
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UserInfo.BuilderImplements
UserInfoOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UserInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field | FieldDescriptor |
value | Object |
| Type | Description |
UserInfo.Builder |
build()
public UserInfo build()| Type | Description |
UserInfo |
buildPartial()
public UserInfo buildPartial()| Type | Description |
UserInfo |
clear()
public UserInfo.Builder clear()| Type | Description |
UserInfo.Builder |
clearDirectUserRequest()
public UserInfo.Builder clearDirectUserRequest()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;
| Type | Description |
UserInfo.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public UserInfo.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
field | FieldDescriptor |
| Type | Description |
UserInfo.Builder |
clearIpAddress()
public UserInfo.Builder clearIpAddress()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;
| Type | Description |
UserInfo.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public UserInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
oneof | OneofDescriptor |
| Type | Description |
UserInfo.Builder |
clearUserAgent()
public UserInfo.Builder clearUserAgent()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;
| Type | Description |
UserInfo.Builder | This builder for chaining. |
clearUserId()
public UserInfo.Builder clearUserId()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;
| Type | Description |
UserInfo.Builder | This builder for chaining. |
clone()
public UserInfo.Builder clone()| Type | Description |
UserInfo.Builder |
getDefaultInstanceForType()
public UserInfo getDefaultInstanceForType()| Type | Description |
UserInfo |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
Descriptor |
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;
| 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;
| 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;
| Type | Description |
ByteString | The bytes for ipAddress. |
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;
| 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;
| 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;
| 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;
| Type | Description |
ByteString | The bytes for userId. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
mergeFrom(UserInfo other)
public UserInfo.Builder mergeFrom(UserInfo other)| Name | Description |
other | UserInfo |
| Type | Description |
UserInfo.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UserInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
UserInfo.Builder |
| Type | Description |
IOException |
mergeFrom(Message other)
public UserInfo.Builder mergeFrom(Message other)| Name | Description |
other | Message |
| Type | Description |
UserInfo.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UserInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
unknownFields | UnknownFieldSet |
| Type | Description |
UserInfo.Builder |
setDirectUserRequest(boolean value)
public UserInfo.Builder setDirectUserRequest(boolean value)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;
| Name | Description |
value | booleanThe directUserRequest to set. |
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public UserInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field | FieldDescriptor |
value | Object |
| Type | Description |
UserInfo.Builder |
setIpAddress(String value)
public UserInfo.Builder setIpAddress(String value)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;
| Name | Description |
value | StringThe ipAddress to set. |
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setIpAddressBytes(ByteString value)
public UserInfo.Builder setIpAddressBytes(ByteString value)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;
| Name | Description |
value | ByteStringThe bytes for ipAddress to set. |
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UserInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Type | Description |
UserInfo.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final UserInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
unknownFields | UnknownFieldSet |
| Type | Description |
UserInfo.Builder |
setUserAgent(String value)
public UserInfo.Builder setUserAgent(String value)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;
| Name | Description |
value | StringThe userAgent to set. |
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setUserAgentBytes(ByteString value)
public UserInfo.Builder setUserAgentBytes(ByteString value)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;
| Name | Description |
value | ByteStringThe bytes for userAgent to set. |
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setUserId(String value)
public UserInfo.Builder setUserId(String value)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;
| Name | Description |
value | StringThe userId to set. |
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setUserIdBytes(ByteString value)
public UserInfo.Builder setUserIdBytes(ByteString value)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;
| Name | Description |
value | ByteStringThe bytes for userId to set. |
| Type | Description |
UserInfo.Builder | This builder for chaining. |