Google Cloud Native v0.28.0, Feb 2 23

google-native.recommendationengine/v1beta1.getCatalogItem

Gets a specific catalog item.

Using getCatalogItem

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCatalogItem(args: GetCatalogItemArgs, opts?: InvokeOptions): Promise<GetCatalogItemResult>
function getCatalogItemOutput(args: GetCatalogItemOutputArgs, opts?: InvokeOptions): Output<GetCatalogItemResult>

def get_catalog_item(catalog_id: Optional[str] = None,
                     catalog_item_id: Optional[str] = None,
                     location: Optional[str] = None,
                     project: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCatalogItemResult
def get_catalog_item_output(catalog_id: Optional[pulumi.Input[str]] = None,
                     catalog_item_id: Optional[pulumi.Input[str]] = None,
                     location: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCatalogItemResult]

func LookupCatalogItem(ctx *Context, args *LookupCatalogItemArgs, opts ...InvokeOption) (*LookupCatalogItemResult, error)
func LookupCatalogItemOutput(ctx *Context, args *LookupCatalogItemOutputArgs, opts ...InvokeOption) LookupCatalogItemResultOutput

> Note: This function is named LookupCatalogItem in the Go SDK.

public static class GetCatalogItem 
{
    public static Task<GetCatalogItemResult> InvokeAsync(GetCatalogItemArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogItemResult> Invoke(GetCatalogItemInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCatalogItemResult> getCatalogItem(GetCatalogItemArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:recommendationengine/v1beta1:getCatalogItem
  arguments:
    # arguments dictionary

The following arguments are supported:

CatalogId string
CatalogItemId string
Location string
Project string

CatalogId string
CatalogItemId string
Location string
Project string

catalogId String
catalogItemId String
location String
project String

catalogId string
catalogItemId string
location string
project string

catalog_id str
catalog_item_id str
location str
project str

catalogId String
catalogItemId String
location String
project String

getCatalogItem Result

The following output properties are available:

CategoryHierarchies List<Pulumi.GoogleNative.Recommendationengine.V1Beta1.Outputs.GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse>

Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ]

Description string

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

ItemAttributes Pulumi.GoogleNative.Recommendationengine.V1Beta1.Outputs.GoogleCloudRecommendationengineV1beta1FeatureMapResponse

Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here.

ItemGroupId string

Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.

LanguageCode string

Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.

Deprecated:

ProductMetadata Pulumi.GoogleNative.Recommendationengine.V1Beta1.Outputs.GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse

Optional. Metadata specific to retail products.

Tags List<string>

Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.

Title string

Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

CategoryHierarchies []GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse

Description string

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

ItemAttributes GoogleCloudRecommendationengineV1beta1FeatureMapResponse

ItemGroupId string

Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.

LanguageCode string

Deprecated:

ProductMetadata GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse

Optional. Metadata specific to retail products.

Tags []string

Title string

Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

categoryHierarchies List<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse>

description String

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

itemAttributes GoogleCloudRecommendationengineV1beta1FeatureMapResponse

itemGroupId String

Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.

languageCode String

Deprecated:

productMetadata GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse

Optional. Metadata specific to retail products.

tags List<String>

title String

Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

categoryHierarchies GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse[]

description string

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

itemAttributes GoogleCloudRecommendationengineV1beta1FeatureMapResponse

itemGroupId string

Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.

languageCode string

Deprecated:

productMetadata GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse

Optional. Metadata specific to retail products.

tags string[]

title string

Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

category_hierarchies Sequence[GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse]

description str

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

item_attributes GoogleCloudRecommendationengineV1beta1FeatureMapResponse

item_group_id str

Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.

language_code str

Deprecated:

product_metadata GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse

Optional. Metadata specific to retail products.

tags Sequence[str]

title str

Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

categoryHierarchies List<Property Map>

description String

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

itemAttributes Property Map

itemGroupId String

Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.

languageCode String

Deprecated:

productMetadata Property Map

Optional. Metadata specific to retail products.

tags List<String>

title String

Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

Supporting Types

GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse

Categories List<string>: Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).

Categories []string: Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).

categories List<String>: Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).

categories string[]: Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).

categories Sequence[str]: Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).

categories List<String>: Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).

GoogleCloudRecommendationengineV1beta1FeatureMapResponse

CategoricalFeatures Dictionary<string, string>: Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}
NumericalFeatures Dictionary<string, string>: Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

CategoricalFeatures map[string]string: Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}
NumericalFeatures map[string]string: Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

categoricalFeatures Map<String,String>: Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}
numericalFeatures Map<String,String>: Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

categoricalFeatures {[key: string]: string}: Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}
numericalFeatures {[key: string]: string}: Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

categorical_features Mapping[str, str]: Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}
numerical_features Mapping[str, str]: Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

categoricalFeatures Map<String>: Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}
numericalFeatures Map<String>: Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

GoogleCloudRecommendationengineV1beta1ImageResponse

Height int: Optional. Height of the image in number of pixels.
Uri string: URL of the image with a length limit of 5 KiB.
Width int: Optional. Width of the image in number of pixels.

