Riferimento

Usa questo riferimento per visualizzare i campi supportati e i rispettivi esempi per gli endpoint POST /{catalog_id}/items_batch e POST /{catalog_id}/batch.

I nomi dei parametri per /{catalog_id}/batch e /{catalog_id}/items_batch possono sembrare simili, ma sono assolutamente diversi.

Consigliamo di usare l'API /{catalog_id}/items_batch, che supporta più casi d'uso ed è mantenuta attivamente.

Campi supportati - Invio aggiornamenti degli articoli - /{catalog_id}/batch

Questi campi sono supportati per i metodi CREATE e UPDATE.

Rimozione dei campi

Quando aggiorni gli articoli, fornisci una stringa vuota come valore per rimuovere un campo opzionale. Impostare il valore come nullnon rimuoverà il campo.

Campo Descrizione

additional_image_urls

tipo:

array<string>

Facoltativo.

URL per un massimo di 9-10 immagini diverse.

additional_variant_attributes

tipo:

list<KeyValue:string,string>

Facoltativo.

Attributi aggiuntivi per distinguere il prodotto nel suo gruppo di varianti.

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

availability

tipo: stringa

Obbligatorio

Identifica lo stato di disponibilità:

  • in stock: l'articolo viene spedito immediatamente.
  • out of stock: nessun piano di riassortimento.
  • available for order: spedizione in 1-2 settimane.
  • discontinued

age_group

tipo: stringa

Facoltativo.

Gruppo di persone che hanno la stessa età o un'età simile. I valori accettati sono newborn, infant, toddler, kids, adult.

applinks

tipo:

oggetto<>

Facoltativo.

Link alle app mobili.

category

tipo: stringa

Facoltativo, ma consigliato per le inserzioni del catalogo Advantage+ (può contribuire a migliorare le prestazioni delle inserzioni). Facoltativo per Shopping su Instagram e per gli shop della Pagina, ma necessario per abilitare l'acquisto sul sito su questi canali (solo Stati Uniti). Obbligatorio per Marketplace (solo Stati Uniti).

Categoria di prodotti di Google (GPC) per l'articolo. Usa il percorso tassonomico della categoria o il suo numero ID, elencato qui.

Se usi la procedura di acquisto su Instagram o Facebook (solo Stati Uniti), la GPC di un articolo influisce sulle sue imposte e sulla normativa sui resi. Scopri di più sulla categoria di prodotti di Google per articoli del catalogo, Centro assistenza per le inserzioni.

Esempio: Apparel & Accessories > Clothing > Shirts & Tops o 212

color

tipo: stringa

Facoltativo.

Dimensioni max: 100.

Colore dell'articolo.

condition

tipo: stringa

Obbligatorio.

Condizioni dell'articolo: new, refurbished, used.

currency

tipo: stringa

Obbligatorio.

Valuta per il valore specificato. L'API Marketing supporta tutte le valute supportate dagli account pubblicitari. Usa ISO 4217 per gli standard delle valute.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

tipo: stringa

Facoltativo.

Limite massimo di caratteri: 100

Ulteriori informazioni sull'articolo. Fornisci una stringa vuota per rimuovere.

description

tipo: stringa

Obbligatorio.

Dimensioni max: 5000.

Breve descrizione dell'articolo.

gender

tipo: stringa

Facoltativo.

Genere per le taglie. I valori includono male, female, unisex.

gtin

tipo: stringa

Facoltativo.

Dimensioni max: 70.

Il numero GTIN può includere UPC,EAN, JAN e ISBN.

image_url

tipo: stringa

Obbligatorio.

Link all'immagine dell'articolo usata nell'inserzione. Fornisci dimensioni corrette dell'immagine.

Per le inserzioni del catalogo Advantage+ con immagine singola

  • Il requisito minimo di risoluzione dell'immagine è 500 pixel x 500 pixel.
  • Il requisito delle proporzioni minimo è 4:5.
  • Il requisito delle proporzioni massimo è 1,91:1.

Se l'immagine è al di fuori di queste proporzioni, Facebook la ritaglia in modo che sia più vicina alle proporzioni minime o alle proporzioni massime a seconda delle sue proporzioni originali.

