/api/v4/locations/oauth-disconnectBir konumun yayın platformuyla bağlantısını kesin
Konum başına OAuth bağlantı URL'sinin karşılığı olarak tek bir konumun bir yayın platformuyla bağlantısını keser.
Parametreler
Gövde
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| input | object | zorunlu | Wrapper object. The entire request body must be nested under `input`. |
| input.locationId | string | zorunlu | Base64-encoded Relay ID of the one location to disconnect. |
| input.site | string | isteğe bağlı | Publisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`. |
| input.providerId | string | isteğ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.
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" }}Yanıtlar
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`).
Tek bir konumun bir yayın platformuyla bağlantısını kaldırır. Tek bir konum için OAuth bağlantı URL'si oluşturun ile başlatılan konum başına OAuth akışının bağlantı kesme bölümüdür.
Bu yol ve Bir işletme kaydının konumla bağlantısını kesin, iki farklı yol üzerinden sunulan aynı işlemdir: ikisi de aynı input gövdesini alır ve sonucu yolların adlarından herhangi birinin altında değil, disconnectConnectedAccountsLocations altında döndürür. Entegrasyonunuzda hangisi daha anlaşılırsa o yolu seçin; davranış açısından hiçbir fark yoktur.
Gövde, input içine alınmalı ve tek bir locationId ile hangi bağlantının kesileceğini belirtmek için ya site ya da providerId içermelidir. İkisini de göndermediğinizde SY10056 ("Site is not valid for the location disconnection") döndürülür; söz konusu siteyle etkin bağlantısı olmayan bir konum için de sessizce başarılı sonuç döndürmek yerine SY10057 döndürülür, dolayısıyla success: true gerçekten bir bağlantının kaldırıldığı anlamına gelir. Bu, toplu işlem uç noktası değildir; bu nedenle birden fazla konum için döngü kullanın. Bir hesaptaki tüm konumların bağlantısını tek seferde kesmek için bunun yerine Google hesaplarının bağlantısını toplu olarak kesin işlemini kullanın.
Kullanım senaryosu: yanlış hedefe kurulan bir bağlantıyı geri alma
Bir kullanıcı bir mağazaya yanlış yayın platformu işletme kaydını bağladığında, site değerini ilgili yayın platformu olarak ayarlayıp buradan bağlantıyı kesin, ardından doğru işletme kaydını bağlaması için kullanıcıyı yeniden bağlantı URL'sine yönlendirin (veya trigger-matches ve Bir işletme kaydını bağlayın işlemlerini çalıştırın). Bağlantının kesilmesi konumu ve verilerini olduğu gibi korur; yalnızca o yayın platformuna giden senkronizasyon durur.
Kullanım senaryosu: bir müşterinin ayrılması ve Apple Business hesabını beraberinde götürmesi
site: "APPLE" ile konumun, sahibinin Apple Business hesabı üzerinden yayımlanması durdurulur. Konum Apple Maps'te kalır: sonraki güncellemeler ListingsAPI Apple Business Connect hesabı üzerinden yayımlanır ve Apple, gönderimi yayımlamadan önce doğrular. Konumu yeniden sahibinin hesabı üzerinden yayımlamak için kullanıcıya Tek bir konum için OAuth bağlantı URL'si oluşturun işleminden yeni bir bağlantı gönderin.
Bu uç nokta etkin bir bağlantıyı değiştirir. Yukarıdaki örnek istek ve yanıt, örnek olarak verilmiştir.
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" } }'