POST/api/v4/connected-accounts/disconnect-listing

Bir işletme kaydının konumla bağlantısını kesme

Bağlı yayın platformu işletme kaydının tek bir Listings API konumuyla bağlantısını keser.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Gövde

AdTürZorunluAçıklama
inputobjectzorunluWrapper object. The entire request body must be nested under `input`.
input.locationIdstringzorunluBase64-encoded Relay ID of the one location to disconnect.
input.sitestringisteğe bağlıPublisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerIdstringisteğe bağlıThe publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

Örnek istek

Yapıştırmaya hazır gövde. Yer tutucu kimlikleri ve değerleri kendi değerlerinizle değiştirin.

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

Yanıtlar

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

Bir Listings API konumu ile şu anda bağlı olduğu yayın platformu işletme kaydı (Google Business Profile, Facebook Page veya Apple Business Connect) arasındaki bağlantıyı kaldırır. Bağlantı kesildikten sonra Listings API, bu işletme kaydına güncelleme göndermeyi durdurur. Konumun kendisi hesabınızda kalır; yalnızca işletme kaydı bağlantısı kesilir.

İstek yapısı. Gövde, tek bir locationId ile birlikte hangi bağlantının kesileceğini belirtmek için ya site (GOOGLE, FACEBOOK veya APPLE) ya da providerId içeren bir input nesnesi içine alınmalıdır. Bu bir toplu işlem endpoint'i değildir: her çağrıda tek bir konum işlenir; bu nedenle birden fazla konum için döngü kullanın.

Ne site ne de providerId gönderildiğinde SY10056 ("Site, konum bağlantısının kesilmesi için geçerli değil") döndürülür. Söz konusu site için etkin bağlantısı olmayan bir konumda, işlem sessizce başarılı sayılmak yerine SY10057 ("Konumun siteyle bağlantısı yok") döndürülür; dolayısıyla success: true, gerçekten bir bağlantının kaldırıldığı anlamına gelir.

Kullanım senaryosu: bir konumu farklı bir hesaba yönlendirme. Bir müşteri mağazasını bir Google hesabından diğerine taşıdığında, önce burada site: "GOOGLE" ile konumun mevcut işletme kaydıyla bağlantısını kesin, ardından konumu doğru işletme kaydına bağlamak için yeni bağlı hesapta trigger-matches ve connect-listing kullanın.

Kullanım senaryosu: silmeden hizmetten çıkarma. Bir müşteri daha düşük bir plana geçtiğinde ve artık Listings API'nin Google/Facebook varlığını yönetmesini istemediğinde ancak konum kaydını ve bu kaydın Listings API'de barındırılan verilerini korumak istediğinde, konumu arşivlemek yerine işletme kaydının bağlantısını kesin. Bu işlem, konumu diğer yayın platformları için korurken dışarıya yönelik senkronizasyonu durdurur.

Bu endpoint, canlı bir bağlantıyı değiştirir ve değişikliği yayın platformuna gönderir. Yukarıdaki örnek istek ve yanıt, örnek olarak verilmiştir.

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"    }  }'