Referenz

Verwende diese Referenz, um die unterstützten Felder und die entsprechenden Beispiele für die Endpunkte POST /{catalog_id}/items_batch und POST /{catalog_id}/batch anzuzeigen.

Die Parameternamen für /{catalog_id}/batch und /{catalog_id}/items_batch ähneln sich möglicherweise auf den ersten Blick, sind aber völlig unterschiedlich.

Wir empfehlen, /{catalog_id}/items_batch API zu verwenden, die mehr Anwendungsfälle unterstützt und aktiv gepflegt wird.

Unterstützte Felder – Artikel-Updates senden – /{catalog_id}/batch

Diese Felder werden für die Methoden CREATE und UPDATE unterstützt.

Löschen von Feldern

Gib bei der Aktualisierung von Artikeln eine leere Zeichenfolge als Wert ein, um ein optionales Feld zu löschen. Durch Festlegen des Werts auf null wird das Feld nicht gelöscht.

Feld Beschreibung

additional_image_urls

Typ:

Array<string>

Optional.

URLs für bis zu 9–10 verschiedene Bilder.

additional_variant_attributes

Typ:

list<KeyValue:string,string>

Optional.

Zusätzliche Eigenschaften, um das Produkt in seiner Variantengruppe zu unterscheiden.

Beispiel: {"Scent" : "Fruity", "Style" : "Classic"}

availability

Typ: String

Erforderlich.

Gibt den Verfügbarkeitsstatus an:

  • in stock: Artikel wird sofort versendet.
  • out of stock: keine Auffüllung des Bestands geplant
  • available for order: wird in 1–2 Wochen versendet.
  • discontinued

age_group

Typ: String

Optional.

Gruppe von Personen, die das gleiche oder ein ähnliches Alter aufweisen. Akzeptierte Werte sind newborn, infant, toddler, kids, adult.

applinks

Typ:

object<>

Optional.

Links zu mobilen Apps.

category

Typ: String

Optional, aber bei Advantage+ Catalog Ads empfohlen (kann zur Verbesserung der Anzeigenleistung beitragen). Optional für Instagram Shopping und Seiten-Shops, aber erforderlich, um Onsite-Checkout auf diesen Kanälen (nur in den USA) zu ermöglichen. Erforderlich für Marketplace (nur in den USA).

Die Google-Produktkategorie (GPC) für den Artikel. Verwende den Taxonomie-Pfad oder die ID-Nummer der Kategorie aus dieser Liste.

Wenn du Kaufabschluss auf Facebook und Instagram (nur in den USA) verwendest, wirkt sich die GPC eines Artikels auf die Steuern und Rückgaberichtlinie aus. Erfahre mehr über die Google-Produktkategorie für Katalogartikel, Hilfebereich für Werbung.

Beispiel: Apparel & Accessories > Clothing > Shirts & Tops oder 212

color

Typ: String

Optional.

Maximale Größe: 100.

Artikelfarbe.

condition

Typ: String

Erforderlich.

Zustand des Artikels: new, refurbished, used.

currency

Typ: String

Erforderlich.

Währung für den angegebenen Wert. Die Marketing API unterstützt alle Währungen, die von Werbekonten unterstützt werden. Verwende ISO 4217 für Währungsstandards.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Typ: String

Optional.

Max. Zeichenanzahl: 100

Zusätzliche Informationen zu diesem Artikel. Gib eine leere Zeichenfolge an, um das Feld zu löschen.

description

Typ: String

Erforderlich.

Maximale Größe: 5.000.

Kurze Beschreibung des Artikels.

gender

Typ: String

Optional.

Geschlecht zur Größenbestimmung. Werte sind etwa male, female, unisex.

gtin

Typ: String

Optional.

Maximale Größe: 70.

Die Global Trade Item Number kann UPC,EAN, JAN und ISBN sein.

image_url

Typ: String

Erforderlich.

Link zum Artikelbild, das in der Anzeige verwendet wird. Gib korrekte Bildgrößen an.

Für Advantage+ Catalog Ads mit einem Bild

  • Erforderliche minimale Bildauflösung beträgt 500 px * 500 px.
  • Erforderliches minimales Seitenverhältnis ist 4:5.
  • Maximales Seitenverhältnis ist 1:91:1.

Wenn das Bild außerhalb dieses Seitenverhältnisses liegt, schneidet Facebook es so zu, dass es dem minimalen oder maximalen Seitenverhältnis am nächsten kommt, je nach dem ursprünglichen Seitenverhältnis.

Für Advantage+ Catalog Ads mit Carousel-Bild: mindestens erforderliche Auflösung ist 500 px * 500 px und Facebook schneidet es auf ein 1:1-Seitenverhältnis zu.

Empfehlung: Vermeide häufige Änderungen der image url. Bild-URLs sollten keine Parameter enthalten, wie z. B. price oder timestamp, da sich diese normalerweise häufig ändern.

inventory

Typ: Zahl

Optional.

Ganzzahl, die von Werbetreibenden verwendet werden kann, um Informationen über den Lagerstand zu speichern.

marked_for_product_launch

Typ: String

N/A für Advantage+ Catalog Ads. Für den Handel optional.

