Produktpaletten-Collection-API

Du kannst mit dieser API Collections für die Verwendung in Shops erstellen und einer Produktpalette Metadaten wie etwa ein Titelbild und eine Beschreibung hinzufügen. Diese Produktpaletten können anschließend als Collections in Commerce Manager für die individuelle Anpassung deines Facebook bzw. Instagram Shops genutzt werden (ansonsten werden Collections manuell erstellt). Du kannst diese fertigen Produktpaletten auch direkt veröffentlichen, indem du die Shop-IDs bereitstellst. Shop-IDs können über die Nutzung von Commerce APIs abgerufen werden.

Weitere Informationen findest du im Hilfebereich für Unternehmen unter Eine Collection im Commerce Manager erstellen.

POST (API erstellen/aktualisieren)

Das Erstellen und Aktualisieren von Produktpaletten bleibt unverändert. Es sind jedoch einige neue optionale Felder zu beachten:

Metadatenfelder

Felder für die Veröffentlichung in Shops

In das Feld publish_to_shops kann ein leeres Array oder ein Array mit den im Beispiel unten gezeigten Parametern eingegeben werden. Wenn du ein leeres Array angibst, wird die betreffende Produktpalette in allen Shops nicht mehr veröffentlicht (also zurückgezogen, wenn sie zuvor veröffentlicht worden war).

Beispiel: Payload

{ 
    "name": "Best sellers",
    "filter": {
      "retailer_id": {
        "is_any": [
          "pid1",
          "pid2"
        ]
      } 
    },
    "metadata": {
      "cover_image_url": "https://foo.com/image.jpg" (https://foo.com/image.jpg%E2%80%9D),
      "external_url": "https://foo.com/best-sellers",
      "description":"Our best selling products"
    }
  "publish_to_shops": [{"shop_id": "shop_id1"}, {"shop_id": "shop_id2"}]
}

Produktpalette erstellen

So erstellst du eine Produktpalette mit Collection-Metadaten, die konkreten Produkt-IDs entsprechen:

curl \
  -F "name=Best Sellers" \
  -F "filter={'retailer_id': {'is_any': ['pid1', 'pid2']}}" 
  -F "metadata={'cover_image_url':'https://foo.com/image.jpg', 'external_url':'https://foo.com/best-sellers', 'description':'Our best selling products'}" \
  -F "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/API_VERSION/PRODUCT_CATALOG_ID/product_sets

Produktpalette aktualisieren

So aktualisierst du eine vorhandene Produktpalette mit Collection-Metadaten und veröffentlichst sie in den Shops:

curl \
  -F "name=Updated Best Sellers" \
  -F "metadata={'cover_image_url':'https://foo.com/image_updated.jpg', 'external_url':'https://foo.com/best-sellers-updated', 'description':'Our updated best selling products'}" \
  -F "publish_to_shops=[{'shop_id':'shop_id1'}, {'shop_id':'shop_id2'}]"
  -F "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/API_VERSION/PRODUCT_SET_ID

GET (API lesen)

Im Node GET gibt das Feld live_metadata Metadaten zurück, die in einer bestimmten Produktpalette veröffentlicht werden und live sind. Das Feld latest_metadata hingegen gibt die Metadaten zurück, die zuletzt an die API gesendet wurden. Diese Felder unterscheiden sich voneinander, wenn zum Beispiel ein Bild bei einem Update geändert, aber aus Integritätsgründen abgelehnt wurde.

Metadatenfelder

Beispiel: Produktpalette lesen, um zu ermitteln, welche Metadaten live sind:

curl -G \
  -d "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/<API_VERSION>/<PRODUCT_SET_ID>/?fields=id,name,latest_metadata{cover_image_url, description, review_status},live_metadata{cover_image_url, description, review_status}

Antwort:

{ 
    "id": 1234567890,
    "name": "Best sellers",
    "latest_metadata": {
        "cover_image_url": "https://foo.com/some_new_image.jpg" (https://foo.com/image.jpg%E2%80%9D),
        "description":"Our best selling products",
        "integrity_review_status": "REJECTED"
    },
    "live_metadata": {
        "cover_image_url": "https://foo.com/some_good_image.jpg", 
        "description":"Our best selling products",
        "integrity_review_status": "APPROVED"
    }
}

FAQs

F: Wie lautet das kleinste akzeptable Bildseitenverhältnis für ein Titelbild?

A: Bilder müssen mindestens 600 x 600 Pixel groß sein (bei diesem Seitenverhältnis kann das Bild jedoch nicht zugeschnitten werden). Wenn du ein 800 x 800 Pixel großes Bild hochlädst, wird standardmäßig ein quadratisches Bildseitenverhältnis ausgewählt. Wir empfehlen ein Seitenverhältnis von 1080 x 1080.

F: Wie groß darf die Datei eines Titelbilds maximal sein?

A: Die maximale Dateigröße beträgt 8 MB.

F: Welche Dateiformate werden bei Titelbildern unterstützt?

A: JPG und PNG.

F: Gibt es bei den Beschreibungen Längenbeschränkungen?

A: Es gibt keine Mindestlänge bei Beschreibungen, aber die Höchstlänge beträgt 200 Zeichen.

F: Wie hebe ich die Veröffentlichung einer Collection (Produktpalette) in Shops auf?

A: Indem du unter „API aktualisieren“ das Feld shop_id aus der Liste publish_to_shop entfernst, in der es zuvor veröffentlicht worden war. Bei Angabe eines leeren Arrays ([]) würde die Veröffentlichung der Produktpalette in allen Shops rückgängig gemacht.

Mehr dazu

• Hilfebereich für Unternehmen: Eine Collection im Commerce Manager erstellen
• MAPI-Referenz: Produktpaletten