Referensi

Gunakan referensi ini untuk melihat kolom yang didukung dan contoh masing-masing untuk endpoint POST /{catalog_id}/items_batch dan POST /{catalog_id}/batch.

Nama parameter untuk /{catalog_id}/batch dan /{catalog_id}/items_batch mungkin tampak serupa, tetapi jelas berbeda.

Kami rekomendasikan menggunakan API /{catalog_id}/items_batch, yang mendukung lebih banyak kasus penggunaan dan dikelola secara aktif.

Kolom yang Didukung - Kirim Pembaruan Produk - /{catalog_id}/batch

Kolom-kolom ini didukung untuk metode CREATE dan UPDATE.

Membatalkan pengaturan kolom

Saat memperbarui item, tetapkan string kosong sebagai nilai untuk membatalkan pengaturan kolom opsional. Mengatur nilai sebagai nulltidak akan membatalkan pengaturan kolom tersebut.

Kolom Deskripsi

additional_image_urls

jenis:

array<string>

Opsional.

URL untuk hingga 9-10 gambar.

additional_variant_attributes

jenis:

list<KeyValue:string,string>

Opsional.

Atribut tambahan untuk membedakan produk dalam kelompok variannya.

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

availability

jenis: string

Wajib

Mengidentifikasi status ketersediaan:

  • in stock - Produk langsung dikirim.
  • out of stock - Tidak ada rencana mengisi ulang stok
  • available for order - Dikirim dalam 1-2 minggu.
  • discontinued

age_group

jenis: string

Opsional.

Kelompok orang dengan usia yang sama atau mirip. Nilai yang diterima adalah newborn, infant, toddler, kids, adult.

applinks

jenis:

objek<>

Opsional.

Tautan ke aplikasi seluler.

category

jenis: string

Opsional tetapi direkomendasikan untuk iklan katalog Advantage+ (dapat membantu meningkatkan kinerja iklan). Opsional untuk Instagram Shopping dan toko Halaman, tetapi wajib ada untuk mengaktifkan proses pembayaran di situs pada saluran-saluran ini (hanya di AS). Wajib ada untuk Marketplace (hanya di AS).

Kategori produk Google (Google Product Category atau GPC) untuk produk tersebut. Gunakan jalur taksonomi kategori atau nomor ID-nya, yang tercantum di sini.

Jika Anda menggunakan proses pembayaran di Instagram atau Facebook (khusus AS), GPC suatu produk akan memengaruhi pajak dan kebijakan retur produk tersebut. Pelajari selengkapnya tentang Kategori produk Google untuk produk katalog, Pusat Bantuan Iklan.

Contoh: Apparel & Accessories > Clothing > Shirts & Tops atau 212

color

jenis: string

Opsional.

Ukuran maksimum: 100.

Warna produk.

condition

jenis: string

Wajib.

Kondisi produk: new, refurbished, used.

currency

jenis: string

Wajib.

Mata uang untuk nilai yang ditentukan. Marketing API mendukung semua mata uang yang didukung oleh akun iklan. Gunakan ISO 4217 untuk standar mata uang.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

jenis: string

Opsional.

Batas karakter maks.: 100

Informasi tambahan tentang produk. Tetapkan string kosong untuk membatalkan pengaturan.

description

jenis: string

Wajib.

Ukuran maksimal: 5000.

Deskripsi singkat untuk produk.

gender

jenis: string

Opsional.

Jenis kelamin untuk ukuran. Nilai termasuk male, female, unisex.

gtin

jenis: string

Opsional.

Ukuran maksimum: 70.

Nomor Produk Perdagangan Global dapat mencakup UPC,EAN, JAN, dan ISBN.

image_url

jenis: string

Wajib.

Tautkan ke gambar produk yang digunakan dalam iklan. Tetapkan ukuran gambar yang tepat.

Untuk gambar tunggal, iklan katalog Advantage+

  • Syarat resolusi gambar minimum adalah 500px * 500px
  • Syarat rasio aspek minimum adalah 4:5
  • Syarat rasio aspek maksimum adalah 1.91:1.

Jika gambar berada di luar rasio aspek ini, Facebook akan memangkasnya agar mendekati rasio aspek minimum atau rasio aspek maksimum tergantung pada rasio aspek aslinya.