Gibt an, ob ein Artikel in einem Produkt-Launch verwendet wird. Mögliche Werte:

  • marked: Der Artikel bleibt für Käufer*innen verborgen, bis der Produkt-Launch erstellt wurde. Dies verhindert, dass der Artikel vor der gewünschten Startzeit verfügbar und kaufbar wird.
  • not_marked (Standard): Der Artikel wird nicht Teil eines Produkt-Launchs sein.

name

Typ: String

Erforderlich.

Maximale Größe: 100.

Titel des Artikels.

pattern

Typ: String

Optional.

Maximale Größe: 100.

Muster oder Grafikdruck auf einem Artikel.

price

Typ: Integer

Erforderlich.

Der Preis multipliziert mit 100, für alle Währungen. Beispiel: 490 bedeutet bei Verwendung mit USD 4,90 $ und 49.000 bei Verwendung mit JPY 490 ¥.

product_type

Typ: String

Optional.

Maximale Größe: 750.

Artikelkategorie nach Definition des Einzelhändlers.

Beispiel: in TSV Heim und Garten > Küche und Essen > Geräte > Kühlschränke.

Beispiel: in XML product_type > Heim und Garten > Küche und Essen > Geräte > Kühlschränke > product_type.

retailer_product_group_id

Typ: String

Optional.

Akzeptiert Strings. Werbetreibende können damit Produkte gruppieren.

sale_price

Typ: Integer

Optional.

Reduzierter Preis, wenn der Artikel im Angebot ist. Dies ist der Aktionspreis multipliziert mit 100, für alle Währungen. Beispiel: 490 bedeutet bei Verwendung mit USD 4,90 $ und 49.000 bei Verwendung mit JPY 490 ¥.

sale_price_start_date

Typ: String

Optional.

Enddatum und Uhrzeit für den Verkauf.

Beispiel: 2014-12-01T00:00-0300

sale_price_end_date

Typ: String

Optional.

Startdatum und Uhrzeit für den Verkauf.

2014-11-01T12:00-0300

shipping

Typ:

Array<object>

Optional.

Versandinformationen.

size

Typ: String

Optional.

Größe des Artikels. Beispiel: Small oder XL.

url

Typ: String

Erforderlich.

Link zur Website des Händlers, auf der man den Artikel erwerben kann.

vendor_id

Typ: String

Optional.

Die ID des Verkäufers/Händlers, der den Artikel verkauft.

Beispielanfrage: /{catalog_id}/batch

{
  "access_token": "<ACCESS_TOKEN>",
  "requests": [
    {
      "method": "DELETE",
      "retailer_id": "retailer-1"
    },
    {
      "method": "CREATE",
      "retailer_id": "retailer-2",
      "data": {
        "availability": "in stock",
        "brand": "Nike",
        "category": "t-shirts",
        "description": "product description",
        "image_url": "http://www.images.example.com/t-shirts/1.png",
        "name": "product name",
        "price": 1000,
        "currency": "USD",
        "shipping": [
           {
              "country": "US",
              "region": "CA",
              "service": "service",
              "price_value": "10",
              "price_currency": "USD"
           }
        ],
        "condition": "new",
        "url":"http://www.images.example.com/t-shirts/1.png",
        "retailer_product_group_id": "product-group-1"
      },
      "applinks": {
          "android": [{
              "app_name": "Electronic Example Android",
              "package": "com.electronic",
              "url": "example-android://electronic"
              }],
          "ios": [{
              "app_name": "Electronic Example iOS",
              "app_store_id": 2222,
              "url": "example-ios://electronic"
              }]
      },
    },
    {
      "method": "UPDATE",
      "retailer_id": "retailer-3",
      "data": {
        "availability": "out of stock",
      }
    }
  ]
}

Beispielantwort: /{catalog_id}/batch

Ein oder mehrere Handles werden zurückgegeben.

"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch

Unterstützte Felder – Produkt-Updates senden – /{catalog_id}/items_batch

Für kommerzielle Kataloge – Verwende diese API, wenn du Produktinformationen häufiger als einmal pro Stunde aktualisieren musst (verwende andernfalls die Feed API). Du kannst mehrere Objekte über eine einzelne HTTP-Anfrage aktualisieren.

PRODUCT_ITEM

Diese Produktfelder werden für die Methoden CREATE und UPDATE unterstützt, für Version 3.3 und 3.2:

FeldBeschreibung

additional_image_link

Typ:

Array<string>

Optional.

Link für bis zu 9–10 verschiedene Bilder.

additional_variant_attribute

Typ:

list<KeyValue:string,string>

Optional.

Zusätzliche Eigenschaften, um das Produkt in seiner Variantengruppe zu unterscheiden.

Beispiel: "Scent:Fruity,Flavor:Apple"

age_group

Typ: String

Optional.

Gruppe von Personen, die das gleiche oder ein ähnliches Alter aufweisen. Akzeptierte Werte sind newborn, infant, toddler, kids, adult.

applink

Typ:

Objekt<string>

Optional.

Links zu mobilen Apps.

Beispiel:

