GET
/api/v4/connected-accounts/{connectedAccountId}/folders接続済みアカウントのGMBフォルダーを一覧表示
接続済みのGoogleアカウントがアクセスできるGoogle Business Profileのフォルダー(グループ)を返します。
パラメーター
パス
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| connectedAccountId | string | 必須 | UUID of the connected Google account (from the list connected accounts endpoint). |
レスポンス
200Array of GMB folder objects.
{ "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アカウントがアクセスできるGoogle Business Profileのフォルダー(グループまたはアカウントグループとも呼ばれます)を返します。GBPでは、フォルダーを使ってアカウント内のビジネスの掲載情報を整理します。各フォルダーにはfolderIdとfolderNameが含まれ、Googleから報告される場合はlocationCountも含まれます。
ユースケース:新しい掲載情報を適切なフォルダーに配置する。 create-GMB-listingエンドポイントを呼び出す前に、アカウントのフォルダーを一覧表示し、顧客に1つ選択してもらいます。選択したfolderId(accounts/{id}文字列をそのまま使用します)を渡すことで、新しい掲載情報がアカウントのルートではなく、そのフォルダー内に作成されます。
ユースケース:顧客のGBP構造と照合する。 複数の拠点を持つブランドでは、掲載情報を複数のフォルダーに分けて管理することがよくあります。フォルダー一覧を取得して、顧客の実際のGBP階層をUIに表示し、顧客が意図したフォルダーに同期していることを確認します。Googleがフォルダーの件数を返さない場合、locationCountはnullになることがあるため、常に値が入るとは限らない参考値として扱ってください。このエンドポイントにはGoogleタイプの接続済みアカウントが必要であり、このパスはGoogleAccount接続でのみ有効です。
Request
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/folders' \ -H "Authorization: API $LISTINGSAPI_KEY"