Untuk gambar carousel, iklan katalog Advantage+ - Syarat resolusi gambar minimum adalah 500px * 500px, dan Facebook memangkasnya menjadi rasio aspek 1:1.

Rekomendasi: Jangan terlalu sering mengubah image url. URL gambar tidak boleh mengandung parameter, seperti price atau timestamp karena parameter ini cenderung sering berubah.

inventory

jenis: angka

Opsional.

Bilangan bulat yang dapat digunakan pengiklan untuk menyimpan informasi tentang tingkat stok.

marked_for_product_launch

jenis: string

N/A untuk iklan katalog Advantage+. Opsional untuk perdagangan.

Menunjukkan apakah suatu produk akan digunakan dalam peluncuran produk. Nilai yang didukung:

  • marked: Produk akan disembunyikan dari pembeli hingga peluncuran produk dibuat. Hal ini mencegah produk tersedia untuk dilihat dan dibeli sebelum waktu peluncuran yang diinginkan.
  • not_marked (default): Produk tersebut tidak akan disertakan dalam peluncuran produk.

name

jenis: string

Wajib.

Ukuran maksimum: 100.

Judul produk.

pattern

jenis: string

Opsional

Ukuran maksimum: 100.

Pola atau motif gambar pada produk.

price

jenis: bilangan bulat

Wajib.

Harga dikalikan dengan 100, untuk semua mata uang. Contoh: 490 jika digunakan dengan USD menunjukkan $4,90, dan 49000 jika digunakan dengan JPY menunjukkan ¥490.

product_type

jenis: string

Opsional.

Ukuran maksimum: 750.

Kategori yang ditentukan peritel untuk produk.

Contoh: di TSV Rumah & Taman > Dapur & Ruang Makan > Peralatan > Kulkas.

Contoh: dalam XML product_type > Rumah & Taman > Dapur & Ruang Makan > Peralatan > Kulkas > product_type.

retailer_product_group_id

jenis: string

Opsional.

Menerima string. Pengiklan dapat menggunakannya untuk mengelompokkan produk.

sale_price

jenis: bilangan bulat

Opsional.

Harga diskon jika produk itu diobral. Ini adalah harga jual dikalikan 100, untuk semua mata uang. Contoh: 490 jika digunakan dengan USD menunjukkan $4,90, dan 49000 jika digunakan dengan JPY menunjukkan ¥490.

sale_price_start_date

jenis: string

Opsional.

Tanggal dan waktu akhir untuk obral.

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

sale_price_end_date

jenis: string

Opsional.

Tanggal dan waktu mulai untuk obral.

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

shipping

jenis:

array<object>

Opsional.

Informasi pengiriman.

size

jenis: string

Opsional.

Ukuran produk. Contoh: Small atau XL.

url

jenis: string

Wajib.

Tautan ke situs pedagang untuk membeli produk tersebut.

vendor_id

jenis: string

Opsional.

ID vendor/penjual yg menjual produk tersebut.

Contoh Permintaan - /{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",
      }
    }
  ]
}

Contoh Tanggapan - /{catalog_id}/batch

Satu atau lebih nama pengguna akan dikembalikan.

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

Kolom yang Didukung - Kirim Pembaruan Produk - /{catalog_id}/items_batch

Untuk katalog jual beli — Gunakan API ini jika Anda perlu memperbarui informasi produk lebih dari sekali dalam sejam (jika tidak, gunakan Feed API). Anda dapat memperbarui beberapa item dalam satu permintaan HTTP.

PRODUCT_ITEM

Kolom produk ini didukung untuk metode CREATE dan UPDATE, untuk versi 3.3 dan 3.2:

KolomDeskripsi

additional_image_link

jenis:

array<string>

Opsional.

Tautan untuk hingga 9-10 gambar.

additional_variant_attribute

jenis:

list<KeyValue:string,string>

Opsional.

Atribut tambahan untuk membedakan produk dalam kelompok variannya.

Contoh: "Scent:Fruity,Flavor:Apple"

age_group

jenis: string

Opsional.

Kelompok orang dengan usia yang sama atau mirip. Nilai yang diterima adalah newborn, infant, toddler, kids, adult.

