Class v2alpha.SearchServiceClient (3.5.0)

Version latest

• 3.5.0 (latest)
• 3.1.0
• 2.4.1
• 2.3.1
• 2.1.1
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.6

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. v2alpha

Package

@google-cloud/retail

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of SearchServiceClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new SearchServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

searchServiceStub

searchServiceStub?: Promise<{
        [name: string]: Function;
    }>;

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

alertConfigPath(project)

alertConfigPath(project: string): string;

Return a fully-qualified alertConfig resource name string.

Parameter
Name	Description
project	string

Returns
Type	Description
string	{string} Resource name string.

attributesConfigPath(project, location, catalog)

attributesConfigPath(project: string, location: string, catalog: string): string;

Return a fully-qualified attributesConfig resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string

Returns
Type	Description
string	{string} Resource name string.

branchPath(project, location, catalog, branch)

branchPath(project: string, location: string, catalog: string, branch: string): string;

Return a fully-qualified branch resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string
branch	string

Returns
Type	Description
string	{string} Resource name string.

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
request	CancelOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

catalogPath(project, location, catalog)

catalogPath(project: string, location: string, catalog: string): string;

Return a fully-qualified catalog resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string

Returns
Type	Description
string	{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

completionConfigPath(project, location, catalog)

completionConfigPath(project: string, location: string, catalog: string): string;

Return a fully-qualified completionConfig resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string

Returns
Type	Description
string	{string} Resource name string.

controlPath(project, location, catalog, control)

controlPath(project: string, location: string, catalog: string, control: string): string;

Return a fully-qualified control resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string
control	string

Returns
Type	Description
string	{string} Resource name string.

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	DeleteOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

experimentPath(project, location, catalog, experiment)

experimentPath(project: string, location: string, catalog: string, experiment: string): string;

Return a fully-qualified experiment resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string
experiment	string

Returns
Type	Description
string	{string} Resource name string.

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IGetLocationRequest The request object that will be sent.
options	CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined> Call options. See CallOptions for more details.
callback	Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
Promise<google.cloud.location.ILocation>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

const [response] = await client.getLocation(request);

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
request	GetOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<[protos.google.longrunning.Operation]>

Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IListLocationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<google.cloud.location.ILocation>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name	Description
request	ListOperationsRequest The request object that will be sent.
options	CallOptions Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
AsyncIterable<protos.google.longrunning.ListOperationsResponse>	{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

loggingConfigPath(project)

loggingConfigPath(project: string): string;

Return a fully-qualified loggingConfig resource name string.

Parameter
Name	Description
project	string

Returns
Type	Description
string	{string} Resource name string.

matchBranchFromBranchName(branchName)

matchBranchFromBranchName(branchName: string): string | number;

Parse the branch from Branch resource.

Parameter
Name	Description
branchName	string A fully-qualified path representing Branch resource.

Returns
Type	Description
string | number	{string} A string representing the branch.

matchBranchFromProductName(productName)

matchBranchFromProductName(productName: string): string | number;

Parse the branch from Product resource.

Parameter
Name	Description
productName	string A fully-qualified path representing Product resource.

Returns
Type	Description
string | number	{string} A string representing the branch.

matchCatalogFromAttributesConfigName(attributesConfigName)

matchCatalogFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the catalog from AttributesConfig resource.

Parameter
Name	Description
attributesConfigName	string A fully-qualified path representing AttributesConfig resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromBranchName(branchName)

matchCatalogFromBranchName(branchName: string): string | number;

Parse the catalog from Branch resource.

Parameter
Name	Description
branchName	string A fully-qualified path representing Branch resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName: string): string | number;

Parse the catalog from Catalog resource.

Parameter
Name	Description
catalogName	string A fully-qualified path representing Catalog resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromCompletionConfigName(completionConfigName)

matchCatalogFromCompletionConfigName(completionConfigName: string): string | number;

Parse the catalog from CompletionConfig resource.

Parameter
Name	Description
completionConfigName	string A fully-qualified path representing CompletionConfig resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromControlName(controlName)

matchCatalogFromControlName(controlName: string): string | number;

Parse the catalog from Control resource.

Parameter
Name	Description
controlName	string A fully-qualified path representing Control resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromExperimentName(experimentName)

matchCatalogFromExperimentName(experimentName: string): string | number;

Parse the catalog from Experiment resource.

Parameter
Name	Description
experimentName	string A fully-qualified path representing Experiment resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName)

matchCatalogFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName: string): string | number;

Parse the catalog from MerchantCenterAccountLink resource.

Parameter
Name	Description
merchantCenterAccountLinkName	string A fully-qualified path representing MerchantCenterAccountLink resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromModelName(modelName)

matchCatalogFromModelName(modelName: string): string | number;

Parse the catalog from Model resource.

Parameter
Name	Description
modelName	string A fully-qualified path representing Model resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName: string): string | number;

Parse the catalog from Product resource.

Parameter
Name	Description
productName	string A fully-qualified path representing Product resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchCatalogFromServingConfigName(servingConfigName)

matchCatalogFromServingConfigName(servingConfigName: string): string | number;

Parse the catalog from ServingConfig resource.

Parameter
Name	Description
servingConfigName	string A fully-qualified path representing ServingConfig resource.

Returns
Type	Description
string | number	{string} A string representing the catalog.

matchControlFromControlName(controlName)

matchControlFromControlName(controlName: string): string | number;

Parse the control from Control resource.

Parameter
Name	Description
controlName	string A fully-qualified path representing Control resource.

Returns
Type	Description
string | number	{string} A string representing the control.

matchExperimentFromExperimentName(experimentName)

matchExperimentFromExperimentName(experimentName: string): string | number;

Parse the experiment from Experiment resource.

Parameter
Name	Description
experimentName	string A fully-qualified path representing Experiment resource.

Returns
Type	Description
string | number	{string} A string representing the experiment.

matchLocationFromAttributesConfigName(attributesConfigName)

matchLocationFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the location from AttributesConfig resource.

Parameter
Name	Description
attributesConfigName	string A fully-qualified path representing AttributesConfig resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromBranchName(branchName)

matchLocationFromBranchName(branchName: string): string | number;

Parse the location from Branch resource.

Parameter
Name	Description
branchName	string A fully-qualified path representing Branch resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName: string): string | number;

Parse the location from Catalog resource.

Parameter
Name	Description
catalogName	string A fully-qualified path representing Catalog resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromCompletionConfigName(completionConfigName)

matchLocationFromCompletionConfigName(completionConfigName: string): string | number;

Parse the location from CompletionConfig resource.

Parameter
Name	Description
completionConfigName	string A fully-qualified path representing CompletionConfig resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromControlName(controlName)

matchLocationFromControlName(controlName: string): string | number;

Parse the location from Control resource.

Parameter
Name	Description
controlName	string A fully-qualified path representing Control resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromExperimentName(experimentName)

matchLocationFromExperimentName(experimentName: string): string | number;

Parse the location from Experiment resource.

Parameter
Name	Description
experimentName	string A fully-qualified path representing Experiment resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName)

matchLocationFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName: string): string | number;

Parse the location from MerchantCenterAccountLink resource.

Parameter
Name	Description
merchantCenterAccountLinkName	string A fully-qualified path representing MerchantCenterAccountLink resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter
Name	Description
modelName	string A fully-qualified path representing Model resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromProductName(productName)

matchLocationFromProductName(productName: string): string | number;

Parse the location from Product resource.

Parameter
Name	Description
productName	string A fully-qualified path representing Product resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromServingConfigName(servingConfigName)

matchLocationFromServingConfigName(servingConfigName: string): string | number;

Parse the location from ServingConfig resource.

Parameter
Name	Description
servingConfigName	string A fully-qualified path representing ServingConfig resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchMerchantCenterAccountLinkFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName)

matchMerchantCenterAccountLinkFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName: string): string | number;

Parse the merchant_center_account_link from MerchantCenterAccountLink resource.

Parameter
Name	Description
merchantCenterAccountLinkName	string A fully-qualified path representing MerchantCenterAccountLink resource.

Returns
Type	Description
string | number	{string} A string representing the merchant_center_account_link.

matchModelFromModelName(modelName)

matchModelFromModelName(modelName: string): string | number;

Parse the model from Model resource.

Parameter
Name	Description
modelName	string A fully-qualified path representing Model resource.

Returns
Type	Description
string | number	{string} A string representing the model.

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

Parse the product from Product resource.

Parameter
Name	Description
productName	string A fully-qualified path representing Product resource.

Returns
Type	Description
string | number	{string} A string representing the product.

matchProjectFromAlertConfigName(alertConfigName)

matchProjectFromAlertConfigName(alertConfigName: string): string | number;