Per l'immagine carosello, le inserzioni del catalogo Advantage+ - Il requisito di risoluzione dell'immagine minimo è 500 pixel x 500 pixel e Facebook lo ritaglia fino a 1:1.

Raccomandazione: evita modifiche frequenti di image url. Gli URL delle immagini non devono contenere parametri, come price o timestamp, poiché questi tendono a cambiare spesso.

inventory

tipo: numero

Facoltativo.

Intero che gli inserzionisti possono usare per memorizzare informazioni sul livello dell'inventario.

marked_for_product_launch

tipo: stringa

N.a. per le inserzioni del catalogo Advantage+. Facoltativo per le vendite.

Indica se un articolo verrà usato nel lancio di un prodotto. Valori supportati:

  • marked: l'articolo sarà nascosto agli acquirenti fino alla creazione del lancio del prodotto. Questo impedisce che l'articolo sia disponibile per la visualizzazione e l'acquisto prima dell'ora di lancio desiderata.
  • not_marked (predefinito): l'articolo non farà parte del lancio di un prodotto.

name

tipo: stringa

Obbligatorio.

Dimensioni max: 100.

Titolo dell'articolo.

pattern

tipo: stringa

Facoltativo

Dimensioni max: 100.

Schema o stampa grafica su un articolo.

price

tipo: intero

Obbligatorio.

Il prezzo moltiplicato per 100 per tutte le valute. Esempio: 490 se usato con USD indica 4,90 $ e 49 000 se usato con JPY indica 490 ¥.

product_type

tipo: stringa

Facoltativo.

Dimensioni max: 750.

Categoria definita dal rivenditore per l'articolo.

Esempio: in TSV Casa e giardino > Cucina e sala da pranzo > Elettrodomestici > Frigoriferi.

Esempio: in XML product_type > Casa e giardino > Cucina e sala da pranzo > Elettrodomestici > Frigoriferi > product_type.

retailer_product_group_id

tipo: stringa

Facoltativo.

Accetta stringhe. Gli inserzionisti possono usarlo per raggruppare i prodotti.

sale_price

tipo: intero

Facoltativo.

Prezzo scontato se l'articolo è in saldo. Questo è il prezzo di vendita moltiplicato per 100, per tutte le valute. Esempio: 490 se usato con USD indica 4,90 $ e 49 000 se usato con JPY indica 490 ¥.

sale_price_start_date

tipo: stringa

Facoltativo.

Data e ora di fine della promozione.

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

sale_price_end_date

tipo: stringa

Facoltativo.

Data e ora di inizio della promozione.

Esempio: 2014-11-01T12:00-0300

shipping

tipo:

array<object>

Facoltativo.

Informazioni di spedizione.

size

tipo: stringa

Facoltativo.

Dimensioni dell'articolo. Esempio: Small o XL.

url

tipo: stringa

Obbligatorio.

Link al sito del venditore dove è possibile acquistare l'articolo.

vendor_id

tipo: stringa

Facoltativo.

L'ID del rivenditore/venditore che vende l'articolo.

Richiesta di esempio - /{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",
      }
    }
  ]
}

Risposta di esempio - /{catalog_id}/batch

Saranno restituiti uno o più handle.

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

Campi supportati - Invio di aggiornamenti sui prodotti - /{catalog_id}/items_batch

Per cataloghi di vendita: utilizza questa API se devi aggiornare le informazioni sul prodotto più spesso di una volta all'ora (in caso contrario, utilizza l'API Feed). Puoi aggiornare più articoli in un'unica richiesta HTTP.

PRODUCT_ITEM

Questi campi di prodotti sono supportati per metodi CREATE e UPDATEper le versioni 3.3 e 3.2:

CampoDescrizione

additional_image_link

tipo:

array<string>

Facoltativo.

Link per un massimo di 9-10 immagini diverse.

additional_variant_attribute

tipo:

list<KeyValue:string,string>

Facoltativo.

Attributi aggiuntivi per distinguere il prodotto nel suo gruppo di varianti.

Esempio: "Scent:Fruity,Flavor:Apple"

age_group

tipo: stringa

Facoltativo.

Gruppo di persone che hanno la stessa età o un'età simile. I valori accettati sono newborn, infant, toddler, kids, adult.

applink

tipo:

oggetto<string>

