Listar sites do plano | Listings API

Respostas

200Array of plan site objects. Country arrays are truncated below for brevity; the live response lists every supported country.

Response

{  "data": {    "planSites": [      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 1,        "name": "Google Maps",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "maps.google.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 184,        "name": "Facebook",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "facebook.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "GB"],        "id": 2,        "name": "Yelp",        "supportedCountries": ["US", "CA", "GB", "DE", "FR"],        "url": "yelp.com"      }    ]  }}

401Unauthenticated, missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

Retorna todos os sites de diretórios de plataformas de publicação incluídos no plano vinculado à conta atual. Cada entrada tem um id inteiro, um name de exibição, a url do site, a lista de códigos ISO dos países que o site aceita (supportedCountries) e os países onde a flag hide-address / service-area é respeitada (hideAddressSupportedCountries).

Caso de uso: criar um seletor de IDs de site válidos. Antes de ativar ou desativar plataformas de publicação em um local, chame este endpoint para saber quais IDs numéricos de site existem no plano. Somente os IDs retornados aqui são válidos para uso em outras partes da API. Mapeie id para name/url para exibir uma tela de configurações de envio legível para o usuário.

Caso de uso: verificar previamente o país de um local. Filtre a resposta para incluir os sites cujo supportedCountries contém o countryIso do local, para que você ofereça apenas plataformas de publicação que realmente aceitarão a listagem. Para empresas com área de atendimento, consulte também hideAddressSupportedCountries para verificar onde o endereço pode ser ocultado.

Pontos de atenção.

Esta é uma lista restrita ao plano e sem paginação: ela retorna o catálogo completo de sites do plano em uma única resposta, portanto não há cursor. Espere dezenas de entradas e armazene o resultado em cache em vez de chamar o endpoint a cada requisição.
supportedCountries e hideAddressSupportedCountries podem conter, cada um, 50 ou mais códigos ISO; o exemplo acima está truncado.
Compartilha o limite de requisições da conta; ao receber 429, respeite o cabeçalho Retry-After.

Parâmetros

Respostas