GET/api/v4/connected-accounts/{connectedAccountId}/folders

Bağlı bir hesabın GMB klasörlerini listeleyin

Bağlı bir Google hesabının erişebildiği Google Business Profile klasörlerini (gruplarını) döndürür.

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

Parametreler

Yol

AdTürZorunluAçıklama
connectedAccountIdstringzorunluUUID of the connected Google account (from the list connected accounts endpoint).

Yanıtlar

200Array of GMB folder objects.
Response
{  "data": {    "getFoldersUnderGoogleAccount": [      {        "folderId": "accounts/104890024806530350198",        "folderName": "Aniruddha Basu",        "locationCount": null      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Google Business Profile içinde bağlı Google hesabının erişebildiği klasörleri (gruplar veya hesap grupları olarak da adlandırılır) döndürür. GBP, bir hesap altındaki işletme kayıtlarını klasörlerle düzenler; her klasör bir folderId, bir folderName ve Google bildirdiğinde bir locationCount içerir.

Kullanım senaryosu: yeni bir işletme kaydını doğru klasöre yerleştirme. create-GMB-listing uç noktasını çağırmadan önce hesabın klasörlerini listeleyin ve müşterinin birini seçmesini sağlayın. Yeni işletme kaydının hesabın kökünde değil, bu klasörün içinde oluşturulması için seçilen folderId değerini (değiştirilmeden kullanılan accounts/{id} dizesini) iletin.

Kullanım senaryosu: müşterinin GBP yapısıyla uyum sağlama. Çok konumlu markalar, işletme kayıtlarını sıklıkla farklı klasörlere dağıtır. Müşterinin gerçek GBP hiyerarşisini kullanıcı arayüzünüzde göstermek ve senkronizasyonu müşterinin beklediği klasöre yaptığınızı doğrulamak için klasör listesini alın. Google klasör için bir sayı döndürmediğinde locationCount değerinin null olabileceğini unutmayın; bu nedenle bu değeri kesin bir bilgi olarak değil, isteğe bağlı bir bilgi olarak değerlendirin. Bu uç nokta, Google türünde bağlı bir hesap gerektirir; yol yalnızca GoogleAccount bağlantıları için geçerlidir.

Request
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/folders' \  -H "Authorization: API $LISTINGSAPI_KEY"