Height int: Optional. Height of the image in number of pixels.
Uri string: URL of the image with a length limit of 5 KiB.
Width int: Optional. Width of the image in number of pixels.

height Integer: Optional. Height of the image in number of pixels.
uri String: URL of the image with a length limit of 5 KiB.
width Integer: Optional. Width of the image in number of pixels.

height number: Optional. Height of the image in number of pixels.
uri string: URL of the image with a length limit of 5 KiB.
width number: Optional. Width of the image in number of pixels.

height int: Optional. Height of the image in number of pixels.
uri str: URL of the image with a length limit of 5 KiB.
width int: Optional. Width of the image in number of pixels.

height Number: Optional. Height of the image in number of pixels.
uri String: URL of the image with a length limit of 5 KiB.
width Number: Optional. Width of the image in number of pixels.

GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPriceResponse

DisplayPrice double: Optional. Display price of the product.
OriginalPrice double: Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.

DisplayPrice float64: Optional. Display price of the product.
OriginalPrice float64: Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.

displayPrice Double: Optional. Display price of the product.
originalPrice Double: Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.

displayPrice number: Optional. Display price of the product.
originalPrice number: Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.

display_price float: Optional. Display price of the product.
original_price float: Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.

displayPrice Number: Optional. Display price of the product.
originalPrice Number: Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.

GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRangeResponse

Max double: The maximum product price.
Min double: The minimum product price.

Max float64: The maximum product price.
Min float64: The minimum product price.

max Double: The maximum product price.
min Double: The minimum product price.

max number: The maximum product price.
min number: The minimum product price.

max float: The maximum product price.
min float: The minimum product price.

max Number: The maximum product price.
min Number: The minimum product price.

GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse

AvailableQuantity string: Optional. The available quantity of the item.
CanonicalProductUri string: Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..
Costs Dictionary<string, string>: Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)
CurrencyCode string: Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.
ExactPrice Pulumi.GoogleNative.Recommendationengine.V1Beta1.Inputs.GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPriceResponse: Optional. The exact product price.
Images List<Pulumi.GoogleNative.Recommendationengine.V1Beta1.Inputs.GoogleCloudRecommendationengineV1beta1ImageResponse>: Optional. Product images for the catalog item.
PriceRange Pulumi.GoogleNative.Recommendationengine.V1Beta1.Inputs.GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRangeResponse: Optional. The product price range.
StockState string: Optional. Online stock state of the catalog item. Default is IN_STOCK.

AvailableQuantity string: Optional. The available quantity of the item.
CanonicalProductUri string: Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..
Costs map[string]string: Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)
CurrencyCode string: Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.
ExactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPriceResponse: Optional. The exact product price.
Images []GoogleCloudRecommendationengineV1beta1ImageResponse: Optional. Product images for the catalog item.
PriceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRangeResponse: Optional. The product price range.
StockState string: Optional. Online stock state of the catalog item. Default is IN_STOCK.

availableQuantity String: Optional. The available quantity of the item.
canonicalProductUri String: Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..
costs Map<String,String>: Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)
currencyCode String: Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.
exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPriceResponse: Optional. The exact product price.
images List<GoogleCloudRecommendationengineV1beta1ImageResponse>: Optional. Product images for the catalog item.
priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRangeResponse: Optional. The product price range.
stockState String: Optional. Online stock state of the catalog item. Default is IN_STOCK.

availableQuantity string: Optional. The available quantity of the item.
canonicalProductUri string: Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..
costs {[key: string]: string}: Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)
currencyCode string: Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.
exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPriceResponse: Optional. The exact product price.
images GoogleCloudRecommendationengineV1beta1ImageResponse[]: Optional. Product images for the catalog item.
priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRangeResponse: Optional. The product price range.
stockState string: Optional. Online stock state of the catalog item. Default is IN_STOCK.

available_quantity str: Optional. The available quantity of the item.
canonical_product_uri str: Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..
costs Mapping[str, str]: Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)
currency_code str: Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.
exact_price GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPriceResponse: Optional. The exact product price.
images Sequence[GoogleCloudRecommendationengineV1beta1ImageResponse]: Optional. Product images for the catalog item.
price_range GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRangeResponse: Optional. The product price range.
stock_state str: Optional. Online stock state of the catalog item. Default is IN_STOCK.

availableQuantity String: Optional. The available quantity of the item.
canonicalProductUri String: Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..
costs Map<String>: Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)
currencyCode String: Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.
exactPrice Property Map: Optional. The exact product price.
images List<Property Map>: Optional. Product images for the catalog item.
priceRange Property Map: Optional. The product price range.
stockState String: Optional. Online stock state of the catalog item. Default is IN_STOCK.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

google-native.recommendationengine/v1beta1.getCatalogItem

Using getCatalogItem

getCatalogItem Result

Supporting Types

GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchyResponse

GoogleCloudRecommendationengineV1beta1FeatureMapResponse

GoogleCloudRecommendationengineV1beta1ImageResponse

GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPriceResponse

GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRangeResponse

GoogleCloudRecommendationengineV1beta1ProductCatalogItemResponse

Package Details

Contents