"applink" : {
  "ios_url": "example-ios://electronic",
  "ios_app_store_id": "42",
  "ios_app_name": "Electronic Example iOS",
  "iphone_url": "example-iphone://electronic",
  "iphone_app_store_id": "43",
  "iphone_app_name": "Electronic Example iPhone",
  "ipad_url": "example-ipad://electronic",
  "ipad_app_store_id": "44",
  "ipad_app_name": "Electronic Example iPad",
  "android_url": "example-android://electronic",
  "android_package": "com.electronic",
  "android_class": "com.electronic.Example",
  "android_app_name": "Electronic Example Android",
  "windows_phone_url": "example-windows://electronic",
  "windows_phone_app_id": "64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
  "windows_phone_app_name": "Electronic Example Windows",
}

availability

Typ: String

Erforderlich.

Gibt den Verfügbarkeitsstatus an:

  • in stock: Artikel wird sofort versendet
  • out of stock: keine Auffüllung des Bestands geplant
  • available for order: wird in 1–2 Wochen versendet
  • discontinued

brand

Typ: String

Optional.

Marke des Artikels.

color

Typ: String

Optional.

Maximale Größe: 100.

Artikelfarbe.

condition

Typ: String

Erforderlich.

Produktzustand: new, refurbished oder used.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Typ: String

Optional.

Max. Zeichenanzahl: 100

Zusätzliche Informationen zu diesem Artikel.

description

Typ: String

Erforderlich.

Maximale Größe: 5.000.

Kurzer Text zur Produktbeschreibung.

disabled_capabilities

Typ:

Array<string>

Optional.

Liste der Funktionen, die deaktiviert werden sollen. Mögliche Werte sind: marketplace, b2c_marketplace, buy_on_facebook, cpas_parent_catalog, marketplace_shops, shops, daily_deals, ig_onsite_shopping, ig_product_tagging, c2c_marketplace, groups, profile, da, whatsapp, ldp, mini_shops, business_inbox_in_messenger, neighborhoods, test_capability.

gender

Typ: String

Optional.

Geschlecht zur Größenbestimmung. Werte sind etwa male, female, unisex.

google_product_category

Typ: String

Optional.

Max. Größe: 250.

Vordefinierte Werte (String oder Kategorie-ID) aus der Produkttaxonomie von Google.

Beispiel: Bekleidung und Accessoires > Kleidung > Kleider oder 2271.

gtin

Typ: String

Optional.

Maximale Größe: 70.

Global Trade Item Number (GTIN) kann UPC, EAN, JAN und ISBN umfassen.

id

Typ: String

Erforderlich.

Händler-ID

image

Typ: Array <object>

URLs und Tags für Bilder, die in deinen Anzeigen oder in Shops verwendet werden sollen. Unterstützt bis zu 20 verschiedene Bilder. Schlagwörter sind optional und sollten, wenn verwendet, beschreiben, was auf dem Bild zu sehen ist.


Beispiel:

"image": [
      {
        "url":"http://example.com/image_1.jpg",
        "tag": ['Swimming pool','Gym'],
      }
]

image_link

Typ: String

Nicht erforderlich, wenn image bereitgestellt wird.

Wir empfehlen, stattdessen image zu verwenden. Wenn image bereitgestellt wird, werden image_link und additional_image_link ignoriert.

Link zum Artikelbild, das in der Anzeige verwendet wird. Gib korrekte Bildgrößen an.

Für Advantage+ Catalog Ads mit einem Bild:

  • Minimale erforderliche Bildauflösung ist 500 px * 500 px.
  • Minimales erforderliches Seitenverhältnis ist 4:5.
  • Maximales Seitenverhältnis ist 1:91:1. Wenn das Bild außerhalb dieses Seitenverhältnisses liegt, schneidet Facebook es so zu, dass es entweder dem minimalen oder dem maximalen Seitenverhältnis am nächsten kommt, je nach dem ursprünglichen Seitenverhältnis.

Für Advantage+ Catalog Ads mit Carousel-Bild: minimale erforderliche Bildauflösung ist 500 px * 500 px und Facebook schneidet es auf ein 1:1-Seitenverhältnis zu.

internal_label

Typ: String

Füge interne Labels hinzu, um beispielsweise beim Erstellen von Produktauswahlen nach deinen Artikeln zu filtern. Beispiel: Mithilfe des selbstdefinierten Labels „summer“ (Sommer) könntest du alle Artikel kennzeichnen, die Teil einer Sommeraktion sind, und diese dann in eine Produktauswahl filtern. Labels sind nur für dich sichtbar.