applink

jenis:

objek<string>

Opsional.

Tautan ke aplikasi seluler.

Contoh:

"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

jenis: string

Wajib.

Mengidentifikasi status ketersediaan:

  • in stock - Produk langsung dikirim
  • out of stock - Tidak ada rencana mengisi ulang stok
  • available for order - Dikirim dalam 1–2 minggu
  • discontinued

brand

jenis: string

Opsional.

Merek item.

color

jenis: string

Opsional.

Ukuran maksimum: 100.

Warna produk.

condition

jenis: string

Wajib.

Kondisi produk: new, refurbished, atau used.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Jenis: string

Opsional.

Batas karakter maks.: 100

Informasi tambahan tentang produk.

description

jenis: string

Wajib.

Ukuran maksimal: 5000.

Teks pendek yang menggambarkan produk.

disabled_capabilities

jenis:

array<string>

Opsional.

Daftar kemampuan untuk dinonaktifkan. Nilai yang mungkin adalah: 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

jenis: string

Opsional.

Jenis kelamin untuk ukuran. Nilai termasuk male, female, unisex.

google_product_category

jenis: string

Opsional.

Ukuran maksimum: 250.

Nilai yang telah ditentukan sebelumnya (string atau ID kategori) dari taksonomi produk Google.

Contoh: Pakaian & Aksesori > Pakaian > Gaun atau 2271.

gtin

jenis: string

Opsional.

Ukuran maksimum: 70.

Nomor Produk Perdagangan Global (Global Trade Item Number atau GTIN) dapat mencakup UPC, EAN, JAN, dan ISBN.

id

jenis: string

Wajib.

ID peritel

image

jenis: array <object>

URL dan tanda untuk gambar yang akan digunakan dalam iklan Anda atau di toko. Mendukung hingga 20 gambar. Tanda bersifat opsional dan, jika digunakan, harus menggambarkan apa yang ada dalam gambar.


Contoh:

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

image_link

jenis: string

Tidak wajib jika image ditetapkan.

Kami menyarankan menggunakan image daripada kolom ini. Saat image ditetapkan, image_link dan additional_image_link diabaikan.

Tautkan ke gambar produk yang digunakan dalam iklan. Tetapkan ukuran gambar yang tepat.

Untuk iklan katalog Advantage+ gambar tunggal:

  • Syarat resolusi gambar minimum adalah 500px*500px.
  • Syarat rasio aspek minimum adalah 4:5.
  • Syarat rasio aspek maksimum adalah 1.91:1. Jika gambar berada di luar rasio aspek ini, Facebook akan memangkasnya agar mendekati rasio aspek minimum atau rasio aspek maksimum, tergantung rasio aspek aslinya.

Untuk gambar carousel, iklan katalog Advantage+: Syarat resolusi gambar minimum adalah 500px*500px, dan Facebook memangkasnya menjadi rasio aspek 1:1.

internal_label

jenis: string

Tambahkan label internal untuk membantu memfilter produk saat Anda membuat set produk. Misalnya, Anda bisa menambahkan label "musim panas" ke semua produk yang merupakan bagian dari promosi musim panas dan memfilter produk tersebut ke dalam set. Label hanya terlihat oleh Anda

