Questo documento è stato aggiornato.
La traduzione in Italiano non è ancora completa.
Aggiornamento inglese: 8 ott 2021

API Product Set Collection

Puoi usare questa API per creare raccolte utilizzate negli Shop e aggiungere metadati a un insieme di prodotti, come un'immagine di copertina e una descrizione. Questi insiemi di prodotti sono poi pronti all'uso come raccolte in Gestore delle vendite per personalizzare il tuo Shop di Facebook o Instagram (in alternativa, le raccolte vengono create manualmente). Puoi anche pubblicare direttamente gli insiemi di prodotti pronti indicando gli ID dello shop. Gli ID dello shop possono essere ottenuti con l'utilizzo delle API Commerce.

Scopri la procedura di Creazione di una raccolta in Gestore delle vendite, Centro assistenza per le aziende.

POST (API di creazione/aggiornamento)

Le procedure di creazione e aggiornamento degli insiemi di prodotti rimangono le stesse, ma ci sono alcuni nuovi campi facoltativi da considerare:

CampoDescrizione

metadata

Facoltativo.

Parametro principale per il blocco di metadati per le raccolte.

publish_to_shops

Facoltativo.

Parametro per fornire uno o più shop_id per creare/aggiornare direttamente l'insieme di prodotti e pubblicarlo negli shop.

Campi di metadati


CampoDescrizione

cover_image_url

Facoltativo.

URL dell'immagine di copertina per la raccolta.

description

Facoltativo.

Descrizione dell'insieme di prodotti visualizzata dal cliente.

external_url

Facoltativo.

URL della raccolta. Questo URL non è mostrato ai clienti, ma serve come valore predefinito in fase di creazione delle inserzioni che promuovono il tuo insieme di prodotti.

Pubblicazione nei campi degli shop

Il campo publish_to_shops accetta un array vuoto o con i parametri mostrati nell'esempio sotto. Se viene fornito un array vuoto, l'insieme di prodotti verrà rimosso da tutti gli shop (se pubblicato in precedenza).


CampoDescrizione

shop_id

Qui è previsto lo shop_id, che può essere ottenuto utilizzando le API Commerce.

Esempio: payload

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

Creazione di un insieme di prodotti

Crea un insieme di prodotti con i metadati delle raccolte corrispondenti a specifici ID prodotto:

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

Aggiornamento di un insieme di prodotti

Aggiorna un insieme di prodotti esistente con i metadati delle raccolte e pubblicalo negli shop:

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 di lettura)

Sul nodo GET, il campo live_metadata restituisce i metadati pubblicati e live su un particolare insieme di prodotti, mentre il campo latest_metadata restituisce gli ultimi metadati inviati all'API. Questi campi possono variare se, ad esempio, un'immagine viene modificata dopo l'aggiornamento e rifiutata per motivi di integrità.

Tutti i campi sono campi non predefiniti e devono essere chiamati esplicitamente nell'API Graph come parametri di campo.

CampoDescrizione

latest_metadata

Ultime informazioni sui metadati inviate. Potrebbero non coincidere con live_metadata (ad esempio, se review_status è REJECTED).

live_metadata

Metadati pubblicati correnti per questo insieme di prodotti.

Campi di metadati


CampoDescrizione

cover_image_url

URL dell'immagine di copertina per l'insieme di prodotti visualizzata dal cliente.

description

Descrizione dell'insieme di prodotti visualizzata dal cliente.

external_url

URL della raccolta. Questo URL non è mostrato ai clienti, ma serve come valore predefinito in fase di creazione delle inserzioni che promuovono il tuo insieme di prodotti.

integrity_review_status

Stato dell'analisi di integrità. Può essere uno tra APPROVED, REJECTED, PENDING.

Esempio: leggi un insieme di prodotti per vedere quali metadati risultano pubblicati:

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}

Risposta:

{ 
    "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"
    }
}

FAQ

D: Quali sono le proporzioni minime accettabili per un'immagine di copertina?

R: Le immagini devono essere almeno 600 x 600 (anche se la funzione di ritaglio non è disponibile per queste proporzioni). Se si carica un'immagine con proporzioni 800 x 800 o maggiori, viene selezionato per impostazione predefinita un formato quadrato. Per risultati ottimali, consigliamo di applicare proporzioni di 1080 x 1080.

D: Quai sono le dimensioni di file massime per un'immagine di copertina?

R: La dimensione massima consentita per un file è 8 MB.

D: Quali formati file sono supportati per le immagini di copertina?

R: Sono supportati i formati JPG e PNG.

D: Sono previste restrizioni di lunghezza per la descrizione?

R: Non è prevista una lunghezza minima per la descrizione. La lunghezza massima è di 200 caratteri.

D: In che modo posso rimuovere una raccolta (insieme di prodotti) dagli shop?

R: Puoi usare l'API Update e rimuovere il campo shop_id dalla lista publish_to_shop in cui è stato precedentemente pubblicato. Se è fornito un array vuoto ([]), l'insieme di prodotti viene rimosso da tutti gli shop.