Jedes Label muss in einfachen Anführungszeichen (') stehen und mehrere Labels müssen durch Kommata (,) getrennt sein. Weder am Anfang noch am Ende darf es Leerräume bzw. überflüssige Leerzeichen geben. Zeichenlimit: bis zu 5.000 Labels pro Produkt und 110 Zeichen pro Label.

Beispiel (TSV, XLSX, Google Sheets): ['summer','trending']

Beispiel (CSV): “['summer','trending']”

Hinweis: Wenn du derzeit selbstdefinierte Labels (custom_label_0 bis custom_label_4) zum Filtern von Produktauswahlen verwendest, empfiehlt es sich, stattdessen auf interne Labels (internal_label) umzusteigen. Anders als bei selbstdefinierten Labels kannst du interne Labels beliebig oft hinzufügen oder ändern, ohne dass die Artikel die Richtlinienprüfung erneut durchlaufen müssen, was sich auf die Anzeigenauslieferung auswirken kann.

Dieses Feld hieß zuvor product_tags. Wir unterstützen weiterhin die ehemalige Feldbezeichnung. Dennoch empfehlen wir dir, die neue Bezeichnung zu verwenden.

inventory

Typ: Objekt

Optional.

Ganzzahl, die von Werbetreibenden verwendet werden kann, um Informationen über den Lagerstand zu speichern.

item_group_id

Typ: String

Optional.

Die von dem Werbetreibenden bereitgestellte ID einer Produktgruppe; nicht die FBID. Akzeptiert Strings. Wird von Werbetreibenden verwendet, um eine Vielzahl von unterschiedlichen Objekten (Produktartikel, Fahrzeuge, Hotels, Flüge usw.) zu gruppieren.

link

Typ: String

Erforderlich.

Link zur Website des Händlers, auf der man den Artikel erwerben kann.

manufacturer_part_number

Typ: String

Optional.

Eindeutige Hersteller-ID für das Produkt.

pattern

Typ: String

Optional.

Maximale Größe: 100.

Muster oder Grafikdruck auf einem Produkt.

price

Typ: String

Erforderlich.

Preis des Artikels. Formatiere den Preis als die Kosten gefolgt vom dreistelligen ISO-Währungscode mit einem Leerzeichen zwischen dem Betrag und der Währung.

Beispiel: 9.99 USD.

rating_count

Typ: Zahl

Optional.

Die Anzahl der Bewertungen, die Käufer*innen für dieses Produkt abgegeben haben. Muss größer als 0 sein. Dies sollte nur zusammen mit user_rating verwendet werden.

Beispiel: 100

sale_price

Typ: String

Optional, aber erforderlich, um die Overlay-Funktion für Advantage+ Catalog Ads zu verwenden.

Reduzierter Preis, wenn der Artikel rabattiert zum Verkauf steht. Formatiere den Preis als die Kosten gefolgt vom dreistelligen ISO-Währungscode mit einem Leerzeichen zwischen dem Betrag und der Währung.

Beispiel: 9.99 USD, 25.00 EUR

sale_price_effective_date

Typ: String

Optional.

Start- und Enddatum und -uhrzeit für den Verkauf, durch einen Schrägstrich getrennt. Schreibe die Start- und Enddaten im Format JJJJ-MM-TT. Füge nach jedem Datum „T“ hinzu und gib dann die Uhrzeit an. Schreibe die Zeit im 24-Stunden-Format (0:00 bis 23:59).

Beispiel: 2014-11-01T12:00-0300/2014-12-01T00:00-0300.

shipping

Typ: String

Optional.

Blob mit unterschiedlichen Preisen für jedes Land und jede Region. Die einzelnen Regionen werden mit Kommas getrennt. Die Formatierung sollte wie folgt sein: COUNTRY:STATE:SHIPPING_TYPE:PRICE.

US:CA:Ground:9.99 USD, US:NY:Air:15.99 USD

size

Typ: String

Optional.

Größe des Artikels. Beispiel: Small oder XL.

title

Typ: String

Erforderlich.

Maximale Größe: 100.

Titel des Artikels.

user_rating

Typ: Zahl

Optional.

Die durchschnittliche Bewertung, die Käufer*innen für dieses Produkt abgegeben haben. Kann zwischen 1.0 und 5.0 liegen. Eine Dezimalstelle zulässig. Dies sollte nur zusammen mit rating_count verwendet werden.

Beispiel: 4.5

video

Typ: Array <object>

URLs und Tags für Videos, die in deinen Anzeigen oder in Shops verwendet werden sollen. Unterstützt bis zu 30.000 Videos auf Katalogebene. Schlagwörter sind optional und sollten, wenn verwendet, beschreiben, was im Video enthalten ist.


Die maximale Größe für ein Video-Datei beträgt 200 MB. Unterstützte Formate sind etwa .3g2, .3gp, .3gpp, .asf, .avi, .dat, .divx, .dv, .f4v, .flv, .gif, .m2ts, .m4v, .mkv, .mod, .mov, .mp4, .mpe, .mpeg, .mpeg4, .mpg, .mts, .nsv, .ogm, .ogv, .qt, .tod, .ts, .vob und .wmv


Beispiel:

"video": [
      {
        "url":"http://example.com/video_1.mp4",
        "tag": ['Swimming pool','Gym'],
      }
]

Hinweis: Um Video 1 zu löschen, wenn das Produkt Video 1 und 2 hat, entferne Video 1 aus dem Array:

[
  {
    "method": "UPDATE",
    "data": {
      "video": [
        {
          "url": "https://google.com/video_2.mp4",
          "tag": ["video_2"]
        }
      ]
    }
  }
]

Um alle Videos zu löschen, sende ein leeres Array:

[
  {
    "method": "UPDATE",
    "data": {
      "video": []
    }
  }
]

Die Methode UPDATE kann auch zum Erstellen von Artikeln verwendet werden, sofern sie noch nicht vorhanden sind.

Erfahre mehr über Produktfelder in der API-Referenz.

Beispielanfrage: PRODUCT_ITEM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "PRODUCT_ITEM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "id": "retailer-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "id": "retailer-2",
            "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "availability": "in stock",
          "brand": "Nike",
          "google_product_category": "t-shirts",
          "description": "product description",
          "image_link": "http://www.images.example.com/t-shirts/1.png",
          "title": "product name",
          "price": "10.00 USD",
          "shipping": [
               {
                  "shipping_country": "US",
                  "shipping_region": "CA",
                  "shipping_service": "service",
                  "shipping_price_value": "10",
                  "shipping_price_currency": "USD"
               }
          ],
          "condition": "new",
          "link":"http://www.images.example.com/t-shirts/1.png",
          "item_group_id": "product-group-1"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "availability": "out of stock",
          "id": "retailer-3",
        }
      }
    ]
  }

