Utilisez cette référence pour voir les champs pris en charge et les exemples respectifs pour les points de terminaison POST /{catalog_id}/items_batch
et POST /{catalog_id}/batch
.
Les noms de paramètres pour /{catalog_id}/batch
et /{catalog_id}/items_batch
peuvent sembler similaires, mais ils sont distinctement différents.
Nous recommandons d’utiliser l’API /{catalog_id}/items_batch
, qui prend en charge davantage de cas d’utilisation et est maintenue de manière active.
/{catalog_id}/batch
Ces champs sont pris en charge pour les méthodes CREATE
et UPDATE
.
Lors de la mise à jour des articles, fournissez une chaîne vide comme valeur pour désactiver un champ optionnel. Définir la valeur comme null
ne désactivera pas le champ.
Champ | Description |
---|---|
type : tableau<string> | Facultatif. URL pour un maximum de 9 à 10 images différentes. |
type : list<KeyValue:string,string> | Facultatif. Attributs supplémentaires pour distinguer le produit dans son groupe de variantes. Exemple : |
type : chaîne | Obligatoire Identifie le statut de disponibilité :
|
type : chaîne | Facultatif. Groupe de personnes ayant le même âge ou un âge similaire. Valeurs acceptées : |
type : objet<> | Facultatif. Liens vers les applications mobiles. |
type : chaîne | Facultatif mais recommandé pour les publicités de catalogue Avantage+ (peut contribuer à l’amélioration de la performance des publicités). Facultatif pour Instagram Shopping et les boutiques de Page, mais obligatoire pour activer le paiement sur site sur ces canaux (États-Unis uniquement). Obligatoire pour Marketplace (États-Unis uniquement). Catégorie de produit Google (GPC) de l’article. Utilisez le chemin de la taxonomie de la catégorie ou son numéro d’identification, listé sur cette page. Si vous utilisez le paiement sur Instagram ou Facebook (États-Unis uniquement), la GPC de l’article affecte ses taxes et sa politique de retour. Consultez la page d’aide sur les publicités Comment ajouter une catégorie de produits Google ou Facebook aux articles de votre catalogue pour en savoir plus. Exemple : |
type : chaîne | Facultatif. Taille maximale : 100. Couleur de l’article. |
type : chaîne | Obligatoire. État de l’article : |
type : chaîne | Obligatoire. Devise pour la valeur spécifiée. L’API Marketing accepte toutes les devises prises en charge par les comptes publicitaires. Utilisez l’ISO 4217 pour les normes monétaires. |
type : chaîne | Facultatif. Nombre maximal de caractères : 100. Informations supplémentaires sur l’article. Utilisez une chaîne vide pour le désactiver. |
type : chaîne | Obligatoire. Taille maximale : 5 000. Brève description de l’article. |
type : chaîne | Facultatif. Genre pour la taille. Valeurs incluses : |
type : chaîne | Facultatif. Taille maximale : 70. Le numéro d’identification commercial international (GTIN) peut inclure : |
type : chaîne | Obligatoire. Lien vers l’image de l’article utilisé dans la publicité. Fournissez des tailles d’image appropriées. Pour les publicités de catalogue Advantage+ basées à image unique
Si l’image ne respecte pas ces proportions, Facebook la recadre afin qu’elle soit la plus proche possible des proportions minimales ou maximales en fonction de ses proportions d’origine. Pour une image carrousel, publicités de catalogue Advantage+ - L’exigence de résolution d’image minimale est de 500 px * 500 px, et Facebook la recadre aux proportions 1:1. Recommandation : évitez les changements fréquents d’ |
type : nombre | Facultatif. Nombre entier pouvant être utilisé par les annonceurs pour stocker des informations sur le niveau d’inventaire. |
type : chaîne | N/A pour les publicités de catalogue Advantage+. Facultatif pour le commerce. Indique si un article sera utilisé dans un lancement de produit. Valeurs acceptées :
|
type : chaîne | Obligatoire. Taille maximale : 100. Titre de l’article. |
type : chaîne | Facultatif Taille maximale : 100. Motif ou imprimé graphique figurant sur un article. |
type : nombre entier | Obligatoire. Le prix multiplié par 100, pour toutes les devises. Exemple : 490 utilisé avec USD signifie $4,90, et 49 000 utilisé avec JPY signifie ¥490. |
type : chaîne | Facultatif. Taille maximale : 750. Catégorie définie par le vendeur pour l’article. Exemple : dans TSV Maison & Jardin > Cuisine & Salle à manger > Appareils > Réfrigérateurs. Exemple : dans type_produit XML > Maison & Jardin > Cuisine & Salle à manger > Appareils > Réfrigérateurs > type_produit. |
type : chaîne | Facultatif. Accepte des chaînes. Utilisation possible par les annonceurs pour regrouper les produits. |
type : nombre entier | Facultatif. Prix réduit si l’article est en solde. Prix de vente multiplié par 100, pour toutes les devises. Exemple : 490 utilisé avec USD signifie $4,90, et 49 000 utilisé avec JPY signifie ¥490. |
type : chaîne | Facultatif. Date et heure de fin de la vente. Exemple : |
type : chaîne | Facultatif. Date et heure de début de la vente.
|
type : tableau<object> | Facultatif. Informations de livraison. |
type : chaîne | Facultatif. Taille de l’article. Exemple : |
type : chaîne | Obligatoire. Lien vers le site du marchand où il est possible d’acheter l’article. |
type : chaîne | Facultatif. L’ID du fournisseur/vendeur qui vend l’article. |
/{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", } } ] }
/{catalog_id}/batch
Un ou plusieurs descripteurs seront retournés.
"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch
/{catalog_id}/items_batch
Pour les catalogues de vente : utilisez cette API si vous devez mettre à jour les informations sur les produits plusieurs fois par heure (sinon, utilisez l’API Feed). Elle permet de mettre à jour plusieurs articles à l’aide d’une requête HTTP unique.
Ces champs de produit sont pris en charge pour les méthodes CREATE
et UPDATE
, pour les versions 3.3 et 3.2 :
Champ | Description |
---|---|
type : tableau<string> | Facultatif. Lien pour un maximum de 9 à 10 images différentes. |
type : list<KeyValue:string,string> | Facultatif. Attributs supplémentaires pour distinguer le produit dans son groupe de variantes. Exemple : |
type : chaîne | Facultatif. Groupe de personnes ayant le même âge ou un âge similaire. Valeurs acceptées : |
type : objet<string> | Facultatif. Liens vers les applications mobiles. Exemple : "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", } |
type : chaîne | Obligatoire. Identifie le statut de disponibilité :
|
type : chaîne | Facultatif. Marque de l’article. |
type : chaîne | Facultatif. Taille maximale : 100. Couleur de l’article. |
type : chaîne | Obligatoire. État du produit : |
type : chaîne | Facultatif. Nombre maximal de caractères : 100. Informations supplémentaires sur l’article. |
type : chaîne | Obligatoire. Taille maximale : 5 000. Brève description du produit. |
type : tableau<string> | Facultatif. Liste des fonctionnalités à désactiver. Valeurs possibles : |
type : chaîne | Facultatif. Genre pour la taille. Valeurs incluses : |
type : chaîne | Facultatif. Taille maximale : 250. Valeurs prédéfinies (chaîne ou ID de catégorie) issues de la taxonomie des produits Google. Exemple : Vêtements et accessoires > Accessoires d’habillement > Robes ou 2271. |
type : chaîne | Facultatif. Taille maximale : 70. Le Numéro d’identification commercial international (Global Trade Identification Number, GTIN) peut inclure |
type : chaîne | Obligatoire. ID du vendeur |
type : tableau <object> | URL et tags pour les images à utiliser dans vos publicités ou vos boutiques. Prend en charge jusqu’à 20 images différentes. Les tags sont optionnels et, en cas d’utilisation, ils devraient décrire le contenu de l’image. Exemple : "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['Swimming pool','Gym'], } ] |
type : chaîne | Non nécessaire si Nous recommandons d’utiliser Lien vers l’image de l’article utilisé dans la publicité. Fournissez des tailles d’image appropriées. Pour les publicités de catalogue Advantage+ à image unique :
Pour une image carrousel, les publicités de catalogue Advantage+ : l’exigence de résolution d’image minimale est de 500 px * 500 px, et Facebook la recadre aux proportions 1:1. |
type : chaîne | Ajoutez des étiquettes internes pour faciliter le filtrage des articles lorsque vous créez des ensembles de produits. Par exemple, vous pouvez ajouter une étiquette « Été » à tous les articles qui bénéficient des promotions estivales, puis intégrer ces articles dans un ensemble. Les étiquettes ne sont visibles que par vous. Entourez chaque étiquette de guillemets simples (') et séparez les étiquettes par des virgules (,). N’incluez pas d’espace blanc au début ou à la fin d’une étiquette. Limite de caractères : jusqu’à 5 000 étiquettes par produit et 110 caractères par étiquette. Exemple (TSV, XLSX, Google Sheets) : ['été','tendances'] Exemple (CSV) : « ['été','tendances'] » Remarque : si vous utilisez actuellement des étiquettes personnalisées ( Ce champ était auparavant appelé |
type : objet | Facultatif. Nombre entier pouvant être utilisé par les annonceurs pour stocker des informations sur le niveau d'inventaire. |
type : chaîne | Facultatif. L'ID d’un groupe de produits fourni par l'annonceur ; pas le FBID. Accepte des chaînes. Peut être utilisé par les annonceurs pour regrouper différents objets (produits, véhicules, hôtels, vols, etc.). |
type : chaîne | Obligatoire. Lien vers le site du marchand vendant l'article. |
type : chaîne | Facultatif. ID de fabricant unique pour le produit. |
type : chaîne | Facultatif. Taille maximale : 100. Motif ou imprimé graphique figurant sur un produit. |
type : chaîne | Obligatoire. Prix de l’article. Le format du prix doit être le suivant : coût suivi du code de devise ISO à 3 chiffres, avec une espace entre les deux. Exemple : |
type : nombre | Facultatif. Nombre d’évaluations que les acheteurs ont fournies pour ce produit. Doit être supérieur à 0. Doit être utilisé en association avec Exemple : 100 |
type : chaîne | Facultatif, mais requis pour utiliser la fonctionnalité de superposition pour les publicités de catalogue Advantage+. Prix réduit si l’article est en solde. Le format du prix doit être le suivant : coût suivi du code de devise ISO à 3 chiffres, avec une espace entre les deux. Exemple : |
type : chaîne | Facultatif. Jour et heure de début et de fin de la réduction, séparés par une barre oblique. Respectez le format suivant pour les dates de début et de fin : AAAA-MM-JJ. Ajoutez un « T » après chaque date, puis ajoutez l’heure. Respectez le format 24 heures pour les heures (de 00:00 à 23:59).
|
type : chaîne | Facultatif. Blob avec des prix différents pour chaque pays et région. Les régions différentes sont séparées par des virgules. Le format doit être le suivant : Exemple : |
type : chaîne | Facultatif. Taille de l’article. Exemple : |
type : chaîne | Obligatoire. Taille maximale : 100. Titre de l’article. |
type : nombre | Facultatif. Évaluation moyenne que les acheteurs ont fournie pour ce produit. Valeur comprise entre 1.0 et 5.0. Une décimale autorisée. Doit être utilisé en association avec Exemple : 4.5 |
type : tableau <object> | URL et tags pour les vidéos à utiliser dans vos publicités ou vos boutiques. Prend en charge jusqu'à 30 000 vidéos au niveau du catalogue. Les tags sont optionnels et, en cas d’utilisation, ils devraient décrire le contenu de la vidéo. La taille maximale autorisée pour un fichier vidéo est de 200 Mo. Les formats pris en charge sont les suivants : .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 et .wmv Exemple : "video": [ { "url":"http://example.com/video_1.mp4", "tag": ['Swimming pool','Gym'], } ] NOTE : pour supprimer la vidéo 1 si le produit comporte la vidéo 1, 2, enlevez la vidéo 1 du tableau : [ { "method": "UPDATE", "data": { "video": [ { "url": "https://google.com/video_2.mp4", "tag": ["video_2"] } ] } } ] Pour supprimer toutes les vidéos, envoyez un tableau vide : [ { "method": "UPDATE", "data": { "video": [] } } ] |
Il est également possible d’avoir recours à la méthode UPDATE
pour créer des éléments s’ils n’existent pas déjà.
En savoir plus sur les champs de produits dans la Référence API.
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", } } ] }
PRODUCT_ITEM
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
En savoir plus sur la rubrique Ajouter des articles de catalogue avec un flux de données.
Champs de produits pris en charge pour les méthodes CREATE
et UPDATE
pour le type HOTEL
, pour la version 3.2 :
Champ | Description |
---|---|
type : objet<string> | Obligatoire. Adresse de l'hôtel. |
type : | Facultatif. Liens vers les applications mobiles. |
type : chaîne | Obligatoire. Prix de base de la chambre d’hôtel par nuitée. Ajoutez le type de devise au prix. Le format du prix doit être le suivant : coût, suivi du code de devise ISO, avec une espace entre les deux. Exemple : |
type : chaîne | Facultatif. Marque de la chaîne hôtelière. |
type : chaîne | Nombre maximal de caractères : 100. Jusqu’à cinq champs personnalisés pour toute information supplémentaire que vous souhaitez utiliser pour filtrer des articles quand vous créez des ensembles. Par exemple, vous pouvez utiliser un champ personnalisé pour indiquer toutes les chambres qui bénéficient des promotions estivales, puis intégrer ces chambres dans un ensemble. Ce champ peut contenir n’importe quelle valeur de texte, y compris des chiffres. Exemple : Ce champ est pris en charge par des flux de produits supplémentaires. |
type : nombre entier | Jusqu’à cinq champs personnalisés pour toute information numérique supplémentaire que vous souhaitez utiliser pour filtrer des articles quand vous créez des ensembles. Ce champ permet de filtrer par plages de nombres (supérieur à et inférieur à) lorsque vous créez un ensemble. Par exemple, vous pouvez indiquer l’année d’ouverture d’un hôtel, puis filtrer sur un intervalle d’années dans un ensemble. Ce champ peut contenir des nombres entiers compris entre 0 et 4 294 967 295. Les nombres négatifs, les nombres décimaux ou les virgules, comme -2, 5,5 ou 10,000, ne sont pas acceptés. Exemple : |
type : chaîne | Obligatoire. Maximum de caractères autorisé : 5 000. Brève description de l’hôtel. |
type : tableau<object> | Facultatif. Les évaluations de la clientèle de l'hôtel. |
type : chaîne | Obligatoire. ID unique pour l'hôtel. |
type : tableau<object> | Obligatoire. URL et tags pour les images à utiliser dans les publicités. Prend en charge jusqu’à 20 images différentes. Le tag est facultatif, en cas d’utilisation. Devrait décrire le contenu de l’image. Exemple : |
type : chaîne | Obligatoire. Latitude de l'hôtel. |
type : chaîne | Obligatoire. Longitude de l’hôtel. |
type : chaîne | Facultatif. Programme de fidélité utilisé pour l'hôtel. |
type : chaîne | Facultatif. Indicateur de rentabilité de l'hôtel ; valeur de |
type : chaîne | Obligatoire. Nom de l'hôtel. |
type : tableau<string> | Facultatif. Un ou plusieurs quartiers dans lesquels se trouve l’hôtel. Exemple : |
type : chaîne | Facultatif. Numéro de téléphone avec indicatif pays. |
type : chaîne | Facultatif. Prix de vente par nuitée dans l’hôtel. Utilisez ceci pour publier des réductions sur le prix régulier de l'hôtel. Obligatoire : ajoutez le type de devise au prix. Le format du prix doit être le suivant : coût, suivi du code de devise ISO, avec une espace entre les deux. Exemple : |
type : chaîne | Facultatif. Évaluation de l’hôtel en nombre d’étoiles. Le nombre doit être compris entre |
type : chaîne | Obligatoire. Lien vers le site externe de réservation de la chambre d’hôtel. |
Il est également possible d’avoir recours à la méthode UPDATE
pour créer des éléments s’ils n’existent pas déjà.
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", } } ] }
HOTEL
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
Ces champs de produit sont pris en charge pour les méthodes CREATE
et UPDATE
pour le type HOTEL_ROOM
, pour la version 3.2.
Champ | Description |
---|---|
type : chaîne | Obligatoire. Prix de base pour une nuitée. La devise doit respecter les codes de devise de la norme ISO 4217. Exemple : |
type : chaîne | Obligatoire. Taille maximale : 5 000. Brève description de la chambre. |
type : chaîne | Obligatoire. Identifiant unique pour l’hôtelier. |
type : chaîne | Obligatoire. ID unique pour l'hôtel. |
type : tableau<object> | Obligatoire. Images de la chambre. |
type : chaîne | Obligatoire. Taille maximale : 100. Nom de la chambre. |
type : chaîne | Obligatoire. Lien vers le site de réservation du séjour de l'annonceur. |
Il est également possible d’avoir recours à la méthode UPDATE
pour créer des éléments s’ils n’existent pas déjà.
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", } } ] }
HOTEL_ROOM
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
Ces champs de produits sont pris en charge pour les méthodes CREATE
et UPDATE
pour le type FLIGHT
, pour la version 3.2.
Champ | Description |
---|---|
type : chaîne | Facultatif. Nombre maximal de caractères : 5 000. Description du vol. |
type : chaîne | Obligatoire. Aéroport de destination pour le vol. Doit être au format du code IATA. Exemple : |
type : chaîne | Facultatif. Nom de la ville de destination pour le vol. |
type : tableau<object> | Obligatoire. URL et tags pour les images à utiliser dans les publicités. Prend en charge jusqu’à 20 images différentes. Le tag étant facultatif, en cas d’utilisation, il doit décrire le contenu de l'image. Exemple : |
type : chaîne | Obligatoire. Aéroport de départ pour le vol. Doit être au format du code IATA. Exemple : |
type : chaîne | Facultatif. Nom de la ville d'origine pour le vol. |
type : chaîne | Facultatif. Prix et devise du vol. Le prix est un nombre suivi du code de la devise. Utilisez les normes ISO 4217. Utilisez « . » comme décimale pour le prix. |
type : chaîne | Facultatif. Lien vers le site Web de réservation du vol. |
Il est également possible d’avoir recours à la méthode UPDATE
pour créer des éléments s’ils n’existent pas déjà.
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": {
FLIGHT
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
Ces champs de produit sont pris en charge pour les méthodes CREATE
et UPDATE
pour le type DESTINATION
, pour la version 3.2.
Champ | Description |
---|---|
type : objet<string> | Facultatif. Liens vers les applications mobiles. |
type : objet<string> | Obligatoire. Adresse de l'hôtel. |
type : chaîne | Facultatif. Nombre maximal de caractères : 5 000. Court paragraphe décrivant la destination. |
type : chaîne | Obligatoire. Nombre maximal de caractères : 100. Identifiant unique pour la destination. |
type : tableau<object> | Obligatoire. URL et tags pour les images à utiliser dans les publicités. Prend en charge jusqu’à 20 images différentes. Le tag étant facultatif, en cas d’utilisation, il doit décrire le contenu de l'image. Exemple : |
type : chaîne | Obligatoire. Latitude de la destination. |
type : chaîne | Obligatoire. Longitude de la destination. |
type : chaîne | Obligatoire. Nom de la destination. |
type : tableau<string> | Facultatif. Le nombre maximum de quartiers autorisés est de 20. Un ou plusieurs quartiers dans lesquels se trouve la destination. Exemple : |
type : chaîne | Facultatif. Prix moyen le plus bas et devise pour la destination. Le prix doit être composé d’un nombre suivi du code de la devise. Utilisez les normes ISO 4217. Utilisez « . » comme décimale pour le prix. |
type : chaîne | Facultatif. Changement de prix. Peut être utilisé pour construire des ensembles de produits et dans le contenu publicitaire :
Exemple : « le prix moyen à NYC a diminué de X » ou « le prix moyen à NYC a chuté » |
type : tableau<string> | Obligatoire. Le nombre maximum de types de destinations est de 20. Type(s) de destination. Une destination peut comprendre plusieurs types. Exemple : |
type : chaîne | Obligatoire. Lien vers le site Web de réservation de la destination. |
Il est également possible d’avoir recours à la méthode UPDATE
pour créer des éléments s’ils n’existent pas déjà.
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", } } ] }
DESTINATION
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
Ces champs de produits sont pris en charge pour les méthodes CREATE
et UPDATE
pour le type HOME_LISTING
, pour les versions 3.3 et 3.2.
Champ | Description |
---|---|
type : objet<string> | Facultatif. Liens vers les applications mobiles. |
type : objet<string> | Obligatoire. Adresse postale pour l’annonce immobilière. |
type : chaîne | Obligatoire. Disponibilité actuelle de l’annonce immobilière. Valeurs prises en charge : |
type : tableau<object> | Facultatif. Configurations de prix. |
type : chaîne | Facultatif. Nombre maximal de caractères : 5 000. Court paragraphe décrivant l’annonce immobilière. |
type : tableau<object> | Obligatoire. URL et tags pour les images à utiliser dans les publicités. Prend en charge jusqu’à 20 images différentes. Le tag étant facultatif, en cas d’utilisation, il doit décrire le contenu de l'image. Exemple : |
type : chaîne | Facultatif. Latitude de l’annonce immobilière. |
type : chaîne | Facultatif. Longitude de l'annonce immobilière. |
type : chaîne | Facultatif. Annonce immobilière. Valeurs prises en charge : |
type : chaîne | Obligatoire. Nom de l’annonce immobilière. |
type : tableau<object> | Facultatif. Quartier pour l’annonce immobilière. Nombre de quartiers max. autorisés : 20. |
type : chaîne | Facultatif. Nombre de salles de bain. |
type : chaîne | Facultatif. Nombre de chambres. |
type : chaîne | Facultatif. Nombre d'unités disponibles. Uniquement applicable aux appartements ou aux copropriétés disponibles à la vente/location. |
type : chaîne | Obligatoire. Prix et devise pour l’annonce immobilière. Le prix est un nombre suivi du code de la devise. Utilisez les normes ISO 4217. Utilisez « . » comme décimale pour le prix. |
type : chaîne | Facultatif. Changement de prix. Peut être utilisé pour construire des ensembles de produits et dans le contenu publicitaire :
Exemple : « le prix moyen à NYC a diminué de X » ou « le prix moyen à NYC a chuté » |
type : chaîne | Facultatif. Type de propriété. Valeurs prises en charge : |
type : chaîne | Obligatoire. Lien vers le site Web de consultation de l’annonce. |
type : chaîne | Facultatif. Année de construction de la maison. |
Il est également possible d’avoir recours à la méthode UPDATE
pour créer des éléments s’ils n’existent pas déjà.
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", } } ] }
HOME_LISTING
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
Pour les champs pris en charge pour les méthodes CREATE
et UPDATE
pour le type VEHICLE
, consultez Champs de catalogue d'inventaire automobile - Véhicule.
Les champs pris en charge sont disponibles pour Véhicule et Concessionnaire.
Il est également possible d’avoir recours à la méthode UPDATE
pour créer des éléments s’ils n’existent pas déjà.
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", } } ] }
VEHICLE
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
/{catalog_id}/localized_items_batch
Consultez la liste des champs pris en charge et leurs descriptions respectives pour chaque champ, pour le point de terminaison /{catalog_id}/localized_items_batch
:
Consultez la liste complète des champs pris en charge par le catalogue.
/{catalog_id}/items_batch
(Remarque : nous recommandons d’utiliser ce point de terminaison, car il prend en charge plus de cas d’utilisation et fait l’objet d’une maintenance active.)
/{catalog_id}/batch
/{catalog_id}/check_batch_request_status
/{catalog_id}/localized_items_batch