Praktik Terbaik CSS API

Dokumen ini menjelaskan beberapa praktik terbaik terkait penggunaan CSS API. Saran yang diberikan di halaman ini tidak wajib untuk menggunakan API, tetapi dapat membantu memperjelas beberapa penggunaan yang dimaksudkan.

Menyiapkan lingkungan Anda

Untuk menyiapkan lingkungan pengembangan, ikuti langkah-langkah yang diberikan dari dokumentasi Mulai Cepat.

• Buat file JSON pengguna dan izin di Konsol Google Cloud
• Aktifkan CSS API di Konsol Google Cloud
• Tambahkan pengguna tersebut dengan izin Admin ke Akun CSS Anda (Grup CSS atau Domain CSS)
• Pastikan Anda menggunakan cakupan OAuth yang benar: https://www.googleapis.com/auth/content

Library klien kini ada di repositori standar untuk sebagian besar bahasa pemrograman. Anda dapat menemukan daftar library klien di halaman client library kami.

Menggunakan ID yang benar

Gunakan ID yang benar dengan endpoint API yang benar:

• CSS API (css.googleapis.com): Gunakan ID Domain CSS saat berinteraksi dengan produk CSS (misalnya, accounts/{cssDomainId}/cssProductInputs:insert).
• Merchant API (merchantapi.googleapis.com): Gunakan Merchant API untuk produk penjual standar.

Mencampuradukkan keduanya akan menyebabkan error. Lihat Ringkasan CSS API untuk mengetahui detail selengkapnya.

Metode yang baik untuk memulai

Sebaiknya lakukan pengujian dengan metode berikut:

ListChildAccounts

ListChildAccounts adalah panggilan hanya baca yang mencantumkan semua Domain CSS Anda (jika dipanggil untuk Grup CSS) atau Penjual Anda (jika dipanggil untuk Domain CSS). Oleh karena itu, ini adalah metode yang baik untuk menguji apakah semuanya telah disiapkan dengan benar.

Menyisipkan/Mencantumkan/Memperbarui/Menghapus produk

Setelah Anda mengetahui bahwa API itu sendiri berfungsi, coba tambahkan produk. Pastikan Anda menggunakan raw_provided_id yang Anda ingat.

• Sisipkan produk uji menggunakan InsertCssProductInput. Kami memiliki contoh kode jika Anda memerlukan bantuan terkait atribut yang akan dikirim.
• Cantumkan semua produk Anda menggunakan ListCssProducts. Ada sedikit penundaan pemrosesan sebelum produk muncul setelah dimasukkan, jadi jika Anda tidak melihatnya, coba lagi setelah beberapa detik.
• Perbarui satu produk menggunakan UpdateCssProductInput menggunakan cssproductinput.name Anda. Anda hanya perlu mengirimkan atribut yang perlu diperbarui. Lihat contoh kode di sini.
• Hapus produk pengujian menggunakan DeleteCssProductInput. Anda harus menggunakan raw_provided_id.

Menggunakan Async untuk meningkatkan performa

CSS API dirancang untuk panggilan paralel. Anda akan mendapati bahwa performa operasi tunggal bisa lambat, tetapi akan jauh lebih cepat saat memanggil operasi yang sama beberapa kali secara paralel. Cara terbaik untuk menggunakan fitur ini adalah dengan menggunakan fungsi asinkron bahasa pemrograman Anda.

Contoh dari beberapa bahasa pemrograman:

• Untuk Java, gunakan insertCssProductInputCallable().futureCall()
• Untuk Python, gunakan CssProductInputsServiceAsyncClient
• Untuk C#, gunakan InsertCssProductInputAsync

Temukan dan gunakan fungsi Asinkron bahasa pemrograman Anda untuk menyisipkan beberapa produk secara bersamaan. Anda tidak perlu khawatir sistem kami akan kelebihan beban - inilah fungsi batas kuota.

Detail selengkapnya dapat ditemukan di halaman performa kami.

Memvalidasi Payload Anda

Untuk menghindari error umum, pastikan payload JSON Anda diformat dengan benar:

• Lihat Dokumentasi Resmi: Selalu lihat referensi CSS API terbaru untuk definisi kolom, enum, jenis data, dan struktur payload.
• Tinjau Payload Contoh: Bandingkan payload Anda dengan contoh kode yang diberikan untuk mengidentifikasi perbedaan.
• Jenis Data: Pastikan Anda menggunakan jenis data yang benar (misalnya, string, objek, array) seperti yang ditentukan dalam dokumentasi.
• Uji Secara Bertahap: Mulai dengan payload valid minimal untuk mengonfirmasi konektivitas dasar dan secara bertahap tambahkan lebih banyak atribut.

Memperbarui produk

Setelah diupload, produk akan tetap berada di sistem kami hingga diperbarui, dihapus, atau masa berlakunya habis.

• Anda dapat memperbarui produk lengkap dengan mengirimkan InsertCssProductInput permintaan lagi, menggunakan raw_provided_id yang sama dengan yang Anda gunakan sebelumnya. Untuk saat ini, Anda harus mengirimkan data produk lengkap, meskipun hanya beberapa atribut (mungkin hanya harga/ketersediaan) yang berubah.
• Anda dapat memperbarui bagian produk, menggunakan metode PATCH UpdateCssProductInput, dengan menentukan nama produk,dan isi JSON yang berisi data yang ingin Anda perbarui untuk produk tersebut. Tidak seperti InsertCssProductInput, yang mengharuskan semua kolom yang berlaku untuk disediakan, UpdateCssProductInput hanya mengharuskan Anda menentukan kolom yang ingin diubah.
• Anda dapat menghapus produk dengan memanggil DeleteCssProductInput dengan raw_provided_id yang sama.
• Masa berlaku produk akan otomatis berakhir sekitar satu bulan setelah update terakhir.

Mode operasi berkelanjutan

Mode operasi berkelanjutan dapat terlihat seperti berikut:

• Gunakan ID internal Anda sendiri sebagai raw_provided_id.
• Upload ulang semua produk secara terjadwal, mungkin setiap minggu. Tindakan ini akan memastikan bahwa produk aktif tidak berakhir.
• Perbarui setiap produk segera setelah Anda mendapatkan data yang berubah dari penjual Anda.
  • Jika Anda tidak dapat segera bereaksi terhadap perubahan, temukan semua produk yang berubah secara berkala (mungkin setiap jam) dan upload ulang hanya produk tersebut.
  • Untuk produk yang tidak lagi tersedia, Anda dapat menggunakan panggilan penghapusan atau menetapkan jumlah penawaran yang tersedia ke 0.
  • Jangan sering mengirimkan produk yang tidak berubah. Panggilan ini akan dihitung dalam kuota API Anda. Pembaruan mingguan sudah cukup.

Pemilihan penawaran headline

Penawaran headline tidak harus menjadi penawaran teratas atau penawaran termurah di situs Anda, tetapi harus ditampilkan dengan jelas. Anda dapat menggunakan opsi ini jika penawaran teratas Anda berubah dengan cepat: Di sini, Anda dapat memilih penawaran lain yang lebih stabil.

Periksa kembali dokumen ini dari waktu ke waktu

Kami telah menerima masukan tentang cara meningkatkan kualitas API ini, dan sedang berupaya menyediakan beberapa peningkatan ini. Halaman ini akan diperbarui saat kami memiliki fitur baru yang akan menyederhanakan penggunaan CSS API.