Beispielantwort: PRODUCT_ITEM

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

Erfahre mehr über das Hinzufügen von Katalogartikeln mit einem Datenfeed.


HOTEL

Produktfelder, die für die Methoden CREATE und UPDATE für Typ HOTEL für Version 3.2 unterstützt werden:

FeldBeschreibung

address

Typ:

Objekt<string>

Erforderlich.

Adresse des Hotels.

applink

Typ:

Optional.

Links zu mobilen Apps.

base_price

Typ: String

Erforderlich.

Basispreis für das Hotelzimmer pro Übernachtung. Füge den Währungstyp zum Preis hinzu. Formatiere den Preis als die Kosten gefolgt vom ISO-Währungscode mit einem Leerzeichen zwischen dem Betrag und der Währung. Beispiel: USD für US-Dollar.

brand

Typ: String

Optional.

Marke der Hotelkette.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Typ: String

Max. Zeichenanzahl: 100

Bis zu fünf selbstdefinierte Felder für zusätzliche Informationen, nach denen du Artikel filtern möchtest, wenn du Produktpaletten erstellst. Ein Beispiel: Mithilfe eines selbstdefinierten Feldes kannst du alle Zimmer kennzeichnen, die Teil einer Sommeraktion sind, und diese dann in eine Produktpalette filtern. Dieses Feld unterstützt die Angabe von Textwerten, einschließlich Zahlen.


Beispiel: Summer Sale

Dieses Feld wird von zusätzlichen Feeds unterstützt.

custom_number_0
custom_number_1
custom_number_2
custom_number_3
custom_number_4

Typ: Integer

Bis zu fünf selbstdefinierte Felder für zusätzliche zahlenspezifische Informationen, nach denen du Artikel filtern möchtest, wenn du Produktpaletten erstellst. Mit diesem Feld kannst du Nummernbereiche filtern (größer als und kleiner als), wenn du eine Produktpalette erstellst. Ein Beispiel: Mithilfe eines selbstdefinierten Feldes kannst du das Eröffnungsjahr eines Hotels angeben und dann einen bestimmten Jahresbereich in eine Produktpalette filtern.


Dieses Feld unterstützt ganze Zahlen zwischen 0 und 4294967295. Negative Zahlen, Dezimalzahlen oder Kommawerte werden nicht unterstützt, z. B.: -2, 5.5 oder 10,000.


Beispiel: 2022

description

Typ: String

Erforderlich.

Maximale Zeichengrenze: 5.000.

Kurze Beschreibung des Hotels.

guest_rating

Typ:

Array<object>

Optional.

Gastbewertungen des Hotels.

hotel_id

Typ: String

Erforderlich.

Eindeutige ID für das Hotel.

image

Typ:

Array<object>

Erforderlich.

URLs und Tags für Bilder, die in den Anzeigen verwendet werden sollen. Unterstützt bis zu 20 Bilder. Tag ist optional, wenn verwendet. Sollte beschreiben, was auf dem Bild zu sehen ist. Beispiel: "reception".

latitude

Typ: String

Erforderlich.

Breitengrad des Hotels.

longitude

Typ: String

Erforderlich.

Längengrad des Hotels.

loyalty_program

Typ: String

Optional.

Treueprogramm für das Hotel.

margin_level

Typ: String

Optional.

Indikator für die Gewinnspanne des Hotels; Wert von 1 bis 10.

name

Typ: String

Erforderlich.

Name des Hotels.

neighborhood

Typ:

Array<string>

Optional.

Ein oder mehrere Stadtteile für das Hotel. Beispiel: Soho oder Las Vegas Strip. Maximale Anzahl erlaubter Stadtteile: 20.

phone

Typ: String

Optional.

Telefonnummer mit Ländervorwahl.

sale_price

Typ: String

Optional.

Aktionspreis pro Nacht im Hotel. Bewirb damit Rabatte auf den regulären Hotelpreis. Erforderlich: Füge die Währungsart zum Preis hinzu. Formatiere den Preis als die Kosten gefolgt vom ISO-Währungscode mit einem Leerzeichen zwischen dem Betrag und der Währung. Beispiel: USD für US-Dollar.

star_rating

Typ: String

Optional.

Sternebewertung des Hotels. Die Nummer sollte zwischen 1 und 5 liegen.

url

Typ: String

Erforderlich.

Link zur externen Webseite, auf der das Hotelzimmer gebucht werden kann.

Die Methode UPDATE kann auch zum Erstellen von Artikeln verwendet werden, sofern sie noch nicht vorhanden sind.

