Listings APIListings API
Masuk
POST/api/v4/connected-accounts/disconnect-listing

Putuskan koneksi profil bisnis dari lokasi

Memutuskan tautan profil bisnis di platform publikasi yang terhubung ke satu lokasi Listings API.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Body

NamaTipeWajibDeskripsi
inputobjectwajibWrapper object. The entire request body must be nested under `input`.
input.locationIdstringwajibBase64-encoded Relay ID of the one location to disconnect.
input.sitestringopsionalPublisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerIdstringopsionalThe 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.

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "site": "GOOGLE"  }}

Respons

200Listing disconnected.
Response
{  "data": {    "disconnectConnectedAccountsLocations": {      "clientMutationId": null,      "success": true,      "errors": null    }  }}
401Unauthenticated, missing or invalid API key.

Menghapus tautan antara lokasi Listings API dan profil bisnis di platform publikasi (Google Business Profile, Facebook Page, atau Apple Business Connect) yang saat ini terhubung dengannya. Setelah koneksi diputuskan, Listings API berhenti mengirim pembaruan ke profil bisnis tersebut. Lokasi itu sendiri tetap ada di akun Anda; hanya tautan profil bisnis yang diputuskan.

Struktur permintaan. Isi permintaan harus dibungkus dalam objek input yang memuat satu locationId, serta salah satu dari site (GOOGLE, FACEBOOK, atau APPLE) atau providerId untuk menentukan koneksi yang akan diputuskan. Endpoint ini tidak mendukung operasi massal: hanya satu lokasi per panggilan, jadi gunakan perulangan jika Anda perlu memutuskan koneksi untuk beberapa lokasi.

Jika Anda tidak mengirimkan site maupun providerId, endpoint mengembalikan SY10056 ("Site is not valid for the location disconnection"). Untuk lokasi yang tidak memiliki koneksi aktif ke situs tersebut, endpoint mengembalikan SY10057 ("Location is not connected for the site"), alih-alih melaporkan keberhasilan tanpa melakukan perubahan, sehingga success: true benar-benar berarti bahwa sebuah tautan telah dihapus.

Kasus penggunaan: alihkan lokasi ke akun lain. Saat pelanggan memindahkan toko dari satu akun Google ke akun lain, putuskan terlebih dahulu koneksi profil bisnis lokasi saat ini di sini menggunakan site: "GOOGLE", lalu gunakan trigger-matches dan connect-listing pada akun terhubung yang baru untuk menautkan lokasi tersebut ke profil bisnis yang benar.

Kasus penggunaan: hentikan pengelolaan tanpa menghapus. Saat pelanggan beralih ke paket yang lebih rendah dan tidak lagi ingin Listings API mengelola kehadiran bisnis mereka di Google/Facebook, tetapi ingin menyimpan catatan lokasi beserta datanya yang dihosting oleh Listings API, putuskan koneksi profil bisnis alih-alih mengarsipkan lokasi. Tindakan ini menghentikan sinkronisasi keluar sekaligus mempertahankan lokasi untuk platform publikasi lain.

Endpoint ini mengubah koneksi aktif dan mengirimkan perubahan tersebut ke platform publikasi. Contoh permintaan dan respons di atas hanya merupakan contoh.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/disconnect-listing' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "site": "GOOGLE"    }  }'
Run in playground