REST Resource: projects.locations.products

Ressource: Produkt

Ein Produkt enthält ReferenceImages.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "description": string,
  "productCategory": string,
  "productLabels": [
    {
      object (KeyValue)
    }
  ]
}
Felder
name

string

Der Ressourcenname des Produkts.

Das Format ist: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Dieses Feld wird beim Erstellen eines Produkts ignoriert.

displayName

string

Der vom Nutzer bereitgestellte Name für dieses Produkt. Darf nicht leer sein. Darf höchstens 4.096 Zeichen lang sein.

description

string

Vom Nutzer bereitgestellte Metadaten, die mit diesem Produkt gespeichert werden sollen. Darf höchstens 4.096 Zeichen lang sein.

productCategory

string

Nicht veränderbar. Die Kategorie des zum Referenzbild gehörenden Produkts. Geben Sie „homegoods-v2“, „apparel-v2“ oder „toys-v2“ ein. Die älteren Kategorien „homegoods“, „apparel“ und „toys“ werden weiterhin unterstützt, sollten aber nicht für neue Produkte verwendet werden.

productLabels[]

object (KeyValue)

Schlüssel/Wert-Paare, die an ein Produkt angehängt werden können. Zum Zeitpunkt der Abfrage können Einschränkungen basierend auf den productLabels festgelegt werden.

Ganzzahlwerte können als Strings bereitgestellt werden, z. B. „1199“. Nur Strings mit ganzzahligen Werten können einer bereichsbasierten Einschränkung entsprechen. Diese Funktion wird bald unterstützt.

Einem Schlüssel können mehrere Werte zugewiesen werden. Ein Produkt kann bis zu 500 productLabels haben.

Beachten Sie, dass die Gesamtzahl unterschiedlicher productLabels für alle Produkte in einem ProductSet nicht größer als 1 MB ist. Andernfalls kann die Produktsuchpipeline nicht für diese Produktgruppe arbeiten.

KeyValue

Ein Produktlabel, das als Schlüssel/Wert-Paar dargestellt wird.

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

Der Schlüssel des Labels, das an das Produkt angehängt ist. Darf nicht leer sein und 128 Byte nicht überschreiten.

value

string

Der Wert des Labels, das an das Produkt angehängt wird. Darf nicht leer sein und 128 Byte nicht überschreiten.

Methoden

create

Erstellt eine neue Produktressource und gibt diese zurück.

delete

Löscht ein Produkt und seine Referenzbilder endgültig.

get

Ruft Informationen zu einem Produkt ab.

list

Listet Produkte in nicht spezifizierter Reihenfolge auf.

patch

Änderungen an einer Produktressource vornehmen.

purge

Asynchrone API zum Löschen aller Produkte in einem ProductSet oder aller Produkte, die nicht in einem ProductSet vorhanden sind.