Beispielanfrage: HOTEL

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_id": "hotel-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_id": "1234",
          "brand": "Premium_brand",
          "description": "A very nice hotel",
          "name": "The best hotel",
          "base_price": "100.00 USD",
          "longitude":"42.10",
          "latitude":"42.10",
          "address": {
              "addr1":"100 Main Street",
              "city":"North Pole",
              "region":"ABC",
              "country":"US",
              "postal_code":"11111"
          },
          "guest_rating" : [
            {
                "rating_system":"tripAdvisor",
                "score":"7.8",
                "number_of_reviewers":"300",
                "max_score":"10",
            },
            {
                "rating_system":"Yelp",
                "score":"5.1",
                "number_of_reviewers":"123",
                "max_score":"10",
            },
          ],
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ],
          "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "loyalty_program":"Premium_program",
          "margin_level": "8",
          "phone":"+61 2-96027455",
          "star_rating":"4",
          "url":"http://www.images.example.com/t-shirts/1.png"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "base_price": "90.00 USD",
          "hotel_id": "hotel-3",
        }
      }
    ]
  }

Beispielantwort: HOTEL

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOTEL_ROOM

Diese Produktfelder werden für die Methoden CREATE und UPDATE für den Typ HOTEL_ROOM für Version 3.2 unterstützt.

FeldBeschreibung

base_price

Typ: String

Erforderlich.

Basispreis für 1 Nacht. Die Währung sollte den ISO 4217-Währungscodes entsprechen.

Beispiel: 9.99 USD.

description

Typ: String

Erforderlich.

Maximale Größe: 5.000.

Kurze Zimmerbeschreibung.

hotel_retailer_id

Typ: String

Erforderlich.

Eindeutige ID für Hotel-Einzelhändler.

hotel_room_id

Typ: String

Erforderlich.

Eindeutige ID für Hotel.

image

Typ:

Array<object>

Erforderlich.

Bilder des Zimmers.

name

Typ: String

Erforderlich.

Maximale Größe: 100.

Name des Zimmers.

url

Typ: String

Erforderlich.

Link zur Website des Werbetreibenden, auf der man den Aufenthalt buchen kann.

Die Methode UPDATE kann auch zum Erstellen von Artikeln verwendet werden, sofern sie noch nicht vorhanden sind.

Beispielanfrage: HOTEL_ROOM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL_ROOM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-1",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-2",
          "description": "product description",
          "name": "product name",
          "base_price": "100 USD",
          "url": "http://www.example.com/t-shirts/1.html",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ]
      },
      {
        "method": "UPDATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-3",
          "base_price": "120 USD",
        }
      }
    ]
  }

Beispielantwort: HOTEL_ROOM

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

FLIGHT

Diese Produktfelder werden für die Methoden CREATE und UPDATE für den Typ FLIGHT für Version 3.2 unterstützt.

FeldBeschreibung

description

Typ: String

Optional.

Maximale Zeichengrenze: 5.000.

Beschreibung des Flugs.

destination_airport

Typ: String

Erforderlich.

Zielflughafen für den Flug. Sollte als IATA-Code angegeben werden.

Beispiel: SFO.

destination_city

Typ: String

Optional.

Name des Zielorts des Flugs.

image

Typ:

Array<object>

Erforderlich.

URLs und Tags für Bilder, die in den Anzeigen verwendet werden sollen. Unterstützt bis zu 20 Bilder. Tag ist optional. Wenn er verwendet wird, sollte er beschreiben, was im Bild enthalten ist.

Beispiel: seat

origin_airport

Typ: String

Erforderlich.

Abflughafen für den Flug. Sollte als IATA-Code angegeben werden.

Beispiel: SFO

origin_city

Typ: String

Optional.

Name des Abflugorts.

price

Typ: String

Optional.

Die Kosten und Währung des Flugs. Der Preis ist eine Zahl, gefolgt vom Währungscode. Verwende ISO 4217-Standards. Verwende einen Punkt (.) als Dezimaltrennzeichen für den Preis.

url

Typ: String

Optional.

Link zu der Website, auf der du den Flug buchen kannst.

Die Methode UPDATE kann auch zum Erstellen von Artikeln verwendet werden, sofern sie noch nicht vorhanden sind.

