POST/api/v4/connected-accounts/trigger-matches

Konum eşleştirmelerini tetikleme

Bağlı hesapların Google ve Facebook profillerini getirir ve bunları Listings API konumlarınızla eşleştirir.

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.connectedAccountIdsarray of stringszorunluUUIDs of the connected accounts to trigger matches for. Taken from `GET /connected-accounts`.

Örnek istek

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

Request body
{  "input": {    "connectedAccountIds": [      "4f712c17-4f95-42dd-90f4-97171a2e67b5"    ]  }}

Yanıtlar

200Request accepted. `success` is `true` when the fetch-and-match job was queued for every account; accounts that could not be queued are returned in `failedIds` and `success` is `false`.
Response
{  "data": {    "connectedAccountsTriggerMatches": {      "failedIds": null,      "success": true    }  }}
400Bad request, the body was not wrapped in `input` (error message: `Variable "$input" of required type "ConnectedAccountsTriggerMatchesInput!" was not provided`).
401Unauthenticated, missing or invalid API key.

Belirtilen bağlı hesapların erişebildiği tüm Google Business Profile ve Facebook profillerini alan ve bunları Listings API konumlarınızla eşleştiren asenkron işi başlatır. success: true yanıtı, işin kuyruğa alındığı anlamına gelir; eşleştirme işlemi arka planda çalışır.

İstek yapısı. Gövde, eşleştirilecek bağlı hesapların dizisi olan connectedAccountIds öğesini içeren bir input nesnesiyle sarmalanmalıdır. Düz, sarmalanmamış bir gövde gönderildiğinde istek HTTP 400 ile reddedilir. Hesap kimliklerini GET /connected-accounts üzerinden alın. Bir veya daha fazla hesap kuyruğa alınamadığında, bu hesapların kimlikleri failedIds içinde döndürülür ve success değeri false olur.

Kullanım senaryosu: yeni bir hesap bağladıktan sonra önerileri yenileme. Müşteri Google bağlantı akışını tamamladıktan hemen sonra, ilgili hesabın connectedAccountId değeriyle trigger-matches çağrısı yapın. Bu işlem, önerilen konum eşleştirmelerini oluşturur; böylece ilk kurulum arayüzünüz, müşterinin zamanlanmış bir senkronizasyonu beklemesine gerek kalmadan "işletme kayıtlarınızdan N tanesini bulduk" mesajını gösterebilir.

Kullanım senaryosu: konum ekledikten sonra eşleştirmeyi yeniden çalıştırma. Mevcut bir bağlı hesap için toplu olarak yeni Listings API konumları oluşturduğunuzda, yeni konumların mevcut Google/Facebook işletme kayıtlarıyla eşleştirilmesi için yeni bir eşleştirme işlemi tetikleyin.

İşlem asenkron olduğundan, 200 yanıtını "eşleştirme tamamlandı" şeklinde yorumlamayın. Bağlı hesap ayrıntıları uç noktasını düzenli aralıklarla sorgulayın ve requestMatchesStatus değerinin MATCH_COMPLETED olmasını bekleyin; ardından confirm-matches veya connect-listing çağrısı yapmadan önce sonuçları connection-suggestions uç noktasından okuyun.

Bu uç nokta, Google/Facebook üzerinden canlı veri alma işlemini kuyruğa ekler. Yukarıdaki istek yapısı ve örnek yanıt, API belirtimine dayanılarak belgelenmiştir; çağrı, üretim ortamındaki veriler üzerinde çalıştırılmaz.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/trigger-matches' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "connectedAccountIds": [        "4f712c17-4f95-42dd-90f4-97171a2e67b5"      ]    }  }'