Facoltativo.

Link alle app mobili.

Esempio:

"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

tipo: stringa

Obbligatorio.

Identifica lo stato di disponibilità:

  • in stock: l'articolo viene spedito immediatamente
  • out of stock: nessun piano di riassortimento.
  • available for order: spedizioni in 1-2 settimane
  • discontinued

brand

tipo: stringa

Facoltativo.

Brand dell'articolo.

color

tipo: stringa

Facoltativo.

Dimensioni max: 100.

Colore dell'articolo.

condition

tipo: stringa

Obbligatorio.

Condizioni del prodotto: new, refurbished o used.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Tipo: stringa

Facoltativo.

Limite massimo di caratteri: 100

Ulteriori informazioni sull'articolo.

description

tipo: stringa

Obbligatorio.

Dimensioni max: 5000.

Testo breve che descrive il prodotto.

disabled_capabilities

tipo:

array<string>

Facoltativo.

Elenco delle capacità da disabilitare. I valori possibili sono: 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

tipo: stringa

Facoltativo.

Genere per le taglie. I valori includono male, female, unisex.

google_product_category

tipo: stringa

Facoltativo.

Dimensioni max: 250.

Valori predefiniti (stringa o ID categoria) dalla tassonomia dei prodotti Google.

Esempio: Abbigliamento e accessori > Abbigliamento > Abiti o 2271.

gtin

tipo: stringa

Facoltativo.

Dimensioni max: 70.

Global Trade Item Number (GTIN) può includere UPC, EAN, JAN e ISBN.

id

tipo: stringa

Obbligatorio.

ID rivenditore

image

tipo: array <object>

URL e tag per le immagini da usare nelle tue inserzioni o negli Shop. Supporta fino a 20 immagini diverse. I tag sono facoltativi e, se usati, dovrebbero descrivere il contenuto dell'immagine.


Esempio:

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

image_link

tipo: stringa

Non obbligatorio se è fornito image.

Consigliamo di usare invece image. Quando viene fornito image, image_link e additional_image_link vengono ignorati.

Link all'immagine dell'articolo usata nell'inserzione. Fornisci dimensioni corrette dell'immagine.

Per le inserzioni del catalogo Advantage+ con immagine singola:

  • Il requisito minimo di risoluzione dell'immagine è 500 px x 500 px.
  • Il requisito minimo di proporzioni è 4:5.
  • Il requisito delle proporzioni massimo è 1,91:1. Se l'immagine è al di fuori di queste proporzioni, Facebook la ritaglia in modo che sia più vicina alle proporzioni minime o alle proporzioni massime, a seconda delle sue proporzioni originali.

Per le immagini carosello, le inserzioni del catalogo Advantage+: il requisito minimo di risoluzione dell'immagine è 500 pixel x 500 pixel e Facebook le ritaglia in proporzioni 1:1.

internal_label

tipo: stringa

Aggiungi etichette interne per filtrare gli articoli quando crei insiemi di prodotti. Ad esempio, potresti aggiungere l'etichetta "estate" a tutti gli articoli inclusi in una promozione estiva e quindi filtrarli per creare un insieme. Le etichette sono visibili solo a te.