Cantumkan setiap label dalam tanda kutip tunggal (') dan pisahkan beberapa label dengan koma (,). Jangan sertakan spasi kosong di bagian awal atau akhir label. Batas karakter: Hingga 5.000 label per produk dan 110 karakter per label.

Contoh (TSV, XLSX, Google Sheets): ['musim panas','sedang tren']

Contoh (CSV): “['musim panas','sedang tren']"

Catatan: Jika saat ini Anda menggunakan label khusus (custom_label_0 hingga custom_label_4) untuk memfilter set produk, sebaiknya beralih ke label internal (internal_label). Tidak seperti label khusus, Anda bisa menambahkan atau memperbarui label internal sesering yang diperlukan tanpa harus mengirim produk melalui tinjauan kebijakan setiap ada penambahan atau pembaruan, yang bisa memengaruhi penayangan iklan.

Kolom ini sebelumnya disebut product_tags. Meskipun kami masih mendukung nama kolom lama, kami merekomendasikan Anda menggunakan nama baru.

inventory

jenis: objek

Opsional.

Bilangan bulat yang dapat digunakan pengiklan untuk menyimpan informasi tentang tingkat stok.

item_group_id

jenis: string

Opsional.

ID yang disediakan pengiklan dari grup produk; bukan FBID. Menerima string. Dapat digunakan oleh pengiklan untuk mengelompokkan beragam objek (item produk, kendaraan, hotel, penerbangan, dan sebagainya).

link

jenis: string

Wajib.

Tautan ke situs pedagang untuk membeli produk tersebut.

manufacturer_part_number

jenis: string

Opsional.

ID produsen unik untuk produk.

pattern

jenis: string

Opsional.

Ukuran maksimum: 100.

Pola atau motif gambar pada produk.

price

jenis: string

Wajib.

Harga produk. Format harga sebagai biaya, diikuti dengan kode mata uang ISO 3 digit, dengan spasi di antara biaya dan mata uang.

Contoh: 9.99 USD.

rating_count

jenis: angka

Opsional.

Jumlah peringkat yang diberikan pembeli untuk produk ini. Harus lebih besar dari 0. Ini harus digunakan bersamaan dengan user_rating.

Contoh: 100

sale_price

jenis: string

Opsional, tetapi wajib ada untuk menggunakan fitur Overlay untuk iklan katalog Advantage+.

Harga diskon jika produk itu diobral. Format harga sebagai biaya, diikuti dengan kode mata uang ISO 3 digit, dengan spasi di antara biaya dan mata uang.

Contoh: 9.99 USD, 25.00 EUR

sale_price_effective_date

jenis: string

Opsional.

Tanggal dan waktu mulai dan selesai untuk obral, dipisahkan oleh garis miring. Tulis tanggal mulai dan selesai dalam format YYYY-MM-DD. Tambahkan "T" setelah setiap tanggal, lalu sertakan waktunya. Tulis waktu dalam format 24 jam (00:00 hingga 23:59).

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

shipping

jenis: string

Opsional.

Blob dengan harga yang berbeda untuk setiap negara dan wilayah. Daerah yang berbeda dipisahkan koma. Formatnya harus COUNTRY:STATE:SHIPPING_TYPE:PRICE.

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

size

jenis: string

Opsional.

Ukuran produk. Contoh: Small atau XL.

title

jenis: string

Wajib.

Ukuran maksimum: 100.

Judul produk.

user_rating

jenis: angka

Opsional.

Peringkat rata-rata yang diberikan pembeli untuk produk ini. Rentang antara 1,0 dan 5,0. Satu tempat desimal diizinkan. Ini harus digunakan bersamaan dengan rating_count.

Contoh: 4,5

video

jenis: array <object>

URL dan tanda untuk video yang akan digunakan dalam iklan Anda atau di toko. Mendukung hingga 30.000 video pada tingkat katalog. Tanda bersifat opsional dan, jika digunakan, harus menggambarkan apa yang ada dalam video.


Ukuran file video maksimum adalah 200 MB. Format yang didukung meliputi .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, dan .wmv


Contoh:

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

CATATAN: Untuk menghapus video 1 jika produk memiliki video 1, 2, hapus video 1 dari array:

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

Untuk menghapus semua video, kirim array kosong:

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

Metode UPDATE juga dapat digunakan untuk membuat item jika belum ada.

Pelajari lebih lanjut tentang kolom produk di Referensi API.

Contoh Permintaan - 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",
        }
      }
    ]
  }

Contoh Tanggapan - PRODUCT_ITEM

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

Pelajari selengkapnya tentang Menambahkan Produk Katalog dengan Kabar Data.


HOTEL

Kolom produk yang didukung untuk metode CREATE dan UPDATE untuk jenis HOTEL, untuk Versi 3.2:

KolomDeskripsi

address

jenis:

objek<string>

Wajib.

Alamat hotel.

applink

jenis:

Opsional.

Tautan ke aplikasi seluler.

base_price

jenis: string

Wajib.

Harga dasar kamar hotel per malam. Tambahkan jenis mata uang ke harga. Format harga sebagai biaya, diikuti dengan kode mata uang ISO, dengan spasi di antara biaya dan mata uang. Contoh: USD untuk dolar AS.

