com.google.cloud.retail.v2alpha.UserInfoOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Proto library for google-cloud-retail
There is a newer version: 2.55.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/retail/v2alpha/common.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2alpha;

public interface UserInfoOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2alpha.UserInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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;
   *
   * @return The userId.
   */
  java.lang.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;
   *
   * @return The bytes for userId.
   */
  com.google.protobuf.ByteString getUserIdBytes();

  /**
   *
   *
   *    * 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][google.cloud.retail.v2alpha.SearchRequest.user_info].
   * * using the JavaScript tag in
   * [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
   * or if
   * [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
   * is set.
   * 
   *
   * string ip_address = 2;
   *
   * @return The ipAddress.
   */
  java.lang.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][google.cloud.retail.v2alpha.SearchRequest.user_info].
   * * using the JavaScript tag in
   * [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
   * or if
   * [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
   * is set.
   * 
   *
   * string ip_address = 2;
   *
   * @return The bytes for ipAddress.
   */
  com.google.protobuf.ByteString getIpAddressBytes();

  /**
   *
   *
   *    * User agent as included in the HTTP header. Required for getting
   * [SearchResponse.sponsored_results][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
   * or if
   * [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
   * is set.
   * 
   *
   * string user_agent = 3;
   *
   * @return The userAgent.
   */
  java.lang.String getUserAgent();
  /**
   *
   *
   *    * User agent as included in the HTTP header. Required for getting
   * [SearchResponse.sponsored_results][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
   * or if
   * [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
   * is set.
   * 
   *
   * string user_agent = 3;
   *
   * @return The bytes for userAgent.
   */
  com.google.protobuf.ByteString getUserAgentBytes();

  /**
   *
   *
   *    * True if the request is made directly from the end user, in which case the
   * [ip_address][google.cloud.retail.v2alpha.UserInfo.ip_address] and
   * [user_agent][google.cloud.retail.v2alpha.UserInfo.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][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent].
   * 
   *
   * bool direct_user_request = 4;
   *
   * @return The directUserRequest.
   */
  boolean getDirectUserRequest();
}