Dokumen ini sudah diperbarui.
Terjemahan ke Bahasa Indonesia belum selesai.
Bahasa Inggris diperbarui: 17 Des 2021

API Koleksi Set Produk

Anda dapat menggunakan API ini untuk membuat koleksi yang digunakan di Toko dan menambahkan metadata ke kumpulan produk, seperti gambar sampul dan deskripsi. Set produk tersebut kemudian siap digunakan sebagai koleksi di Commerce Manager untuk menyesuaikan Facebook Shop atau Instagram Shop (jika tidak, Koleksi dibuat secara manual). Anda juga dapat langsung menerbitkan set produk siap pakai tersebut dengan memberikan ID toko. ID Toko dapat diperoleh dari menggunakan Commerce API.

Pelajari selengkapnya cara Membuat Koleksi di Commerce Manager, Pusat Bantuan Bisnis.

POST (API Buat/Perbarui)

Membuat dan memperbarui set produk tetap sama. Namun ada beberapa kolom opsional baru untuk diperhatikan:

KolomDeskripsi

metadata

Opsional.

Parameter induk blok metadata untuk koleksi.

publish_to_shops

Opsional.

Parameter untuk menyediakan shop_id(s) agar langsung membuat/memperbarui set produk dan menerbitkannya ke toko.

Kolom Metadata


KolomDeskripsi

cover_image_url

Opsional.

URL gambar sampul untuk koleksi.

description

Opsional.

Deskripsi set produk yang menghadap pelanggan.

external_url

Opsional.

URL koleksi. URL ini tidak ditampilkan kepada konsumen, tetapi berfungsi sebagai default saat membuat iklan yang mempromosikan set produk Anda.

Menerbitkan ke Kolom Toko

Kolom publish_to_shops menerima array atau array kosong dengan parameter yang ditunjukkan pada contoh di bawah ini. Jika dan array kosong disediakan, set produk yang diberikan akan batal diterbitkan dari semua toko (jika diterbitkan lebih awal).


KolomDeskripsi

shop_id

shop_id diharapkan di sini dan dapat diperoleh menggunakan Commerce API.

Contoh — Muatan

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

Membuat Set Produk

Buat set produk dengan metadata Koleksi yang cocok dengan ID produk tertentu:

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

Memperbarui Set Produk

Perbarui set produk yang ada dengan metadata Koleksi dan terbitkan ke toko:

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 Baca)

Pada node GET, kolom live_metadata memberikan metadata yang diterbitkan dan aktif pada set produk tertentu, sedangkan kolom latest_metadata memberikan metadata yang dikirimkan terakhir ke API. Kolom ini mungkin berbeda jika, misalnya, gambar diubah saat diperbarui dan ditolak karena alasan integritas.

Semua kolom adalah kolom non-default dan harus secara eksplisit dipanggil di Graph API sebagai parameter kolom.

KolomDeskripsi

latest_metadata

Informasi metadata terbaru yang dikirimkan. Mungkin tidak sama seperti live_metadata (contoh: jika review_status berupa REJECTED).

live_metadata

Metadata aktif, saat ini untuk set produk ini.

Kolom Metadata


KolomDeskripsi

cover_image_url

URL gambar sampul hadap pelanggan untuk set produk.

description

Deskripsi set produk yang menghadap pelanggan.

external_url

URL koleksi. URL ini tidak ditampilkan kepada konsumen, tetapi berfungsi sebagai default saat membuat iklan yang mempromosikan set produk Anda.

integrity_review_status

Status tinjauan integritas. Dapat berupa salah satu APPROVED, REJECTED, PENDING.

Contoh — Baca set produk untuk melihat metadata apa yang aktif:

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}

Tanggapan:

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

Pertanyaan Umum

T: Berapa rasio aspek minimum yang dapat diterima untuk gambar sampul?

J: Gambar harus berukuran minimal 600x600 (walaupun pemotongan edit tidak tersedia pada rasio ini). Jika mengunggah 800x800 atau lebih besar, rasio aspek persegi dipilih sebagai default. Untuk hasil terbaik, kami merekomendasikan rasio aspek 1080x1080.

T: Berapa ukuran file maksimum untuk gambar sampul?

J: Ukuran file maksimal adalah 8 MB.

T: Format file apa yang didukung untuk gambar sampul?

J: JPG dan PNG didukung.

T: Apakah ada batasan panjang pada deskripsi?

J: Tidak ada panjang minimal untuk deskripsi. Panjang maksimalnya adalah 200 karakter.

T: Bagaimana cara membatalkan penerbitan Koleksi (set produk) dari Toko?

J: Anda dapat menggunakan API Perbarui dan hapus kolom shop_id dari daftar publish_to_shop tempatnya diterbitkan sebelumnya. Jika array kosong ([]) disediakan, set produk akan batal diterbitkan dari semua toko.