brand

jenis: string

Opsional.

Merek jaringan hotel.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

Jenis: string

Batas karakter maks.: 100

Hingga lima kolom khusus untuk informasi tambahan yang bisa digunakan untuk memfilter produk saat Anda membuat set. Contohnya, Anda bisa menggunakan kolom khusus untuk menunjukkan bahwa semua ruang merupakan bagian obral musim panas, lalu memfilter ruang itu ke dalam set. Kolom ini mendukung semua nilai teks, termasuk angka.


Contoh: Summer Sale

Kolom ini didukung oleh kabar tambahan.

custom_number_0
custom_number_1
custom_number_2
custom_number_3
custom_number_4

Jenis: int

Maksimal lima kolom khusus untuk informasi tambahan terkait angka yang bisa digunakan untuk memfilter barang saat Anda membuat set. Kolom ini memungkinkan Anda untuk memfilter menurut rentang angka (lebih besar dari dan kurang dari) saat Anda membuat set. Contohnya: Anda bisa menggunakan kolom ini untuk menunjukkan tahun hotel dibuka, lalu memfilter rentang tahun tertentu ke dalam set.


Kolom ini mendukung bilangan bulat antara 0 dan 4294967295. Kolom ini tidak mendukung bilangan negatif, desimal, atau koma, seperti -2, 5,5, atau 10.000.


Contoh: 2022

description

jenis: string

Wajib.

Batas karakter maksimum: 5000.

Deskripsi singkat hotel.

guest_rating

jenis:

array<object>

Opsional.

Peringkat tamu hotel.

hotel_id

jenis: string

Wajib.

ID unik untuk hotel.

image

jenis:

array<object>

Wajib.

URL dan tanda untuk gambar yang akan digunakan dalam iklan. Mendukung hingga 20 gambar. Tag bersifat opsional, bila digunakan. Harus menggambarkan apa yang ada dalam gambar. Contoh: "reception".

latitude

jenis: string

Wajib.

Lokasi garis lintang hotel.

longitude

jenis: string

Wajib.

Lokasi garis bujur hotel.

loyalty_program

jenis: string

Opsional.

Program loyalitas yang digunakan untuk hotel.

margin_level

jenis: string

Opsional.

Indikator profitabilitas hotel; nilai dari 1 sampai 10.

name

jenis: string

Wajib.

Nama hotel.

neighborhood

jenis:

array<string>

Opsional.

Satu atau lebih lingkungan untuk hotel. Contoh: Soho atau Las Vegas Strip. Jumlah maksimum lingkungan yang diizinkan: 20.

phone

jenis: string

Opsional.

Nomor telepon dengan kode negara.

sale_price

jenis: string

Opsional.

Harga obral per malam di hotel. Gunakan ini untuk mengiklankan diskon dari harga biasa hotel. Wajib: Tambahkan jenis mata uang ke harga. Format harga sebagai biaya, diikuti dengan kode mata uang ISO, dengan spasi antara biaya dan mata uang. Contoh: USD untuk dolar AS.

star_rating

jenis: string

Opsional.

Peringkat bintang hotel. Angka harus di antara 1 dan 5.

url

jenis: string

Wajib.

Tautan ke situs web eksternal untuk memesan kamar hotel.

Metode UPDATE juga dapat digunakan untuk membuat item jika belum ada.

Contoh Permintaan - 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",
        }
      }
    ]
  }

Contoh Tanggapan - HOTEL

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

HOTEL_ROOM

Kolom produk ini didukung untuk metode CREATE dan UPDATE untuk jenis HOTEL_ROOM, untuk versi 3.2.

KolomDeskripsi

base_price

jenis: string

Wajib.

Harga dasar untuk 1 malam. Mata uang harus mengikuti kode mata uang ISO 4217.

Contoh: 9.99 USD.

description

jenis: string

Wajib.

Ukuran maksimal: 5000.

Teks pendek yang menggambarkan ruangan.

hotel_retailer_id

jenis: string

Wajib.

ID unik untuk peritel hotel.

hotel_room_id

jenis: string

Wajib.

ID unik untuk hotel.

image

jenis:

array<object>

