Product

google.cloud.retail.v2beta. Product

Represents a Product.

Constructor

new Product(propertiesopt)

Constructs a new Product.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2beta.IProduct <optional>

Properties to set

Implements:
  • IProduct

Members

attributes

Product attributes.

audience

Product audience.

availability

Product availability.

availableQuantity

Product availableQuantity.

availableTime

Product availableTime.

brands

Product brands.

categories

Product categories.

collectionMemberIds

Product collectionMemberIds.

colorInfo

Product colorInfo.

conditions

Product conditions.

description

Product description.

expiration

Product expiration.

expireTime

Product expireTime.

fulfillmentInfo

Product fulfillmentInfo.

gtin

Product gtin.

id

Product id.

images

Product images.

languageCode

Product languageCode.

localInventories

Product localInventories.

materials

Product materials.

name

Product name.

patterns

Product patterns.

priceInfo

Product priceInfo.

primaryProductId

Product primaryProductId.

promotions

Product promotions.

publishTime

Product publishTime.

rating

Product rating.

retrievableFields

Product retrievableFields.

sizes

Product sizes.

tags

Product tags.

title

Product title.

ttl

Product ttl.

type

Product type.

uri

Product uri.

variants

Product variants.

Availability

Availability enum.

Properties:
Name Type Description
AVAILABILITY_UNSPECIFIED number

AVAILABILITY_UNSPECIFIED value

IN_STOCK number

IN_STOCK value

OUT_OF_STOCK number

OUT_OF_STOCK value

PREORDER number

PREORDER value

BACKORDER number

BACKORDER value

Type

Type enum.

Properties:
Name Type Description
TYPE_UNSPECIFIED number

TYPE_UNSPECIFIED value

PRIMARY number

PRIMARY value

VARIANT number

VARIANT value

COLLECTION number

COLLECTION value

Methods

toJSON() → {Object.<string, *>}

Converts this Product to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.retail.v2beta.Product}

Creates a new Product instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2beta.IProduct <optional>

Properties to set

Returns:
Type Description
google.cloud.retail.v2beta.Product

Product instance

(static) decode(reader, lengthopt) → {google.cloud.retail.v2beta.Product}

Decodes a Product message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.retail.v2beta.Product

Product

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.retail.v2beta.Product}

Decodes a Product message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.retail.v2beta.Product

Product

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Product message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2beta.IProduct

Product message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Product message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2beta.IProduct

Product message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.retail.v2beta.Product}

Creates a Product message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.retail.v2beta.Product

Product

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Product

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Product message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2beta.Product

Product

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Product message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not