Racchiudi ciascuna etichetta tra virgolette singole (') e separa le etichette con le virgole (,). Non inserire spazi bianchi all'inizio o alla fine di un'etichetta. Limite di caratteri: fino a 5000 etichette per prodotto e 110 caratteri per etichetta.

Esempio (TSV, XLSX, Fogli Google): ['estate','di tendenza']

Esempio (CSV): "['estate','di tendenza']"

Nota: se stai attualmente utilizzando etichette personalizzate (da custom_label_0 a custom_label_4) per filtrare gli insiemi di prodotti, è consigliabile passare alle etichette interne (internal_label). A differenza delle etichette personalizzate, le etichette interne possono essere aggiornate o aggiunte quando necessario senza inviare ogni volta i prodotti all'analisi relativa alla normativa, che può influire sulla pubblicazione delle inserzioni.

In precedenza questo campo si chiamava product_tags. Anche se continueremo a supportare il vecchio nome del campo, consigliamo di usare quello nuovo.

inventory

tipo: oggetto

Facoltativo.

Intero che gli inserzionisti possono usare per memorizzare informazioni sul livello dell'inventario.

item_group_id

tipo: stringa

Facoltativo.

L'ID fornito dall'inserzionista di un gruppo di prodotti, non l'FBID. Accetta stringhe. Può essere usato dagli inserzionisti per raggruppare diversi oggetti (articoli di prodotti, veicoli, hotel, voli e così via.

link

tipo: stringa

Obbligatorio.

Link al sito del venditore dove è possibile acquistare l'articolo.

manufacturer_part_number

tipo: stringa

Facoltativo.

ID unico del produttore per il prodotto.

pattern

tipo: stringa

Facoltativo.

Dimensioni max: 100.

Schema o stampa grafica su un prodotto.

price

tipo: stringa

Obbligatorio.

Prezzo dell'articolo. Formatta il prezzo come il costo, seguito dal codice valuta ISO di 3 cifre , con uno spazio tra costo e valuta.

Esempio: 9.99 USD.

rating_count

tipo: numero

Facoltativo.

Il numero di valutazioni che gli acquirenti hanno fornito per questo prodotto. Deve essere maggiore di 0. Deve essere usato unitamente a user_rating.

Esempio: 100

sale_price

tipo: stringa

Facoltativo, ma necessario per usare la funzione Overlay per le inserzioni del catalogo Advantage+.

Prezzo scontato se l'articolo è in saldo. Formatta il prezzo come il costo, seguito dal codice valuta ISO di 3 cifre , con uno spazio tra costo e valuta.

Esempio: 9.99 USD, 25.00 EUR

sale_price_effective_date

tipo: stringa

Facoltativo.

Data e ora di inizio e fine della promozione, separati da uno slash. Scrivi le date di inizio e fine come AAAA-MM-GG. Aggiungi una "T" dopo ogni data e quindi includi l'ora. Scrivi l'ora nel formato 24 ore (0:00-23:59).

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

shipping

tipo: stringa

Facoltativo.

Blob con prezzi diversi per Paese e area geografica. Le varie aree geografiche sono separate da virgola. Il formato dovrebbe essere COUNTRY:STATE:SHIPPING_TYPE:PRICE.

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

size

tipo: stringa

Facoltativo.

Dimensioni dell'articolo. Esempio: Small o XL.

title

tipo: stringa

Obbligatorio.

Dimensioni max: 100.

Titolo dell'articolo.

user_rating

tipo: numero

Facoltativo.

La valutazione media che gli acquirenti hanno fornito per questo prodotto. L'intervallo va da 1.0 a 5.0. È consentita una cifra decimale. Deve essere usato unitamente a rating_count.

Esempio: 4.5

video

tipo: array <object>

URL e tag per i video da usare nelle tue inserzioni o negli Shop. Supporta fino a 30 000 video a livello di catalogo. I tag sono facoltativi e, se usati, dovrebbero descrivere cosa contiene il video.


La dimensione massima del file video è di 200 MB. I formati supportati includono .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 e .wmv


Esempio:

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

NOTA: per eliminare il video 1 se il prodotto ha il video 1, 2, rimuovi il video 1 dall'array:

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

Per eliminare tutti i video, invia un array vuoto:

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

Il metodo UPDATE può essere usato anche per creare oggetti se non esistono già.

Scopri di più sui campi prodotti nel Riferimento API.

Esempio di richiesta - 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",
        }
      }
    ]
  }

Esempio di risposta - PRODUCT_ITEM

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

Scopri di più su come aggiungere articoli del catalogo con un elenco di dati.


HOTEL

Campi prodotti supportati per i metodi CREATE e UPDATE per il tipo HOTEL, per la versione 3.2:

CampoDescrizione

address

tipo:

oggetto<string>

Obbligatorio.

Indirizzo dell'hotel.

applink

tipo:

Facoltativo.

Link alle app mobili.

base_price

tipo: stringa

Obbligatorio.

Prezzo base della stanza dell'hotel per notte. Aggiungi il tipo di valuta al prezzo. Formatta il prezzo come il costo, seguito dal codice valuta ISO, con uno spazio tra costo e valuta. Esempio: USD per dollari statunitensi.

brand

tipo: stringa

Facoltativo.

Il brand della catena di hotel.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Tipo: stringa

