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
-
(::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
-
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.
-
(::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
-
(::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
-
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.
-
(::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
-
(::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
-
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.
-
(::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
-
(::String) — Required. The parent branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0
. Usedefault_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
-
value (::String) — Required. The parent branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0
. Usedefault_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.
-
(::String) — Required. The parent branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0
. Usedefault_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
-
(::Google::Protobuf::FieldMask) — The fields of Product to return in the
responses. If not set or empty, the following fields are returned:
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
-
value (::Google::Protobuf::FieldMask) — The fields of Product to return in the
responses. If not set or empty, the following fields are returned:
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.
-
(::Google::Protobuf::FieldMask) — The fields of Product to return in the
responses. If not set or empty, the following fields are returned:
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.