Memigrasikan setelan halaman beranda

Merchant API memperkenalkan resource khusus.Homepage Resource ini menyediakan metode baru untuk mengelola klaim halaman beranda Anda, yang menawarkan kemampuan di luar Content API for Shopping klasik.

Mengakses fitur untuk toko online Anda adalah proses dua langkah: pertama, memverifikasi kepemilikan, lalu mengklaim situs untuk akun Anda. Untuk menyelesaikan langkah terakhir, gunakan accounts.homepage.claim.

Perbedaan utama

Merchant API membuat beberapa perubahan terkait halaman beranda dibandingkan dengan Content API for Shopping:

  • Resource khusus: Merchant API menyediakan resource Homepage yang berbeda (accounts.homepage) untuk semua operasi terkait halaman beranda. Di Content API for Shopping, Anda menggunakan accounts.claimwebsite untuk melakukan tindakan klaim, URL halaman beranda (website_url) adalah bagian dari resource Account, dan status klaim (website_claimed) adalah bagian dari resource AccountStatus.
  • Metode terperinci: Merchant API menawarkan metode khusus untuk:
  • Informasi terpusat: Resource Homepage Merchant API berisi baik uri (URL halaman beranda) maupun status claimed secara langsung. Semua metode yang beroperasi pada resource Homepage menampilkan resource ini, sehingga memberikan masukan langsung tentang status saat ini. Di Content API for Shopping, accounts.claimwebsite tidak menampilkan status yang diperbarui; panggilan terpisah diperlukan.
  • Pembatalan klaim eksplisit: Di Content API for Shopping, pembatalan klaim biasanya dicapai dengan memperbarui Account.website_url ke string kosong. Merchant API menyediakan metode khusus.homepage.unclaim
  • Menimpa klaim: Kedua API mendukung parameter overwrite selama proses klaim untuk mengambil alih klaim dari akun lain jika kepemilikan dapat diverifikasi.

Permintaan

Merchant API menggunakan endpoint RESTful yang berbeda untuk mengelola berbagai aspek halaman beranda.

Deskripsi permintaan Content API for Shopping Merchant API
Mendapatkan detail halaman beranda accounts.get (untuk membaca Account.website_url), accountstatuses.get (untuk membaca AccountStatus.website_claimed) GET /accounts/v1/accounts/{account}/homepage
Memperbarui URI halaman beranda accounts.update (menetapkan Account.website_url) PATCH /accounts/v1/accounts/{account}/homepage
Mengklaim atau memverifikasi ulang halaman beranda POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (bertindak pada Account.website_url yang ditetapkan menggunakan accounts.update) POST /accounts/v1/accounts/{account}/homepage:claim
Membatalkan klaim halaman beranda accounts.update (menetapkan Account.website_url ke string kosong) POST /accounts/v1/accounts/{account}/homepage:unclaim

ID

Identifikasi resource telah dioptimalkan di Merchant API.

Deskripsi ID Content API for Shopping Merchant API
ID akun untuk akses resource merchantId (akun tingkat lanjut) dan accountId (sub-akun) di jalur account (bagian dari kolom name, seperti, accounts/{account_id}/homepage)
ID resource halaman beranda Tidak berlaku (implisit ke resource Account) name: accounts/{account_id}/homepage (mengidentifikasi sub-resource Homepage)

Metode

Metode accounts.claimwebsite dari Content API for Shopping, yang berfokus pada tindakan klaim, kini menjadi bagian dari serangkaian fungsi yang lebih luas dalam resource Homepage Merchant API.

Metode Content API for Shopping Metode Merchant API Ketersediaan &Catatan
accounts.claimwebsite accounts.homepage.claim Langsung memulai atau memverifikasi ulang klaim situs. Bertindak pada uri yang sebelumnya ditetapkan menggunakan homepage.update. Menyertakan parameter overwrite. Menampilkan resource Homepage dengan status uri dan claimed saat ini.
accounts.get (untuk membaca Account.website_url), accountstatuses.get (untuk membaca AccountStatus.website_claimed) accounts.homepage.getHomepage Metode khusus baru untuk mengambil uri halaman beranda saat ini dan status claimed-nya dalam satu panggilan.
accounts.update (untuk menetapkan Account.website_url) accounts.homepage.updateHomepage Metode khusus baru untuk menetapkan atau mengubah uri halaman beranda.
accounts.update (menetapkan Account.website_url ke string kosong sebagai solusi untuk membatalkan klaim) accounts.homepage.unclaim Metode khusus baru untuk membatalkan klaim halaman beranda secara eksplisit.

Perubahan kolom mendetail

Cara informasi halaman beranda disusun dan diakses telah berubah secara signifikan, beralih ke resource Homepage eksplisit di Merchant API.

Content API for Shopping Merchant API Deskripsi
merchantId (parameter jalur untuk accounts.claimwebsite) name (parameter jalur untuk metode Homepage, format: accounts/{account}/homepage) Bagian account dari string name di Merchant API sesuai dengan accountId dari Content API for Shopping.
accountId (parameter jalur untuk accounts.claimwebsite) name (parameter jalur untuk metode Homepage, format: accounts/{account}/homepage) ID untuk akun tertentu yang halaman berandanya sedang dikelola.
overwrite (boolean di isi ContentAccountsClaimwebsiteRequest dan AccountsCustomBatchRequestEntry) ClaimHomepageRequest.overwrite (boolean di isi permintaan homepage.claim) Opsional. Jika true, mencoba mengklaim situs, yang berpotensi menghapus klaim yang ada dari akun lain jika kepemilikan dapat diverifikasi oleh akun yang meminta.
Account.website_url (kolom di resource Account, ditetapkan menggunakan accounts.update, dibaca menggunakan accounts.get) Homepage.uri (kolom di resource Homepage) URI (URL) halaman beranda toko. Di Merchant API, ini adalah kolom eksplisit dalam resource Homepage. Kolom ini ditetapkan menggunakan accounts.homepage.updateHomepage dan ditampilkan oleh semua metode Homepage.
AccountStatus.website_claimed (kolom di resource AccountStatus, dibaca menggunakan accountstatuses.get) Homepage.claimed (kolom boolean output_only di resource Homepage) Menunjukkan apakah uri diklaim dan diverifikasi. Status ini tersedia langsung di resource Homepage yang ditampilkan oleh semua metode Merchant API terkait.
T/A UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage parameter isi permintaan) Mask kolom opsional untuk homepage.update guna menentukan kolom (misalnya, uri) resource Homepage yang sedang diperbarui.
Sebelumnya
Migrate user and access management
Berikutnya
Migrate region management