Class ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource

The "products" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudRetail.v2alpha

Assembly: Google.Apis.CloudRetail.v2alpha.dll

Syntax

public class ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource

Constructors

ProductsResource(IClientService)

Constructs a new resource.

Declaration

public ProductsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AddFulfillmentPlaces(GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.AddFulfillmentPlacesRequest AddFulfillmentPlaces(GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest body, string product)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest	body	The body of the request.
string	product	Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.AddFulfillmentPlacesRequest

AddLocalInventories(GoogleCloudRetailV2alphaAddLocalInventoriesRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.AddLocalInventoriesRequest AddLocalInventories(GoogleCloudRetailV2alphaAddLocalInventoriesRequest body, string product)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaAddLocalInventoriesRequest	body	The body of the request.
string	product	Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.AddLocalInventoriesRequest

Create(GoogleCloudRetailV2alphaProduct, string)

Creates a Product.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.CreateRequest Create(GoogleCloudRetailV2alphaProduct body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaProduct	body	The body of the request.
string	parent	Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.CreateRequest

Delete(string)

Deletes a Product.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.DeleteRequest

Export(GoogleCloudRetailV2alphaExportProductsRequest, string)

Exports multiple Products.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ExportRequest Export(GoogleCloudRetailV2alphaExportProductsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaExportProductsRequest	body	The body of the request.
string	parent	Required. Resource name of a Branch, and `default_branch` for branch_id component is supported. For example `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ExportRequest

Get(string)

Gets a Product.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Product does not exist, a NOT_FOUND error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.GetRequest

Import(GoogleCloudRetailV2alphaImportProductsRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ImportRequest Import(GoogleCloudRetailV2alphaImportProductsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaImportProductsRequest	body	The body of the request.
string	parent	Required. `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ImportRequest

List(string)

Gets a list of Products.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ListRequest

Patch(GoogleCloudRetailV2alphaProduct, string)

Updates a Product.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.PatchRequest Patch(GoogleCloudRetailV2alphaProduct body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaProduct	body	The body of the request.
string	name	Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.PatchRequest

Purge(GoogleCloudRetailV2alphaPurgeProductsRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.PurgeRequest Purge(GoogleCloudRetailV2alphaPurgeProductsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaPurgeProductsRequest	body	The body of the request.
string	parent	Required. The resource name of the branch under which the products are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.PurgeRequest

RemoveFulfillmentPlaces(GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.RemoveFulfillmentPlacesRequest RemoveFulfillmentPlaces(GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest body, string product)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest	body	The body of the request.
string	product	Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.RemoveFulfillmentPlacesRequest

RemoveLocalInventories(GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.RemoveLocalInventoriesRequest RemoveLocalInventories(GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest body, string product)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest	body	The body of the request.
string	product	Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.RemoveLocalInventoriesRequest

SetInventory(GoogleCloudRetailV2alphaSetInventoryRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.SetInventoryRequest SetInventory(GoogleCloudRetailV2alphaSetInventoryRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2alphaSetInventoryRequest	body	The body of the request.
string	name	Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.SetInventoryRequest