Wajib.

Gambar ruangan.

name

jenis: string

Wajib.

Ukuran maksimum: 100.

Nama ruangan.

url

jenis: string

Wajib.

Tautan ke situs pengiklan untuk memesan penginapan.

Metode UPDATE juga dapat digunakan untuk membuat item jika belum ada.

Contoh Permintaan - 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",
        }
      }
    ]
  }

Contoh Tanggapan - HOTEL_ROOM

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

PENERBANGAN

Kolom produk ini didukung untuk metode CREATE dan UPDATE untuk jenis FLIGHT, untuk versi 3.2.

KolomDeskripsi

description

jenis: string

Opsional.

Batas karakter maksimum: 5000.

Deskripsi penerbangan.

destination_airport

jenis: string

Wajib.

Bandara destinasi untuk penerbangan. Harus ditulis sebagai kode IATA.

Contoh: SFO.

destination_city

jenis: string

Opsional.

Nama kota destinasi penerbangan.

image

jenis:

array<object>

Wajib.

URL dan tanda untuk gambar yang akan digunakan dalam iklan. Mendukung hingga 20 gambar. Tanda bersifat opsional, jika digunakan, harus menggambarkan apa yang ada dalam gambar.

Contoh: seat

origin_airport

jenis: string

Wajib.

Bandara asal penerbangan. Harus ditulis sebagai kode IATA.

Contoh: SFO

origin_city

jenis: string

Opsional.

Nama kota asal penerbangan.

price

jenis: string

Opsional.

Biaya dan mata uang penerbangan. Harga adalah angka yang diikuti dengan kode mata uang; gunakan standar ISO 4217. Gunakan ""."" sebagai desimal untuk harga.

url

jenis: string

Opsional.

Tautan ke situs web untuk memesan penerbangan.

Metode UPDATE juga dapat digunakan untuk membuat item jika belum ada.

Contoh Permintaan - 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": {

Contoh Tanggapan - FLIGHT

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

DESTINASI

Kolom produk ini didukung untuk metode CREATE dan UPDATE untuk jenis DESTINATION, untuk versi 3.2.

KolomDeskripsi

applink

jenis:

objek<string>

Opsional.

Tautan ke aplikasi seluler.

address

jenis:

objek<string>

Wajib.

Alamat hotel.

description

jenis: string

Opsional.

Batas karakter maksimum: 5000.

Paragraf pendek yang menjelaskan destinasi.

destination_id

jenis: string

Wajib.

Batas karakter maks: 100.

ID unik untuk destinasi.

image

jenis:

array<object>

Wajib.

URL dan tanda untuk gambar yang akan digunakan dalam iklan. Mendukung hingga 20 gambar. Tanda bersifat opsional, jika digunakan, harus menggambarkan apa yang ada dalam gambar.

Contoh: seat.

latitude

jenis: string

Wajib.

Lokasi garis lintang destinasi.

longitude

jenis: string

Wajib.

Lokasi garis bujur destinasi.

name

jenis: string

Wajib.

Nama destinasi.

neighborhood

jenis:

array<string>

Opsional.

Jumlah maksimum lingkungan yang diizinkan: 20. Satu atau beberapa lingkungan sekitar untuk destinasi.

Contoh: Soho atau Las Vegas Strip.

price

jenis: string

Opsional.

Biaya rata-rata terendah dan mata uang destinasi. Format harga sebagai angka yang diikuti dengan kode mata uang; gunakan standar ISO 4217. Gunakan ""."" sebagai desimal untuk harga.

price_change

jenis: string

Opsional.

Perubahan harga. Dapat digunakan untuk membuat set produk dan di materi iklan:

  • 0 - Tidak ada perubahan harga
  • -10 - Penurunan harga 10%
  • 20 - Kenaikan harga 20%.

Contoh: ""harga rata-rata di NYC turun sebesar X"" atau ""harga rata-rata di NYC turun""

type

jenis:

array<string>

Wajib.

Jumlah maksimum jenis destinasi: 20. Jenis destinasi. Sebuah destinasi dapat memiliki beberapa jenis.

Contoh: park atau beach

url

jenis: string

Wajib.

Tautan ke situs web untuk memesan destinasi.

