Retail V2 API - Class Google::Cloud::Retail::V2::ListProductsRequest (v0.14.0)

Version 0.14.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.1
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.4

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ListProductsRequest.

Request message for ProductService.ListProducts method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String

Returns

• (::String) — A filter to apply on the list results. Supported features:
  • List all the products under the parent branch if filter is unset.
  • List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id"
  • List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id"
  • List Products 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 Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

#filter=

def filter=(value) -> ::String

Parameter

• value (::String) — A filter to apply on the list results. Supported features:
  • List all the products under the parent branch if filter is unset.
  • List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id"
  • List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id"
  • List Products 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 Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

Returns

• (::String) — A filter to apply on the list results. Supported features:
  • List all the products under the parent branch if filter is unset.
  • List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id"
  • List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id"
  • List Products 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 Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

#page_size

def page_size() -> ::Integer

Returns

• (::Integer) — Maximum number of Products 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.

#page_size=

def page_size=(value) -> ::Integer

Parameter

• value (::Integer) — Maximum number of Products 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.

Returns

• (::Integer) — Maximum number of Products 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.

#page_token

def page_token() -> ::String

Returns

• (::String) — A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

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

#page_token=

def page_token=(value) -> ::String

Parameter

• value (::String) — A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

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

Returns

• (::String) — A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

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

#parent

def parent() -> ::String

Returns

• (::String) — 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 {::Google::Cloud::Retail::V2::Product Product}s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — 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 {::Google::Cloud::Retail::V2::Product Product}s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Returns

• (::String) — 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 {::Google::Cloud::Retail::V2::Product Product}s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

#read_mask

def read_mask() -> ::Google::Protobuf::FieldMask

Returns

• (::Google::Protobuf::FieldMask) — The fields of Product to return in the responses. If not set or empty, the following fields are returned:
  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

  If "*" is provided, all fields are returned. 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.

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

• value (::Google::Protobuf::FieldMask) — The fields of Product to return in the responses. If not set or empty, the following fields are returned:
  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

  If "*" is provided, all fields are returned. 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.

Returns

• (::Google::Protobuf::FieldMask) — The fields of Product to return in the responses. If not set or empty, the following fields are returned:
  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

  If "*" is provided, all fields are returned. 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.