API Product Set Collection

Vous pouvez utiliser cette API pour créer des collections utilisées dans les boutiques et ajouter des métadonnées dans un ensemble de produits, comme une image de couverture et une description. Ces ensembles de produits peuvent alors être utilisés comme collections dans le Gestionnaire des ventes pour personnaliser votre boutique Facebook ou Instagram (sinon, les collections sont créées manuellement). Vous pouvez également publier directement ces ensembles de produits disponibles en indiquant les ID de boutique. Les ID de boutique peuvent être obtenus en utilisant les API Commerce.

Découvrez comment créer une collection dans le Gestionnaire des ventes, Pages d’aide pour les entreprises.

POST (API Create/Update)

La procédure de création et de mise à jour des ensembles de produits reste la même. Il y a toutefois quelques nouveaux champs facultatifs :

Champs de métadonnées

Champs de publication dans les boutiques

Le champ publish_to_shops accepte une liste vide ou une liste avec les paramètres présentés dans l’exemple ci-dessous. En cas de liste vide, la publication de l’ensemble de produits concerné sera annulée dans toutes les boutiques (si cet ensemble avait été publié auparavant).

Exemple — Charge utile

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

Créer un ensemble de produits

Pour créer un ensemble de produits avec les métadonnées de la collection qui correspondent aux ID de produit spécifiques :

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

Mettre à jour un ensemble de produits

Pour mettre à jour un ensemble de produits avec les métadonnées de la collection et le publier dans les boutiques :

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

GET (API Read)

Sur le nœud GET, le champ live_metadata renvoie les métadonnées qui sont publiées et en direct concernant un ensemble de produits donné, tandis que le champ latest_metadata renvoie les métadonnées qui ont été envoyées en dernier lieu à l’API. Ces champs peuvent être différents ; par exemple, si une image a été changée lors de la mise à jour et rejetée pour des questions d’intégrité.

Champs de métadonnées

Exemple — Lire un ensemble de produits pour voir quelles métadonnées sont en direct :

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

Réponse :

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

Questions/réponses

Q : Quel est le format minimal acceptable pour une image de couverture ?

R : Les images doivent présenter un format minimal de 600x600 (même si le recadrage de modification est indisponible pour ce format). Si vous importez une image ayant un format minimal de 800x800, un format carré est sélectionné par défaut. Pour un résultat optimal, nous recommandons un format de 1080x1080.

Q : Quelle est la taille de fichier maximale pour une image de couverture ?

R : La taille de fichier maximale est de 8 Mo.

Q : Quels sont les formats de fichiers pris en charge pour les images de couverture ?

R : Les formats JPG et PNG sont pris en charge.

Q : Y a-t-il des limites de caractères pour la description ?

R : Il n’y a pas de limites de caractères pour la description. La limite est de 200 caractères.

Q : Comment annuler la publication d’une collection (ensemble de produits) dans les boutiques ?

R : Vous pouvez utiliser l’API Update et supprimer le champ shop_id de la liste publish_to_shop où il était publié auparavant. Si la liste est vide ([]), la publication de l’ensemble de produits est annulée dans toutes les boutiques.

En savoir plus

• Créer une collection dans le Gestionnaire des ventes, Pages d’aide pour les entreprises
• Ensembles de produits, Références MAPI