Bermigrasi ke Retail API dari beta

Rekomendasi sekarang menggunakan Retail API. Halaman ini menjelaskan perubahan yang diperkenalkan dan praktik terbaik migrasi saat beralih dari Recommendations Engine API versi v1beta1 (endpoint layanan https://recommendationengine.googleapis.com) ke Retail API yang tersedia secara umum (endpoint layanan https://retail.googleapis.com).

Recommendations Engine API dan rangkaian dokumentasinya tetap tersedia, tetapi tidak lagi diupdate.

Dokumen ini hanya berlaku untuk Anda jika Anda mulai menggunakan Rekomendasi saat masih dalam versi beta.

Praktik terbaik

  • Kirim traffic khusus validasi sebelum bermigrasi sepenuhnya.
  • Migrasi traffic inkremental lebih baik daripada beralih semuanya sekaligus. Jika memungkinkan, migrasikan traffic Anda secara bertahap dari v1beta1 ke v2.
  • Jika Anda menjalankan layanan di berbagai region, sebaiknya migrasikan region satu per satu untuk menghindari pemadaman layanan global.

Perubahan dokumentasi

Setelah beralih ke konsol Retail, sebaiknya gunakan dokumentasi Retail ini secara eksklusif di https://cloud.google.com/retail/docs.

Kumpulan dokumentasi beta untuk Recommendations Engine API tetap tersedia, tetapi tidak lagi diperbarui.

Perubahan konsol

Konsol Retail menggantikan konsol Rekomendasi.

Konsol Google Cloud Retail tersedia secara publik mulai 20 Januari 2022. Jika Anda menggunakan konsol Rekomendasi, sebaiknya akses project Rekomendasi dari konsol Retail.

Untuk penjelasan tentang perubahan fungsi dan terminologi di Konsol retail dibandingkan dengan konsol Rekomendasi, lihat Beralih ke Konsol Retail.

Skema peristiwa pengguna dan katalog

Skema untuk peristiwa katalog dan pengguna telah berubah di Retail API.

Penayangan konfigurasi dan penempatan

Retail API memperkenalkan konfigurasi penayangan, yang menggantikan konsep penempatan yang digunakan oleh Recommendations Engine API.

Konfigurasi penayangan tersedia mulai Rekomendasi v2 dan Retail Search v2alpha, menggunakan Retail API.

Resource servingConfig tersedia di Retail API versi v2beta dan v2alpha. Anda dapat menggunakan resource ini untuk membuat, melihat, mengedit, dan menghapus konfigurasi penayangan.

Jika Anda sudah memiliki penempatan, atau membuat penempatan baru, Retail API akan otomatis membuat konfigurasi penayangan yang terkait dengan setiap penempatan. Pembuatan konfigurasi penayangan tidak akan menghasilkan penempatan yang sesuai.

Menghapus konfigurasi penayangan akan menghapus penempatannya yang sesuai, dan menghapus penempatan akan menghapus konfigurasi penayangan yang sesuai.

Konfigurasi penayangan memungkinkan Anda mengedit opsi keberagaman dan pengurutan harga serta menerapkannya hampir secara real-time. Dengan penempatan, setelan keberagaman, dan harga hanya dapat diubah dari model rekomendasi yang menjadi acuan penempatan.

Penempatan tetap didukung, tetapi sebaiknya gunakan konfigurasi penayangan.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan konfigurasi penayangan, lihat Konfigurasi penayangan dan Membuat konfigurasi penayangan.

Jalur REST dan RPC

Banyak perubahan telah dilakukan pada jalur REST dan RPC. Pastikan Anda meninjau dokumentasi API untuk Retail API guna memastikan Anda memanggil Retail API dengan benar.

Semua jalur kini menggunakan retail.googleapis.com, bukan recommendationengine.googleapis.com.

Contoh:

v1beta1 Recommendations Engine API: 

GET https://recommendationengine.googleapis.com/v1beta1/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID

API Retail v2:

GET https://retail.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID

Beberapa resource dan metode telah diganti namanya, dihapus, atau baru ditambahkan. Tabel di bawah ini membandingkan resource v1beta1 dan v2 serta metode terkaitnya secara berdampingan.

Misalnya, catalogs.catalogItems resource v1beta1 setara dengan catalogs.branches.products resource v2. Metode list, yang tersedia di catalogs.catalogItems untuk v1beta1, tidak tersedia untuk catalogs.branches.products di v2, sehingga diindikasikan sebagai Removed.

Perlu diperhatikan bahwa link ke resource v1beta1 akan membuka dokumentasi API untuk v1beta1.

Resource v1beta1 Metode Resource v2 Metode
catalogs list catalogs list
patch patch
T/A catalogs.branches.operations get
catalogs.catalogItems create catalogs.branches.products create
delete delete
get get
import import
list Dihapus
patch patch
catalogs.operations get catalogs.operations get
list list
catalogs.eventStores.operations get Dihapus
list
catalogs.eventStores.placements predict catalogs.placements predict
catalogs.eventStores.predictionApiKeyRegistrations create Dihapus
delete
list
catalogs.eventStores.userEvents collect catalogs.userEvents collect
import import
list Dihapus
purge purge
rejoin rejoin
write write
T/A operations get
list

Perubahan IAM

Perubahan berikut telah diperkenalkan pada peran dan izin Identity and Access Management (IAM) Retail:

  • Retail menggunakan peran dan izin IAM dalam namespace retail, bukan namespace automlrecommendations yang digunakan oleh Recommendations Engine v1beta1.
  • Peran Admin Viewer telah dihapus.
  • Izin untuk apiKeys telah dihapus karena metode predict tidak lagi memerlukan kunci API-nya sendiri.