/api/v4/locations/oauth-disconnectPutuskan koneksi satu lokasi ke platform publikasi
Memutus koneksi satu lokasi ke platform publikasi, sebagai pasangan dari URL koneksi OAuth per lokasi.
Parameter
Body
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| input | object | wajib | Wrapper object. The entire request body must be nested under `input`. |
| input.locationId | string | wajib | Base64-encoded Relay ID of the one location to disconnect. |
| input.site | string | opsional | Publisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`. |
| input.providerId | string | opsional | The publisher's own account identifier, as an alternative to `site`. Required unless you send `site`. |
Contoh permintaan
Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" }}Respons
200Connection removed. Response key `disconnectConnectedAccountsLocations`.
{ "data": { "disconnectConnectedAccountsLocations": { "clientMutationId": null, "success": true, "errors": null } }}401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to disconnect this location (`SY90003`).
Menghapus koneksi satu lokasi ke platform publikasi. Ini adalah bagian pemutusan koneksi dari alur OAuth per lokasi yang dimulai melalui Buat URL koneksi OAuth untuk satu lokasi.
Rute ini dan Putuskan koneksi profil bisnis dari lokasi merupakan operasi yang sama melalui dua jalur: keduanya menerima body input yang identik dan mengembalikan hasil di bawah disconnectConnectedAccountsLocations, bukan di bawah nama salah satu jalur tersebut. Pilih jalur yang lebih mudah dipahami dalam integrasi Anda; tidak ada perbedaan perilaku.
Body harus dibungkus dalam input dan memuat satu locationId, serta salah satu dari site atau providerId untuk menentukan koneksi yang akan diputus. Jika keduanya tidak dikirim, endpoint mengembalikan SY10056 ("Site is not valid for the location disconnection"); untuk lokasi yang tidak memiliki koneksi aktif ke situs tersebut, endpoint mengembalikan SY10057 alih-alih melaporkan keberhasilan tanpa melakukan perubahan, sehingga success: true benar-benar berarti bahwa sebuah koneksi telah dihapus. Ini bukan endpoint massal, jadi gunakan perulangan untuk beberapa lokasi. Untuk memutus koneksi semua lokasi dalam satu akun sekaligus, gunakan Putuskan koneksi akun Google secara massal.
Kasus penggunaan: membatalkan koneksi yang salah sasaran
Saat pengguna menghubungkan profil bisnis yang salah di platform publikasi ke sebuah toko, putuskan koneksinya di sini dengan menetapkan site ke platform publikasi tersebut, lalu arahkan pengguna kembali melalui URL koneksi (atau jalankan trigger-matches dan Hubungkan profil bisnis) untuk menghubungkan profil bisnis yang benar. Pemutusan koneksi mempertahankan lokasi beserta datanya secara utuh; hanya sinkronisasi keluar ke platform publikasi tersebut yang berhenti.
Kasus penggunaan: klien berhenti menggunakan layanan dan membawa akun Apple Business miliknya
Dengan site: "APPLE", lokasi tidak lagi dipublikasikan melalui akun Apple Business pemilik. Lokasi tetap ada di Apple Maps: pembaruan selanjutnya dipublikasikan melalui akun Apple Business Connect ListingsAPI, dan Apple memverifikasi pengajuan tersebut sebelum memublikasikannya. Untuk memublikasikan melalui akun pemilik lagi, kirimkan tautan baru kepada pemilik dari Buat URL koneksi OAuth untuk satu lokasi.
Endpoint ini mengubah koneksi aktif. Permintaan dan respons contoh di atas merupakan contoh.
curl -X POST 'https://listingsapi.com/api/v4/locations/oauth-disconnect' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" } }'