Parse the project from AlertConfig resource.

Parameter
Name	Description
alertConfigName	string A fully-qualified path representing AlertConfig resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromAttributesConfigName(attributesConfigName)

matchProjectFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the project from AttributesConfig resource.

Parameter
Name	Description
attributesConfigName	string A fully-qualified path representing AttributesConfig resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromBranchName(branchName)

matchProjectFromBranchName(branchName: string): string | number;

Parse the project from Branch resource.

Parameter
Name	Description
branchName	string A fully-qualified path representing Branch resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName: string): string | number;

Parse the project from Catalog resource.

Parameter
Name	Description
catalogName	string A fully-qualified path representing Catalog resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromCompletionConfigName(completionConfigName)

matchProjectFromCompletionConfigName(completionConfigName: string): string | number;

Parse the project from CompletionConfig resource.

Parameter
Name	Description
completionConfigName	string A fully-qualified path representing CompletionConfig resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromControlName(controlName)

matchProjectFromControlName(controlName: string): string | number;

Parse the project from Control resource.

Parameter
Name	Description
controlName	string A fully-qualified path representing Control resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromExperimentName(experimentName)

matchProjectFromExperimentName(experimentName: string): string | number;

Parse the project from Experiment resource.

Parameter
Name	Description
experimentName	string A fully-qualified path representing Experiment resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromLoggingConfigName(loggingConfigName)

matchProjectFromLoggingConfigName(loggingConfigName: string): string | number;

Parse the project from LoggingConfig resource.

Parameter
Name	Description
loggingConfigName	string A fully-qualified path representing LoggingConfig resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName)

matchProjectFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName: string): string | number;

Parse the project from MerchantCenterAccountLink resource.

Parameter
Name	Description
merchantCenterAccountLinkName	string A fully-qualified path representing MerchantCenterAccountLink resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromModelName(modelName)

matchProjectFromModelName(modelName: string): string | number;

Parse the project from Model resource.

Parameter
Name	Description
modelName	string A fully-qualified path representing Model resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProductName(productName)

matchProjectFromProductName(productName: string): string | number;

Parse the project from Product resource.

Parameter
Name	Description
productName	string A fully-qualified path representing Product resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromRetailProjectName(retailProjectName)

matchProjectFromRetailProjectName(retailProjectName: string): string | number;

Parse the project from RetailProject resource.

Parameter
Name	Description
retailProjectName	string A fully-qualified path representing RetailProject resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromServingConfigName(servingConfigName)

matchProjectFromServingConfigName(servingConfigName: string): string | number;

Parse the project from ServingConfig resource.

Parameter
Name	Description
servingConfigName	string A fully-qualified path representing ServingConfig resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchServingConfigFromServingConfigName(servingConfigName)

matchServingConfigFromServingConfigName(servingConfigName: string): string | number;

Parse the serving_config from ServingConfig resource.

Parameter
Name	Description
servingConfigName	string A fully-qualified path representing ServingConfig resource.

Returns
Type	Description
string | number	{string} A string representing the serving_config.

merchantCenterAccountLinkPath(project, location, catalog, merchantCenterAccountLink)

merchantCenterAccountLinkPath(project: string, location: string, catalog: string, merchantCenterAccountLink: string): string;

Return a fully-qualified merchantCenterAccountLink resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string
merchantCenterAccountLink	string

Returns
Type	Description
string	{string} Resource name string.

modelPath(project, location, catalog, model)

modelPath(project: string, location: string, catalog: string, model: string): string;

Return a fully-qualified model resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string
model	string

Returns
Type	Description
string	{string} Resource name string.

productPath(project, location, catalog, branch, product)

productPath(project: string, location: string, catalog: string, branch: string, product: string): string;

Return a fully-qualified product resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string
branch	string
product	string

Returns
Type	Description
string	{string} Resource name string.

retailProjectPath(project)

retailProjectPath(project: string): string;

Return a fully-qualified retailProject resource name string.

Parameter
Name	Description
project	string

Returns
Type	Description
string	{string} Resource name string.

search(request, options)

search(request?: protos.google.cloud.retail.v2alpha.ISearchRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2alpha.SearchResponse.ISearchResult[],
        protos.google.cloud.retail.v2alpha.ISearchRequest | null,
        protos.google.cloud.retail.v2alpha.ISearchResponse
    ]>;