Metode UPDATE juga dapat digunakan untuk membuat item jika belum ada.

Contoh Permintaan - 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",
        }
      }
    ]
  }

Contoh Tanggapan - DESTINATION

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

HOME_LISTING

Kolom produk ini didukung untuk metode CREATE dan UPDATE untuk jenis HOME_LISTING, untuk versi 3.3 dan 3.2.

KolomDeskripsi

applink

jenis:

objek<string>

Opsional.

Tautan ke aplikasi seluler.

address

jenis:

objek<string>

Wajib.

Alamat jalan untuk tawaran rumah.

availability

jenis: string

Wajib.

Ketersediaan tawaran rumah saat ini. Nilai yang didukung: for_sale, for_rent, sale_pending, recently_sold, off_market, available_soon.

available_dates_price_config

jenis:

array<object>

Opsional.

Konfigurasi harga.

description

jenis: string

Opsional.

Batas karakter maksimum: 5000.

Paragraf pendek yang menggambarkan tawaran rumah.

image

jenis:

array<object>

Wajib.

URL dan tanda untuk gambar yang akan digunakan dalam iklan. Mendukung hingga 20 gambar. Tanda bersifat opsional, jika digunakan, harus menggambarkan apa yang ada dalam gambar.

Contoh: pool.

latitude

jenis: string

Opsional.

Lokasi garis lintang tawaran rumah.

longitude

jenis: string

Opsional.

Lokasi garis bujur tawaran rumah.

listing_type

jenis: string

Opsional.

Jenis tawaran. Nilai yang didukung: for_rent_by_agent, for_rent_by_owner, for_sale_by_agent, for_sale_by_owner, foreclosed, new_construction, new_listing.

name

jenis: string

Wajib.

Nama tawaran rumah.

neighborhood

jenis:

array<object>

Opsional.

Lingkungan untuk tawaran rumah. Jumlah maksimum lingkungan yang diizinkan: 20.

num_baths

jenis: string

Opsional.

Jumlah kamar mandi.

num_beds

jenis: string

Opsional.

Jumlah kamar tidur.

num_units

jenis: string

Opsional.

Jumlah unit yang tersedia. Hanya digunakan untuk apartemen atau kondominium yang tersedia untuk disewakan.

price

jenis: string

Wajib.

Biaya dan mata uang untuk tawaran rumah. Harga adalah angka yang diikuti dengan kode mata uang; gunakan standar ISO 4217. Gunakan ""."" sebagai desimal untuk harga.

price_change

jenis: string

Opsional.

Perubahan harga. Dapat digunakan untuk membuat set produk dan di materi iklan:

  • 0 - Tidak ada perubahan harga
  • -10 - Penurunan harga 10%
  • 20 - Kenaikan harga 20%.

Contoh: ""harga rata-rata di NYC turun sebesar X"" atau ""harga rata-rata di NYC turun""

property_type

jenis: string

Opsional.

Jenis properti. Nilai yang didukung: apartment, condo, house, land, manufactured, other, townhouse.

url

jenis: string

Wajib.

Tautan ke situs web untuk melihat tawaran.

year_built

jenis: string

Opsional.

Tahun ketika rumah itu dibangun.

Metode UPDATE juga dapat digunakan untuk membuat item jika belum ada.

Contoh Permintaan - 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",
      }
    }
  ]
}

Contoh Tanggapan - HOME_LISTING

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

KENDARAAN

Untuk kolom yang didukung untuk metode CREATE dan UPDATE untuk jenis VEHICLE, lihat Kolom Katalog Stok Otomotif - Kendaraan.

Kolom yang didukung tersedia untuk Kendaraan dan Dealer.

Metode UPDATE juga dapat digunakan untuk membuat item jika belum ada.

Contoh Permintaan - 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",
        }
      }
    ]
  }

Contoh Tanggapan - VEHICLE

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

Kolom yang Didukung - Kirim Batch Produk yang Dilokalkan - /{catalog_id}/localized_items_batch

Lihat daftar kolom yang didukung dan deskripsi setiap kolom, untuk endpoint /{catalog_id}/localized_items_batch:

Lihat daftar lengkap untuk kolom yang didukung katalog.

Pelajari Selengkapnya