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

Listar pastas do GMB para uma conta conectada

Retorna as pastas (grupos) do Google Business Profile acessíveis a uma conta do Google conectada.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Caminho

NomeTipoObrigatórioDescrição
connectedAccountIdstringobrigatórioUUID of the connected Google account (from the list connected accounts endpoint).

Respostas

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.

Retorna as pastas (também chamadas de grupos ou grupos de contas) no Google Business Profile que a conta do Google conectada pode acessar. As pastas são a forma como o GBP organiza as listagens de empresas em uma conta; cada uma contém um folderId, um folderName e, quando informado pelo Google, um locationCount.

Caso de uso: colocar uma nova listagem na pasta correta. Antes de chamar o endpoint create-GMB-listing, liste as pastas da conta e deixe o cliente escolher uma. Passe o folderId escolhido (a string accounts/{id}, usada sem alterações) para que a nova listagem seja criada dentro dessa pasta, em vez de na raiz da conta.

Caso de uso: conciliar com a estrutura do GBP de um cliente. Marcas com vários locais frequentemente distribuem as listagens entre pastas. Obtenha a lista de pastas para exibir a hierarquia real do GBP do cliente na sua interface e confirmar que você está sincronizando com a pasta que ele espera. Observe que locationCount pode ser null quando o Google não retorna uma contagem para a pasta, portanto, trate esse campo como opcional, em vez de considerá-lo uma fonte definitiva. Este endpoint exige uma conta conectada do tipo Google; o caminho só é válido para conexões GoogleAccount.

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