Performs a search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameters
Name	Description
request	ISearchRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.retail.v2alpha.SearchResponse.ISearchResult[], protos.google.cloud.retail.v2alpha.ISearchRequest | null, protos.google.cloud.retail.v2alpha.ISearchResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using searchAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

search(request, options, callback)

search(request: protos.google.cloud.retail.v2alpha.ISearchRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.retail.v2alpha.ISearchRequest, protos.google.cloud.retail.v2alpha.ISearchResponse | null | undefined, protos.google.cloud.retail.v2alpha.SearchResponse.ISearchResult>): void;

Parameters
Name	Description
request	ISearchRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.retail.v2alpha.ISearchRequest, protos.google.cloud.retail.v2alpha.ISearchResponse | null | undefined, protos.google.cloud.retail.v2alpha.SearchResponse.ISearchResult>

Returns
Type	Description
void

search(request, callback)

search(request: protos.google.cloud.retail.v2alpha.ISearchRequest, callback: PaginationCallback<protos.google.cloud.retail.v2alpha.ISearchRequest, protos.google.cloud.retail.v2alpha.ISearchResponse | null | undefined, protos.google.cloud.retail.v2alpha.SearchResponse.ISearchResult>): void;

Parameters
Name	Description
request	ISearchRequest
callback	PaginationCallback<protos.google.cloud.retail.v2alpha.ISearchRequest, protos.google.cloud.retail.v2alpha.ISearchResponse | null | undefined, protos.google.cloud.retail.v2alpha.SearchResponse.ISearchResult>

Returns
Type	Description
void

searchAsync(request, options)