Beispielanfrage: FLIGHT

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "FLIGHT",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "JFK",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "SFO",
          "description": "Best Flight to SFO",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Food'],
            }
          ],
          "price":"100.00 USD",
        }
      },
      {
        "method": "UPDATE",
        "data": {

Beispielantwort: FLIGHT

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

DESTINATION

Diese Produktfelder werden für die Methoden CREATE und UPDATE für Typ DESTINATIONfür Version 3.2 unterstützt.

FeldBeschreibung

applink

Typ:

Objekt<string>

Optional.

Links zu mobilen Apps.

address

Typ:

Objekt<string>

Erforderlich.

Adresse des Hotels.

description

Typ: String

Optional.

Maximale Zeichengrenze: 5.000.

Kurze Beschreibung des Reiseziels.

destination_id

Typ: String

Erforderlich.

Maximale Zeichengrenze: 100.

Eindeutige ID für das Ziel.

image

Typ:

Array<object>

Erforderlich.

URLs und Tags für Bilder, die in den Anzeigen verwendet werden sollen. Unterstützt bis zu 20 Bilder. Tag ist optional. Wenn er verwendet wird, sollte er beschreiben, was im Bild enthalten ist.

Beispiel: seat.

latitude

Typ: String

Erforderlich.

Breitengrad des Zielorts.

longitude

Typ: String

Erforderlich.

Breitengrad des Zielorts.

name

Typ: String

Erforderlich.

Name des Zielorts.

neighborhood

Typ:

Array<string>

Optional.

Maximale Anzahl erlaubter Stadtteile: 20. Mindestens ein Stadtteil für das Reiseziel.

Beispiel: Soho oder Las Vegas Strip.

price

Typ: String

Optional.

Günstigster Durchschnittspreis und Währung für den Zielort. Formatiere den Preis als Zahl, gefolgt vom Währungscode. Verwende ISO 4217-Standards. Verwende einen Punkt (.) als Dezimaltrennzeichen für den Preis.

price_change

Typ: String

Optional.

Preisänderung. Kann zum Erstellen von Produktpaletten und in der Anzeigengestaltung genutzt werden:

  • 0: keine Preisänderung
  • -10: 10 % Preisreduzierung
  • 20: 20 % Preiserhöhung

Beispiel: „durchschnittlicher Preis in NYC um X gesunken“ oder „durchschnittlicher Preis in NYC gesunken“

type

Typ:

Array<string>

Erforderlich.

Maximale Anzahl von Zielorttypen: 20. Art(en) von Zielorten. Ein Zielort kann mehrere Typen aufweisen.

Beispiel: park oder beach

url

Typ: String

Erforderlich.

Link zur Website, auf der der Zielort gebucht werden kann.

Die Methode UPDATE kann auch zum Erstellen von Artikeln verwendet werden, sofern sie noch nicht vorhanden sind.

Beispielanfrage: DESTINATION

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "DESTINATION",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "destination_id": "destination-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "destination_id": "123456789",
          "description": "My destination is the best.",
          "name": "The best destination",
          "price": "199.00 USD",
          "price_change": "-20",
          "longitude":"-122.4424",
          "latitude":"37.7712",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City','Package'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Tour','Landmark'],
            }
          ],
          "address": {
              "addr1":"1 Market Street",
              "city":"San Francisco",
              "region":"California",
              "country":"United States",
              "postal_code":"94117"
          },
          "applink" : {
            "ios_url":"example-ios://travelapp",
            "ios_app_store_id":"42",
            "ios_app_name":"Travel App iOS",
            "iphone_url":"example-iphone://travelapp",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Travel App iPhone",
            "ipad_url":"example-ipad://travelapp",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Travel App iPad",
            "android_url":"example-android://travelapp",
            "android_package":"com.travelapp",
            "android_class":"com.travelapp.Example",
            "android_app_name":"Travel App Android",
            "windows_phone_url":"example-windows://travelapp",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Travel App Windows",
          },
          "type":["city","culture"],
          "neighborhood":["Mission","SoMa"],
          "url":"http://www.thebestdestination.com"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "159.99",
          "destination_id": "destination-3",
        }
      }
    ]
  }

Beispielantwort: DESTINATION

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOME_LISTING

Diese Produktfelder werden für die Methoden CREATE und UPDATE für Typ HOME_LISTING für Version 3.3 und 3.2 unterstützt.

FeldBeschreibung

applink

Typ:

Objekt<string>

Optional.

Links zu mobilen Apps.

address

Typ:

Objekt<string>

Erforderlich.

Adresse des Immobilienangebots.

availability

Typ: String

Erforderlich.

Aktuelle Verfügbarkeit der Immobilie. Unterstützte Werte: for_sale, for_rent, sale_pending, recently_sold, off_market, available_soon.

available_dates_price_config

Typ:

Array<object>

Optional.

Preiskonfigurationen

description

Typ: String

Optional.

Maximale Zeichengrenze: 5.000.

Kurzer Absatz, in dem das Immobilienangebot beschrieben wird.

image

Typ:

Array<object>

Erforderlich.

URLs und Tags für Bilder, die in den Anzeigen verwendet werden sollen. Unterstützt bis zu 20 Bilder. Tag ist optional. Wenn er verwendet wird, sollte er beschreiben, was im Bild enthalten ist.

Beispiel: pool.

latitude

Typ: String

Optional.

Breitengrad des Immobilieninserats.

longitude

Typ: String

Optional.

Längengrad des Immobilieninserats.

listing_type

Typ: String

Optional.

Art der Anzeige. Unterstützte Werte: for_rent_by_agent, for_rent_by_owner, for_sale_by_agent, for_sale_by_owner, foreclosed, new_construction, new_listing.

name

Typ: String

Erforderlich.

Name des Immobilieninserats.

neighborhood

Typ:

Array<object>

Optional.

Stadtteil für das Immobilieninserat. Max. zulässige Stadtteile: 20

num_baths

Typ: String

Optional.

Anzahl der Badezimmer.

num_beds

Typ: String

Optional.

Anzahl der Schlafzimmer.

num_units

Typ: String

Optional.

Anzahl der verfügbaren Einheiten. Nur für Wohnungen zu verwenden, die zur Vermietung zur Verfügung stehen.

