Retail v2 API - Class ListProductsRequest (2.5.0) 

public sealed class ListProductsRequest : IMessage<ListProductsRequest>, IEquatable<ListProductsRequest>, IDeepCloneable<ListProductsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Retail v2 API class ListProductsRequest.

Request message for [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] method.

Inheritance

object > ListProductsRequest

Namespace

GoogleCloudGoogle.Cloud.RetailV2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ListProductsRequest()

public ListProductsRequest()

ListProductsRequest(ListProductsRequest)

public ListProductsRequest(ListProductsRequest other)
Parameter
NameDescription
otherListProductsRequest

Properties

Filter

public string Filter { get; set; }

A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if [filter][google.cloud.retail.v2.ListProductsRequest.filter] is unset.
  • List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s sharing the same [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product]. For example: primary_product_id = "some_product_id"
  • List [Product][google.cloud.retail.v2.Product]s bundled in a [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION] [Product][google.cloud.retail.v2.Product]. For example: collection_product_id = "some_product_id"
  • List [Product][google.cloud.retail.v2.Product]s with a partibular type. For example: type = "PRIMARY" type = "VARIANT" type = "COLLECTION"

If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

If the specified [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product] or [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION] [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error is returned.

Property Value
TypeDescription
string

PageSize

public int PageSize { get; set; }

Maximum number of [Product][google.cloud.retail.v2.Product]s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
int

PageToken

public string PageToken { get; set; }

A page token [ListProductsResponse.next_page_token][google.cloud.retail.v2.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
string

Parent

public string Parent { get; set; }

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 [Product][google.cloud.retail.v2.Product]s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Property Value
TypeDescription
string

ParentAsBranchName

public BranchName ParentAsBranchName { get; set; }

BranchName-typed view over the Parent resource name property.

Property Value
TypeDescription
BranchName

ReadMask

public FieldMask ReadMask { get; set; }

The fields of [Product][google.cloud.retail.v2.Product] to return in the responses. If not set or empty, the following fields are returned:

  • [Product.name][google.cloud.retail.v2.Product.name]
  • [Product.id][google.cloud.retail.v2.Product.id]
  • [Product.title][google.cloud.retail.v2.Product.title]
  • [Product.uri][google.cloud.retail.v2.Product.uri]
  • [Product.images][google.cloud.retail.v2.Product.images]
  • [Product.price_info][google.cloud.retail.v2.Product.price_info]
  • [Product.brands][google.cloud.retail.v2.Product.brands]

If "*" is provided, all fields are returned. [Product.name][google.cloud.retail.v2.Product.name] is always returned no matter what mask is set.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
FieldMask