Service for ingesting information of the customer's website. v2
Package
@google-cloud/retail
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of ProductServiceClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
operationsClient
operationsClient
:
gax
.
OperationsClient
;
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
productServiceStub
productServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Property Value
Methods
addFulfillmentPlaces(request, options)
addFulfillmentPlaces
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IAddFulfillmentPlacesRequest
|
| options |
CallOptions
|
Returns
addFulfillmentPlaces(request, options, callback)
addFulfillmentPlaces
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IAddFulfillmentPlacesRequest
|
| options |
CallOptions
|
| callback |
Callback
< LROperation
<protos. google.cloud.retail.v2.IAddFulfillmentPlacesResponse
, protos. google.cloud.retail.v2.IAddFulfillmentPlacesMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
addFulfillmentPlaces(request, callback)
addFulfillmentPlaces
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IAddFulfillmentPlacesMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IAddFulfillmentPlacesRequest
|
| callback |
Callback
< LROperation
<protos. google.cloud.retail.v2.IAddFulfillmentPlacesResponse
, protos. google.cloud.retail.v2.IAddFulfillmentPlacesMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
branchPath(project, location, catalog, branch)
branchPath
(
project
:
string
,
location
:
string
,
catalog
:
string
,
branch
:
string
)
:
string
;
Return a fully-qualified branch resource name string.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
catalogPath(project, location, catalog)
catalogPath
(
project
:
string
,
location
:
string
,
catalog
:
string
)
:
string
;
Return a fully-qualified catalog resource name string.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
checkAddFulfillmentPlacesProgress(name)
checkAddFulfillmentPlacesProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
AddFulfillmentPlacesResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
AddFulfillmentPlacesMetadata
>> ;
Check the status of the long running operation returned by addFulfillmentPlaces()
.
Parameter | Name |
Description |
| name |
string
The operation name that will be passed.
|
Returns | Type |
Description |
| Promise
< LROperation
<protos. google.cloud.retail.v2.AddFulfillmentPlacesResponse
, protos. google.cloud.retail.v2.AddFulfillmentPlacesMetadata
>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
Example const decodedOperation = await checkAddFulfillmentPlacesProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
checkImportProductsProgress(name)
checkImportProductsProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
ImportProductsResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
ImportMetadata
>> ;
Check the status of the long running operation returned by importProducts()
.
Parameter | Name |
Description |
| name |
string
The operation name that will be passed.
|
Returns | Type |
Description |
| Promise
< LROperation
<protos. google.cloud.retail.v2.ImportProductsResponse
, protos. google.cloud.retail.v2.ImportMetadata
>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
Example const decodedOperation = await checkImportProductsProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
checkRemoveFulfillmentPlacesProgress(name)
checkRemoveFulfillmentPlacesProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
RemoveFulfillmentPlacesResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
RemoveFulfillmentPlacesMetadata
>> ;
Check the status of the long running operation returned by removeFulfillmentPlaces()
.
Parameter | Name |
Description |
| name |
string
The operation name that will be passed.
|
Returns | Type |
Description |
| Promise
< LROperation
<protos. google.cloud.retail.v2.RemoveFulfillmentPlacesResponse
, protos. google.cloud.retail.v2.RemoveFulfillmentPlacesMetadata
>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
Example const decodedOperation = await checkRemoveFulfillmentPlacesProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
checkSetInventoryProgress(name)
checkSetInventoryProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
SetInventoryResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
SetInventoryMetadata
>> ;
Check the status of the long running operation returned by setInventory()
.
Parameter | Name |
Description |
| name |
string
The operation name that will be passed.
|
Returns | Type |
Description |
| Promise
< LROperation
<protos. google.cloud.retail.v2.SetInventoryResponse
, protos. google.cloud.retail.v2.SetInventoryMetadata
>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
Example const decodedOperation = await checkSetInventoryProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
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.
|
createProduct(request, options)
createProduct
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
ICreateProductRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
ICreateProductRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.ICreateProductRequest
|
| options |
CallOptions
|
Returns
createProduct(request, options, callback)
createProduct
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
ICreateProductRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
ICreateProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.ICreateProductRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.retail.v2.IProduct
, protos. google.cloud.retail.v2.ICreateProductRequest
| null | undefined, {} | null | undefined>
|
Returns
createProduct(request, callback)
createProduct
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
ICreateProductRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
ICreateProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.ICreateProductRequest
|
| callback |
Callback
<protos. google.cloud.retail.v2.IProduct
, protos. google.cloud.retail.v2.ICreateProductRequest
| null | undefined, {} | null | undefined>
|
Returns
deleteProduct(request, options)
deleteProduct
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IDeleteProductRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
retail
.
v2
.
IDeleteProductRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IDeleteProductRequest
|
| options |
CallOptions
|
Returns
deleteProduct(request, options, callback)
deleteProduct
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IDeleteProductRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
retail
.
v2
.
IDeleteProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IDeleteProductRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.retail.v2.IDeleteProductRequest
| null | undefined, {} | null | undefined>
|
Returns
deleteProduct(request, callback)
deleteProduct
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IDeleteProductRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
retail
.
v2
.
IDeleteProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IDeleteProductRequest
|
| callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.retail.v2.IDeleteProductRequest
| null | undefined, {} | null | undefined>
|
Returns
getProduct(request, options)
getProduct
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetProductRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetProductRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IGetProductRequest
|
| options |
CallOptions
|
Returns
getProduct(request, options, callback)
getProduct
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetProductRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IGetProductRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.retail.v2.IProduct
, protos. google.cloud.retail.v2.IGetProductRequest
| null | undefined, {} | null | undefined>
|
Returns
getProduct(request, callback)
getProduct
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetProductRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IGetProductRequest
|
| callback |
Callback
<protos. google.cloud.retail.v2.IProduct
, protos. google.cloud.retail.v2.IGetProductRequest
| null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter | Name |
Description |
| callback |
Callback
<string, undefined, undefined>
|
Returns
importProducts(request, options)
importProducts
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IImportProductsRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IImportProductsResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IImportMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IImportProductsRequest
|
| options |
CallOptions
|
Returns
importProducts(request, options, callback)
importProducts
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IImportProductsRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IImportProductsResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IImportMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IImportProductsRequest
|
| options |
CallOptions
|
| callback |
Callback
< LROperation
<protos. google.cloud.retail.v2.IImportProductsResponse
, protos. google.cloud.retail.v2.IImportMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
importProducts(request, callback)
importProducts
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IImportProductsRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IImportProductsResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IImportMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IImportProductsRequest
|
| callback |
Callback
< LROperation
<protos. google.cloud.retail.v2.IImportProductsResponse
, protos. google.cloud.retail.v2.IImportMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
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.
|
listProducts(request, options)
listProducts
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
[],
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsRequest
|
null
,
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsResponse
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IListProductsRequest
|
| options |
CallOptions
|
Returns
listProducts(request, options, callback)
listProducts
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsRequest
,
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IListProductsRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback
<protos. google.cloud.retail.v2.IListProductsRequest
, protos. google.cloud.retail.v2.IListProductsResponse
| null | undefined, protos. google.cloud.retail.v2.IProduct
>
|
Returns
listProducts(request, callback)
listProducts
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsRequest
,
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IListProductsRequest
|
| callback |
PaginationCallback
<protos. google.cloud.retail.v2.IListProductsRequest
, protos. google.cloud.retail.v2.IListProductsResponse
| null | undefined, protos. google.cloud.retail.v2.IProduct
>
|
Returns
listProductsAsync(request, options)
listProductsAsync
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
> ;
Equivalent to listProducts
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IListProductsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| AsyncIterable
<protos. google.cloud.retail.v2.IProduct
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Product]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
Example const iterable = client.listProductsAsync(request); for await (const response of iterable) { // process response }
listProductsStream(request, options)
listProductsStream
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IListProductsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IListProductsRequest
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 [Product] 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 listProductsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
removeFulfillmentPlaces(request, options)
removeFulfillmentPlaces
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest
|
| options |
CallOptions
|
Returns
removeFulfillmentPlaces(request, options, callback)
removeFulfillmentPlaces
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest
|
| options |
CallOptions
|
| callback |
Callback
< LROperation
<protos. google.cloud.retail.v2.IRemoveFulfillmentPlacesResponse
, protos. google.cloud.retail.v2.IRemoveFulfillmentPlacesMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
removeFulfillmentPlaces(request, callback)
removeFulfillmentPlaces
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveFulfillmentPlacesMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest
|
| callback |
Callback
< LROperation
<protos. google.cloud.retail.v2.IRemoveFulfillmentPlacesResponse
, protos. google.cloud.retail.v2.IRemoveFulfillmentPlacesMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
setInventory(request, options)
setInventory
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.ISetInventoryRequest
|
| options |
CallOptions
|
Returns
setInventory(request, options, callback)
setInventory
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.ISetInventoryRequest
|
| options |
CallOptions
|
| callback |
Callback
< LROperation
<protos. google.cloud.retail.v2.ISetInventoryResponse
, protos. google.cloud.retail.v2.ISetInventoryMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
setInventory(request, callback)
setInventory
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
ISetInventoryMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.ISetInventoryRequest
|
| callback |
Callback
< LROperation
<protos. google.cloud.retail.v2.ISetInventoryResponse
, protos. google.cloud.retail.v2.ISetInventoryMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
updateProduct(request, options)
updateProduct
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateProductRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateProductRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IUpdateProductRequest
|
| options |
CallOptions
|
Returns
updateProduct(request, options, callback)
updateProduct
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateProductRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IUpdateProductRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.cloud.retail.v2.IProduct
, protos. google.cloud.retail.v2.IUpdateProductRequest
| null | undefined, {} | null | undefined>
|
Returns
updateProduct(request, callback)
updateProduct
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateProductRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IProduct
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateProductRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters | Name |
Description |
| request |
protos. google.cloud.retail.v2.IUpdateProductRequest
|
| callback |
Callback
<protos. google.cloud.retail.v2.IProduct
, protos. google.cloud.retail.v2.IUpdateProductRequest
| null | undefined, {} | null | undefined>
|
Returns