price

Typ: String

Erforderlich.

Preis und Währung für das Immobilieninserat. Der Preis ist eine Zahl, gefolgt vom Währungscode. Verwende ISO 4217-Standards. Verwende einen Punkt (.) als Dezimaltrennzeichen für den Preis.

price_change

Typ: String

Optional.

Preisänderung. Kann zum Erstellen von Produktpaletten und in der Anzeigengestaltung genutzt werden:

  • 0: keine Preisänderung
  • -10: 10 % Preisreduzierung
  • 20: 20 % Preiserhöhung

Beispiel: „durchschnittlicher Preis in NYC um X gesunken“ oder „durchschnittlicher Preis in NYC gesunken“

property_type

Typ: String

Optional.

Art der Immobilie. Unterstützte Werte: apartment, condo, house, land, manufactured, other, townhouse.

url

Typ: String

Erforderlich.

Link zur Website, auf der das Inserat zu finden ist.

year_built

Typ: String

Optional.

Jahr, in dem das Haus erbaut wurde.

Die Methode UPDATE kann auch zum Erstellen von Artikeln verwendet werden, sofern sie noch nicht vorhanden sind.

Beispielanfrage: HOME_LISTING

{
  "access_token": "<ACCESS_TOKEN>",
  "item_type": "HOME_LISTING",
  "requests": [
    {
      "method": "DELETE",
      "data": {
        "home_listing_id": "home-listing-1"
      }
    },
    {
      "method": "CREATE",
      "data": {
        "home_listing_id": "12345678",
        "availability": "for_sale",
        "description": "An amazing listing",
        "name": "1 Hacker Way, Menlo Park, CA 94025",
        "price": "110000 USD",
        "longitude":"1.11414",
        "latitude":"-1.835003",
        "address": {
            "addr1":"1 Hacker Way",
            "city":"Menlo Park",
            "region":"California",
            "country":"United States",
            "postal_code":"94025"
        },
        "neighborhood":["Menlo Oaks"],
        "image": [
          {
              "url":"http://img10.naventcdn.com/avisos/18/00/52/30/31/52/1200x1200/63590918.jpg",
          },
        ],
        "listing_type": "for_sale_by_agent",
        "num_baths":"6",
        "num_beds":"5",
        "num_units":"1",
        "property_type":"house",
        "year_built":"2007",
        "available_dates_price_config" : [
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"10000",
              "currency":"USD",
              "interval":"nightly",
          },
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"50000",
              "currency":"USD",
              "interval":"weekly",
          },
        ],
        "applink" : {
          "ios_url":"example-ios://travelapp",
          "ios_app_store_id":"42",
          "ios_app_name":"Travel App iOS",
          "android_url":"example-android://travelapp",
          "android_package":"com.travelapp",
          "android_class":"com.travelapp.Example",
          "android_app_name":"Travel App Android",
        },
        "url":"http://www.example.com/link_to_listing"
      }
    },
    {
      "method": "UPDATE",
      "data": {
        "price": "100000 USD",
        "home_listing_id": "home-listing-3",
      }
    }
  ]
}

Beispielantwort: HOME_LISTING

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

VEHICLE

Unterstützte Felder für die Methoden CREATE und UPDATE für den Typ VEHICLE findest du unter Felder für Automobilbestandskatalog – Fahrzeug.

Unterstützte Felder sind für Fahrzeug und Autohändler verfügbar.

Die Methode UPDATE kann auch zum Erstellen von Artikeln verwendet werden, sofern sie noch nicht vorhanden sind.

Beispielanfrage: VEHICLE

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "VEHICLE",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "vehicle_id": "vehicle-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "vehicle_id": "i2 2017 Ford Fusion",
          "availability": "AVAILABLE",
          "make": "Ford",
          "model": "Fusion",
          "year": "2017",
          "mileage": {
            "value": "1500",
            "unit": "KM",
          },
          "image": [
            {
                "url":"http://www.facebook.com/teapic.jpg",
                "tag":["Car"],
            },
          ],
          "fuel_type":"gasoline",
          "body_style":"sedan",
          "drivetrain":"FWD",
          "vin":"1FADP5AU6DL536022",
          "condition":"EXCELLENT",
          "description": "Turbocharged! Gasoline!",
          "title": "SE Ford Certified and 6-Speed Automatic.",
          "price": "18000 USD",
          "exterior_color":"white",
          "sale_price":"16000 USD",
          "state_of_vehicle":"new",
          "longitude":"52.35",
          "latitude":"42.1",
          "address": {
              "addr1":"550 Auto Center Dr",
              "city":"Watsonville",
              "region":"CA",
              "country":"US",
              "postal_code":"96075"
          },
          "url":"http://www.example.com/test"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "16000 USD",
          "vehicle_id": "vehicle-3",
        }
      }
    ]
  }

Beispielantwort: VEHICLE

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

Unterstützte Felder – Lokalisierten Objekte-Batch senden – /{catalog_id}/localized_items_batch

Siehe die Liste mit unterstützten Feldern und entsprechenden Beschreibungen für die einzelnen Felder für den Endpunkt /{catalog_id}/localized_items_batch:

Siehe die vollständige Liste von im Katalog unterstützten Feldern.

Mehr dazu