- 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 interface ProductServiceGrpc.AsyncServiceService for ingesting Product information of the customer's website.
Methods
addFulfillmentPlaces(AddFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)
public default void addFulfillmentPlaces(AddFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method. ProductService.AddLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
| Parameters | |
|---|---|
| Name | Description |
request |
AddFulfillmentPlacesRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
addLocalInventories(AddLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)
public default void addLocalInventories(AddLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
| Parameters | |
|---|---|
| Name | Description |
request |
AddLocalInventoriesRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
createProduct(CreateProductRequest request, StreamObserver<Product> responseObserver)
public default void createProduct(CreateProductRequest request, StreamObserver<Product> responseObserver)Creates a Product.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateProductRequest |
responseObserver |
io.grpc.stub.StreamObserver<Product> |
deleteProduct(DeleteProductRequest request, StreamObserver<Empty> responseObserver)
public default void deleteProduct(DeleteProductRequest request, StreamObserver<Empty> responseObserver)Deletes a Product.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteProductRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
exportProducts(ExportProductsRequest request, StreamObserver<Operation> responseObserver)
public default void exportProducts(ExportProductsRequest request, StreamObserver<Operation> responseObserver)Exports multiple Products.
| Parameters | |
|---|---|
| Name | Description |
request |
ExportProductsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
getProduct(GetProductRequest request, StreamObserver<Product> responseObserver)
public default void getProduct(GetProductRequest request, StreamObserver<Product> responseObserver)Gets a Product.
| Parameters | |
|---|---|
| Name | Description |
request |
GetProductRequest |
responseObserver |
io.grpc.stub.StreamObserver<Product> |
importProducts(ImportProductsRequest request, StreamObserver<Operation> responseObserver)
public default void importProducts(ImportProductsRequest request, StreamObserver<Operation> responseObserver)Bulk import of multiple Products. Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated.
| Parameters | |
|---|---|
| Name | Description |
request |
ImportProductsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
listProducts(ListProductsRequest request, StreamObserver<ListProductsResponse> responseObserver)
public default void listProducts(ListProductsRequest request, StreamObserver<ListProductsResponse> responseObserver)Gets a list of Products.
| Parameters | |
|---|---|
| Name | Description |
request |
ListProductsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListProductsResponse> |
purgeProducts(PurgeProductsRequest request, StreamObserver<Operation> responseObserver)
public default void purgeProducts(PurgeProductsRequest request, StreamObserver<Operation> responseObserver)Permanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by ProductService.GetProduct or ProductService.ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false.
| Parameters | |
|---|---|
| Name | Description |
request |
PurgeProductsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)
public default void removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.RemoveLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveFulfillmentPlacesRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
removeLocalInventories(RemoveLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)
public default void removeLocalInventories(RemoveLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
| Parameters | |
|---|---|
| Name | Description |
request |
RemoveLocalInventoriesRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
setInventory(SetInventoryRequest request, StreamObserver<Operation> responseObserver)
public default void setInventory(SetInventoryRequest request, StreamObserver<Operation> responseObserver) Updates inventory information for a
Product while respecting the last
update timestamps of each inventory field.
This process is asynchronous and does not require the
Product to exist before updating
fulfillment information. If the request is valid, the update is enqueued
and processed downstream. As a consequence, when a response is returned,
updates are not immediately manifested in the
Product queried by
ProductService.GetProduct
or
ProductService.ListProducts.
When inventory is updated with
ProductService.CreateProduct
and
ProductService.UpdateProduct,
the specified inventory field value(s) overwrite any existing value(s)
while ignoring the last update time for this field. Furthermore, the last
update times for the specified inventory fields are overwritten by the
times of the
ProductService.CreateProduct
or
ProductService.UpdateProduct
request.
If no inventory fields are set in
CreateProductRequest.product,
then any pre-existing inventory information for this product is used.
If no inventory fields are set in
SetInventoryRequest.set_mask,
then any existing inventory information is preserved.
Pre-existing inventory information can only be updated with
ProductService.SetInventory,
ProductService.AddFulfillmentPlaces,
and
ProductService.RemoveFulfillmentPlaces.
The returned Operations is obsolete after
one day, and the GetOperation
API returns NOT_FOUND afterwards.
If conflicting updates are issued, the
Operations associated with the stale
updates are not marked as done until
they are obsolete.
| Parameters | |
|---|---|
| Name | Description |
request |
SetInventoryRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
updateProduct(UpdateProductRequest request, StreamObserver<Product> responseObserver)
public default void updateProduct(UpdateProductRequest request, StreamObserver<Product> responseObserver)Updates a Product.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateProductRequest |
responseObserver |
io.grpc.stub.StreamObserver<Product> |