searchAsync(request?: protos.google.cloud.retail.v2alpha.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.retail.v2alpha.SearchResponse.ISearchResult>;

Equivalent to search, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	ISearchRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.retail.v2alpha.SearchResponse.ISearchResult>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Retail Search serving config, such as
   *  `projects/* /locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
   *  or the name of the legacy placement resource, such as
   *  `projects/* /locations/global/catalogs/default_catalog/placements/default_search`.
   *  This field is used to identify the serving config name and the set
   *  of models that are used to make the search.
   */
  // const placement = 'abc123'
  /**
   *  The branch resource name, such as
   *  `projects/* /locations/global/catalogs/default_catalog/branches/0`.
   *  Use "default_branch" as the branch ID or leave this field empty, to search
   *  products under the default branch.
   */
  // const branch = 'abc123'
  /**
   *  Raw search query.
   *  If this field is empty, the request is considered a category browsing
   *  request and returned results are based on
   *  filter google.cloud.retail.v2alpha.SearchRequest.filter  and
   *  page_categories google.cloud.retail.v2alpha.SearchRequest.page_categories.
   */
  // const query = 'abc123'
  /**
   *  Required. A unique identifier for tracking visitors. For example, this
   *  could be implemented with an HTTP cookie, which should be able to uniquely
   *  identify a visitor on a single device. This unique identifier should not
   *  change if the visitor logs in or out of the website.
   *  This should be the same identifier as
   *  UserEvent.visitor_id google.cloud.retail.v2alpha.UserEvent.visitor_id.
   *  The field must be a UTF-8 encoded string with a length limit of 128
   *  characters. Otherwise, an INVALID_ARGUMENT error is returned.
   */
  // const visitorId = 'abc123'
  /**
   *  User information.
   */
  // const userInfo = {}
  /**
   *  Maximum number of Product google.cloud.retail.v2alpha.Product s to
   *  return. If unspecified, defaults to a reasonable value. The maximum allowed
   *  value is 120. Values above 120 will be coerced to 120.
   *  If this field is negative, an INVALID_ARGUMENT is returned.
   */
  // const pageSize = 1234
  /**
   *  A page token
   *  SearchResponse.next_page_token google.cloud.retail.v2alpha.SearchResponse.next_page_token,
   *  received from a previous
   *  SearchService.Search google.cloud.retail.v2alpha.SearchService.Search 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  SearchService.Search google.cloud.retail.v2alpha.SearchService.Search 
   *  must match the call that provided the page token. Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  A 0-indexed integer that specifies the current offset (that is, starting
   *  result location, amongst the
   *  Product google.cloud.retail.v2alpha.Product s deemed by the API as
   *  relevant) in search results. This field is only considered if
   *  page_token google.cloud.retail.v2alpha.SearchRequest.page_token  is
   *  unset.
   *  If this field is negative, an INVALID_ARGUMENT is returned.
   */
  // const offset = 1234
  /**
   *  The filter syntax consists of an expression language for constructing a
   *  predicate from one or more fields of the products being filtered. Filter
   *  expression is case-sensitive. For more information, see
   *  Filter (https://cloud.google.com/retail/docs/filter-and-order#filter).
   *  If this field is unrecognizable, an INVALID_ARGUMENT is returned.
   */
  // const filter = 'abc123'
  /**
   *  The default filter that is applied when a user performs a search without
   *  checking any filters on the search page.
   *  The filter applied to every search request when quality improvement such as
   *  query expansion is needed. In the case a query does not have a sufficient
   *  amount of results this filter will be used to determine whether or not to
   *  enable the query expansion flow. The original filter will still be used for
   *  the query expanded search.
   *  This field is strongly recommended to achieve high search quality.
   *  For more information about filter syntax, see
   *  SearchRequest.filter google.cloud.retail.v2alpha.SearchRequest.filter.
   */
  // const canonicalFilter = 'abc123'
  /**
   *  The order in which products are returned. Products can be ordered by
   *  a field in an Product google.cloud.retail.v2alpha.Product  object. Leave
   *  it unset if ordered by relevance. OrderBy expression is case-sensitive. For
   *  more information, see
   *  Order (https://cloud.google.com/retail/docs/filter-and-order#order).
   *  If this field is unrecognizable, an INVALID_ARGUMENT is returned.
   */
  // const orderBy = 'abc123'
  /**
   *  Facet specifications for faceted search. If empty, no facets are returned.
   *  A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error
   *  is returned.
   */
  // const facetSpecs = [1,2,3,4]
  /**
   *  Boost specification to boost certain products. For more information, see
   *  Boost results (https://cloud.google.com/retail/docs/boosting).
   *  Notice that if both
   *  ServingConfig.boost_control_ids google.cloud.retail.v2alpha.ServingConfig.boost_control_ids 
   *  and
   *  SearchRequest.boost_spec google.cloud.retail.v2alpha.SearchRequest.boost_spec 
   *  are set, the boost conditions from both places are evaluated. If a search
   *  request matches multiple boost conditions, the final boost score is equal
   *  to the sum of the boost scores from all matched boost conditions.
   */
  // const boostSpec = {}
  /**
   *  The query expansion specification that specifies the conditions under which
   *  query expansion occurs. For more information, see Query
   *  expansion (https://cloud.google.com/retail/docs/result-size#query_expansion).
   */
  // const queryExpansionSpec = {}
  /**
   *  The relevance threshold of the search results.
   *  Defaults to
   *  RelevanceThreshold.HIGH google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH,
   *  which means only the most relevant results are shown, and the least number
   *  of results are returned. For more information, see Adjust result
   *  size (https://cloud.google.com/retail/docs/result-size#relevance_thresholding).
   */
  // const relevanceThreshold = {}
  /**
   *  The keys to fetch and rollup the matching
   *  variant google.cloud.retail.v2alpha.Product.Type.VARIANT 
   *  Product google.cloud.retail.v2alpha.Product s attributes,
   *  FulfillmentInfo google.cloud.retail.v2alpha.FulfillmentInfo  or
   *  LocalInventory google.cloud.retail.v2alpha.LocalInventory s attributes.
   *  The attributes from all the matching
   *  variant google.cloud.retail.v2alpha.Product.Type.VARIANT 
   *  Product google.cloud.retail.v2alpha.Product s or
   *  LocalInventory google.cloud.retail.v2alpha.LocalInventory s are merged
   *  and de-duplicated. Notice that rollup attributes will lead to extra query
   *  latency. Maximum number of keys is 30.
   *  For FulfillmentInfo google.cloud.retail.v2alpha.FulfillmentInfo, a
   *  fulfillment type and a fulfillment ID must be provided in the format of
   *  "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123",
   *  "pickupInStore" is fulfillment type and "store123" is the store ID.
   *  Supported keys are:
   *  * colorFamilies
   *  * price
   *  * originalPrice
   *  * discount
   *  * variantId
   *  * inventory(place_id,price)
   *  * inventory(place_id,original_price)
   *  * inventory(place_id,attributes.key), where key is any key in the
   *    Product.local_inventories.attributes google.cloud.retail.v2alpha.LocalInventory.attributes 
   *    map.
   *  * attributes.key, where key is any key in the
   *    Product.attributes google.cloud.retail.v2alpha.Product.attributes  map.
   *  * pickupInStore.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "pickup-in-store".
   *  * shipToStore.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "ship-to-store".
   *  * sameDayDelivery.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "same-day-delivery".
   *  * nextDayDelivery.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "next-day-delivery".
   *  * customFulfillment1.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "custom-type-1".
   *  * customFulfillment2.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "custom-type-2".
   *  * customFulfillment3.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "custom-type-3".
   *  * customFulfillment4.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "custom-type-4".
   *  * customFulfillment5.id, where id is any
   *  FulfillmentInfo.place_ids google.cloud.retail.v2alpha.FulfillmentInfo.place_ids 
   *  for
   *  FulfillmentInfo.type google.cloud.retail.v2alpha.FulfillmentInfo.type 
   *    "custom-type-5".
   *  If this field is set to an invalid value other than these, an
   *  INVALID_ARGUMENT error is returned.
   */
  // const variantRollupKeys = ['abc','def']
  /**
   *  The categories associated with a category page. Must be set for category
   *  navigation queries to achieve good search quality. The format should be
   *  the same as
   *  UserEvent.page_categories google.cloud.retail.v2alpha.UserEvent.page_categories;
   *  To represent full path of category, use '>' sign to separate different
   *  hierarchies. If '>' is part of the category name, replace it with
   *  other character(s).
   *  Category pages include special pages such as sales or promotions. For
   *  instance, a special sale page may have the category hierarchy:
   *  "pageCategories" : "Sales > 2017 Black Friday Deals".
   */
  // const pageCategories = ['abc','def']
  /**
   *  The search mode of the search request. If not specified, a single search
   *  request triggers both product search and faceted search.
   */
  // const searchMode = {}
  /**
   *  The specification for personalization.
   *  Notice that if both
   *  ServingConfig.personalization_spec google.cloud.retail.v2alpha.ServingConfig.personalization_spec 
   *  and
   *  SearchRequest.personalization_spec google.cloud.retail.v2alpha.SearchRequest.personalization_spec 
   *  are set.
   *  SearchRequest.personalization_spec google.cloud.retail.v2alpha.SearchRequest.personalization_spec 
   *  will override
   *  ServingConfig.personalization_spec google.cloud.retail.v2alpha.ServingConfig.personalization_spec.
   */
  // const personalizationSpec = {}
  /**
   *  The labels applied to a resource must meet the following requirements:
   *  * Each resource can have multiple labels, up to a maximum of 64.
   *  * Each label must be a key-value pair.
   *  * Keys have a minimum length of 1 character and a maximum length of 63
   *    characters and cannot be empty. Values can be empty and have a maximum
   *    length of 63 characters.
   *  * Keys and values can contain only lowercase letters, numeric characters,
   *    underscores, and dashes. All characters must use UTF-8 encoding, and
   *    international characters are allowed.
   *  * The key portion of a label must be unique. However, you can use the same
   *    key with multiple resources.
   *  * Keys must start with a lowercase letter or international character.
   *  For more information, see Requirements for
   *  labels (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
   *  in the Resource Manager documentation.
   */
  // const labels = [1,2,3,4]
  /**
   *  The spell correction specification that specifies the mode under
   *  which spell correction will take effect.
   */
  // const spellCorrectionSpec = {}
  /**
   *  The entity for customers that may run multiple different entities, domains,
   *  sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
   *  `google.com`, `youtube.com`, etc.
   *  If this is set, it should be exactly matched with
   *  UserEvent.entity google.cloud.retail.v2alpha.UserEvent.entity  to get
   *  search results boosted by entity.
   */
  // const entity = 'abc123'

  // Imports the Retail library
  const {SearchServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new SearchServiceClient();

  async function callSearch() {
    // Construct request
    const request = {
      placement,
      visitorId,
    };

    // Run request
    const iterable = retailClient.searchAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callSearch();

searchStream(request, options)

searchStream(request?: protos.google.cloud.retail.v2alpha.ISearchRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	ISearchRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using searchAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

servingConfigPath(project, location, catalog, servingConfig)

servingConfigPath(project: string, location: string, catalog: string, servingConfig: string): string;

Return a fully-qualified servingConfig resource name string.

Parameters
Name	Description
project	string
location	string
catalog	string
servingConfig	string

Returns
Type	Description
string	{string} Resource name string.