Limite massimo di caratteri: 100

Fino a 5 campi personalizzati per le informazioni aggiuntive in base alle quali vuoi filtrare gli articoli quando crei degli insiemi. Ad esempio, puoi utilizzare un campo personalizzato per indicare tutte le camere che fanno parte di una promozione estiva e filtrarle poi in un insieme. Il campo supporta qualsiasi valore di testo, inclusi i numeri.


Esempio: Summer Sale

Questo campo è supportato da elenchi supplementari.

custom_number_0
custom_number_1
custom_number_2
custom_number_3
custom_number_4

tipo: int

Fino a 5 campi personalizzati per le informazioni aggiuntive relative ai numeri in base alle quali vuoi filtrare gli articoli quando crei degli insiemi. Questo campo ti consente di filtrare per intervalli numerici (è maggiore di e è minore di) quando crei un insieme. Ad esempio, puoi utilizzare questo campo per indicare l'anno in cui è stato aperto un hotel e poi filtrare un determinato intervallo di anni in un insieme.


Questo campo supporta tutti i numeri tra 0 e 4294967295. Non supporta numeri negativi, decimali o virgole, ad esempio: -2, 5,5 o 10,000.


Esempio: 2022

description

tipo: stringa

Obbligatorio.

Limite massimo di caratteri: 5000.

Breve descrizione dell'hotel.

guest_rating

tipo:

array<object>

Facoltativo.

Valutazione degli ospiti dell'hotel.

hotel_id

tipo: stringa

Obbligatorio.

ID unico per l'hotel.

image

tipo:

array<object>

Obbligatorio.

URL e tag per immagini da usare nelle inserzioni. Supporta fino a 20 immagini multiple. Il tag è facoltativo, quando usato. Dovrebbe descrivere il contenuto dell'immagine. Esempio: "reception".

latitude

tipo: stringa

Obbligatorio.

Latitudine della posizione dell'hotel.

longitude

tipo: stringa

Obbligatorio.

Longitudine della posizione dell'hotel.

loyalty_program

tipo: stringa

Facoltativo.

Programma fedeltà usato per l'hotel.

margin_level

tipo: stringa

Facoltativo.

Indicatore della redditività dell'hotel; valore da 1 a 10.

name

tipo: stringa

Obbligatorio.

Nome dell'hotel.

neighborhood

tipo:

array<string>

Facoltativo.

Uno o più quartieri per l'hotel. Esempio: Soho o Las Vegas Strip. Numero massimo di quartieri ammessi: 20.

phone

tipo: stringa

Facoltativo.

Numero di telefono con prefisso internazionale.

sale_price

tipo: stringa

Facoltativo.

Prezzo promozionale a notte in hotel. Usalo per pubblicizzare sconti sul prezzo normale dell'hotel. Obbligatorio: aggiungi il tipo di valuta al prezzo. Formatta il prezzo come il costo, seguito dal codice valuta ISO, con uno spazio tra costo e valuta. Esempio: USD per dollari statunitensi.

star_rating

tipo: stringa

Facoltativo.

Numero di stelle dell'hotel. Il numero deve essere compreso tra 1 e 5.

url

tipo: stringa

Obbligatorio.

Link al sito web esterno dove è possibile prenotare la camera d'hotel.

Il metodo UPDATE può essere usato anche per creare oggetti se non esistono già.

Esempio di richiesta - 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",
        }
      }
    ]
  }

Esempio di risposta - HOTEL

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

HOTEL_ROOM

Questi campi prodotti sono supportati per i metodi CREATE e UPDATE per il tipo HOTEL_ROOM, per la versione 3.2.

CampoDescrizione

base_price

tipo: stringa

Obbligatorio.

Prezzo base per 1 notte. La valuta deve seguire i codici valuta ISO 4217.

Esempio: 9.99 USD.

description

tipo: stringa

Obbligatorio.

Dimensioni max: 5000.

Breve testo che descrive la stanza.

hotel_retailer_id

tipo: stringa

Obbligatorio.

ID unico per il rivenditore dell'hotel.

hotel_room_id

tipo: stringa

Obbligatorio.

ID unico per l'hotel.

image

tipo:

array<object>

Obbligatorio.

Immagini della stanza.

name

tipo: stringa

