- 0.74.0 (latest)
 - 0.72.0
 - 0.71.0
 - 0.70.0
 - 0.69.0
 - 0.68.0
 - 0.66.0
 - 0.64.0
 - 0.63.0
 - 0.60.0
 - 0.59.0
 - 0.58.0
 - 0.56.0
 - 0.55.0
 - 0.54.0
 - 0.53.0
 - 0.52.0
 - 0.51.0
 - 0.50.0
 - 0.49.0
 - 0.48.0
 - 0.47.0
 - 0.45.0
 - 0.44.0
 - 0.43.0
 - 0.42.0
 - 0.41.0
 - 0.40.0
 - 0.39.0
 - 0.38.0
 - 0.37.0
 - 0.36.0
 - 0.35.0
 - 0.33.0
 - 0.32.0
 - 0.31.0
 - 0.30.0
 - 0.29.0
 - 0.28.0
 - 0.27.0
 - 0.26.0
 - 0.25.0
 - 0.24.0
 - 0.23.0
 - 0.20.0
 - 0.19.0
 - 0.18.0
 - 0.17.0
 - 0.16.0
 - 0.15.0
 - 0.14.0
 - 0.13.0
 - 0.12.0
 - 0.11.0
 - 0.10.0
 - 0.9.0
 - 0.8.0
 - 0.7.0
 - 0.5.0
 - 0.4.0
 - 0.3.0
 - 0.2.0
 - 0.1.0
 
public interface SearchInfoOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getOffset()
public abstract int getOffset()An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
See SearchRequest.offset for definition.
 If this field is negative, an INVALID_ARGUMENT is returned.
 This can only be set for search events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
 optional int32 offset = 3;
| Returns | |
|---|---|
| Type | Description | 
int | 
        The offset.  | 
      
getOrderBy()
public abstract String getOrderBy()The order in which products are returned, if applicable.
See SearchRequest.order_by for definition and syntax.
 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
 This can only be set for search events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
 string order_by = 2;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The orderBy.  | 
      
getOrderByBytes()
public abstract ByteString getOrderByBytes()The order in which products are returned, if applicable.
See SearchRequest.order_by for definition and syntax.
 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
 This can only be set for search events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
 string order_by = 2;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for orderBy.  | 
      
getSearchQuery()
public abstract String getSearchQuery()The user's search query.
See SearchRequest.query for definition.
 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
 At least one of
 search_query
 or
 PageInfo.page_category
 is required for search events. Other event types should not set this
 field. Otherwise, an INVALID_ARGUMENT error is returned.
 string search_query = 1;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The searchQuery.  | 
      
getSearchQueryBytes()
public abstract ByteString getSearchQueryBytes()The user's search query.
See SearchRequest.query for definition.
 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
 At least one of
 search_query
 or
 PageInfo.page_category
 is required for search events. Other event types should not set this
 field. Otherwise, an INVALID_ARGUMENT error is returned.
 string search_query = 1;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for searchQuery.  | 
      
hasOffset()
public abstract boolean hasOffset()An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
See SearchRequest.offset for definition.
 If this field is negative, an INVALID_ARGUMENT is returned.
 This can only be set for search events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
 optional int32 offset = 3;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the offset field is set.  |