Obbligatorio.

Dimensioni max: 100.

Nome della stanza.

url

tipo: stringa

Obbligatorio.

Link al sito dell'inserzionista dove è possibile prenotare il soggiorno.

Il metodo UPDATE può essere usato anche per creare oggetti se non esistono già.

Esempio di richiesta - 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",
        }
      }
    ]
  }

Esempio di risposta - HOTEL_ROOM

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

FLIGHT

Questi campi prodotti sono supportati per i metodi CREATE e UPDATE per il tipo FLIGHT, per la versione 3.2.

CampoDescrizione

description

tipo: stringa

Facoltativo.

Limite massimo di caratteri: 5000.

Descrizione del volo.

destination_airport

tipo: stringa

Obbligatorio.

Aeroporto di destinazione del volo. Deve essere indicato con il rispettivo codice IATA.

Esempio: SFO.

destination_city

tipo: stringa

Facoltativo.

Nome della città di destinazione del volo.

image

tipo:

array<object>

Obbligatorio.

URL e tag per le immagini da usare nelle inserzioni. Supporta fino a 20 immagini multiple. Il tag è facoltativo, quando usato deve descrivere il contenuto dell'immagine.

Esempio: seat

origin_airport

tipo: stringa

Obbligatorio.

Aeroporto di partenza del volo. Deve essere indicato con il rispettivo codice IATA.

Esempio: SFO

origin_city

tipo: stringa

Facoltativo.

Nome della città di partenza del volo.

price

tipo: stringa

Facoltativo.

Costo e valuta del volo. Il prezzo è un numero seguito dal codice della valuta; utilizza gli standard ISO 4217. Usa ""."" come separatore decimale per il prezzo.

url

tipo: stringa

Facoltativo.

Link al sito web dove prenotare il volo.

Il metodo UPDATE può essere usato anche per creare oggetti se non esistono già.

Esempio di richiesta - 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": {

Esempio di risposta - FLIGHT

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

DESTINATION

Questi campi prodotti sono supportati per i metodi CREATE e UPDATE per il tipo DESTINATION, per la versione 3.2.

CampoDescrizione

applink

tipo:

oggetto<string>

Facoltativo.

Link alle app mobili.

address

tipo:

oggetto<string>

Obbligatorio.

Indirizzo dell'hotel.

description

tipo: stringa

Facoltativo.

Limite massimo di caratteri: 5000.

Breve paragrafo che descrive la destinazione.

destination_id

tipo: stringa

Obbligatorio.

Limite max di caratteri: 100.

ID unico per la destinazione.

image

tipo:

array<object>

Obbligatorio.

URL e tag per le immagini da usare nelle inserzioni. Supporta fino a 20 immagini multiple. Il tag è facoltativo, quando usato deve descrivere il contenuto dell'immagine.

Esempio: seat.

latitude

tipo: stringa

Obbligatorio.

Latitudine della destinazione.

longitude

tipo: stringa

Obbligatorio.

Longitudine della destinazione.

name

tipo: stringa

Obbligatorio.

Nome della destinazione.

neighborhood

tipo:

array<string>

Facoltativo.

Numero massimo di quartieri ammessi: 20. Uno o più quartieri per la destinazione.

Esempio: Soho o Las Vegas Strip.

price

tipo: stringa

Facoltativo.

Costo medio più basso e valuta della destinazione. Formatta il prezzo come numero seguito dal codice valuta; utilizza gli standard ISO 4217. Usa ""."" come separatore decimale per il prezzo.

price_change

tipo: stringa

Facoltativo.

Variazione di prezzo. Può essere usato per creare insiemi di prodotti e nelle creatività dell'inserzione:

  • 0: nessuna variazione di prezzo.
  • -10: riduzione del prezzo del 10%.
  • 20: aumento del prezzo del 20%.

Esempio: ""prezzo medio a New York diminuito di X"" o ""prezzo medio a New York diminuito""

type

tipo:

array<string>

Obbligatorio.

Numero max di tipi di destinazione: 20. Tipo(i) di destinazione. Una destinazione può avere più tipi.

Esempio: park o beach

url

tipo: stringa

Obbligatorio.

Link al sito web dove prenotare la destinazione.

Il metodo UPDATE può essere usato anche per creare oggetti se non esistono già.

Esempio di richiesta - 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",
        }
      }
    ]
  }

Esempio di risposta - DESTINATION

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

HOME_LISTING

Questi campi di prodotto sono supportati per i metodi CREATE e UPDATE per il tipo HOME_LISTING, per la versione 3.3 e 3.2.

CampoDescrizione

applink

tipo:

oggetto<string>

Facoltativo.

Link alle app mobili.

address

tipo:

oggetto<string>

Obbligatorio.

Indirizzo per l'annuncio immobiliare.

availability

tipo: stringa

Obbligatorio.

Disponibilità attuale dell'annuncio immobiliare. Valori supportati: for_sale, for_rent, sale_pending, recently_sold, off_market, available_soon.

available_dates_price_config

tipo:

array<object>

Facoltativo.

Configurazioni dei prezzi.

description

tipo: stringa

Facoltativo.

Limite massimo di caratteri: 5000.

Breve paragrafo che descrive l'annuncio immobiliare.

image

tipo:

array<object>

Obbligatorio.

URL e tag per le immagini da usare nelle inserzioni. Supporta fino a 20 immagini multiple. Il tag è facoltativo, quando usato deve descrivere il contenuto dell'immagine.

Esempio: pool.

latitude

tipo: stringa

Facoltativo.

Latitudine dell'annuncio immobiliare.

longitude

tipo: stringa

Facoltativo.

Longitudine dell'annuncio immobiliare.

listing_type

tipo: stringa

Facoltativo.

Tipo di annuncio. Valori supportati: for_rent_by_agent, for_rent_by_owner, for_sale_by_agent, for_sale_by_owner, foreclosed, new_construction, new_listing.

name

tipo: stringa

Obbligatorio.

Nome dell'annuncio immobiliare.

neighborhood

tipo:

array<object>

Facoltativo.

Quartiere dell'annuncio immobiliare. Numero max di quartieri consentiti: 20.

num_baths

tipo: stringa

Facoltativo.

Numero di bagni.

num_beds

tipo: stringa

Facoltativo.

Numero di camere da letto.

num_units

tipo: stringa

Facoltativo.

Numero di unità disponibili. Utilizzalo solo per appartamenti o condomini disponibili per l'affitto/la locazione.

price

tipo: stringa

Obbligatorio.

Costo e valuta per l'annuncio immobiliare. Il prezzo è un numero seguito dal codice valuta; usa gli standard ISO 4217. Usa ""."" come separatore decimale per il prezzo.

price_change

tipo: stringa

Facoltativo.

Variazione di prezzo. Può essere usato per creare insiemi di prodotti e nelle creatività dell'inserzione:

  • 0: nessuna variazione di prezzo.
  • -10: riduzione del prezzo del 10%.
  • 20: aumento del prezzo del 20%.

Esempio: ""prezzo medio a New York diminuito di X"" o ""prezzo medio a New York diminuito""

property_type

tipo: stringa

Facoltativo.

Tipo di proprietà. Valori supportati: apartment, condo, house, land, manufactured, other, townhouse.

url

tipo: stringa

Obbligatorio.

Link al sito web dove puoi visualizzare l'annuncio.

year_built

tipo: stringa

Facoltativo.

Anno di costruzione dell'immobile.

Il metodo UPDATE può essere usato anche per creare oggetti se non esistono già.

Esempio di richiesta - 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",
      }
    }
  ]
}

Esempio di risposta - HOME_LISTING

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

VEHICLE

Per i campi supportati per i metodi CREATE e UPDATE per il tipo VEHICLE, consulta Campi del catalogo dell'inventario per il settore automotive - Veicolo.

I campi supportati sono disponibili per Veicolo e Concessionaria.

Il metodo UPDATE può essere usato anche per creare oggetti se non esistono già.

Esempio di richiesta - 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",
        }
      }
    ]
  }

Esempio di risposta - VEHICLE

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

Campi supportati - Invio batch articoli localizzati - /{catalog_id}/localized_items_batch

Consulta l'elenco dei campi supportati e le rispettive descrizioni per ogni campo, per l'endpoint /{catalog_id}/localized_items_batch:

Consulta la lista completa dei campi supportati dal catalogo.

Scopri di più