Search - Post Search Fuzzy Batch

Pesquisar a API do Lote Difuso

Aplica-se a: consulte os tipos de preços.

A API do Lote de Endereço de Pesquisa envia lotes de consultas para a API Difusa de Pesquisa usando apenas uma única chamada à API. Você pode chamar a API do Lote Difuso de Endereço de Pesquisa para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador lote até 10.000 consultas e sincronize a API até 100 consultas.

Enviar solicitação de lote síncrono

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens do lote é limitado a 100 para essa API.

POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de lote assíncrono

A API assíncrona é apropriada para processar grandes volumes de solicitações de pesquisa relativamente complexas

  • Ele permite a recuperação de resultados em uma chamada separada (vários downloads são possíveis).
  • A API assíncrona é otimizada para confiabilidade e não deve ser executada em um tempo limite.
  • O número de itens do lote é limitado a 10.000 para essa API.

Quando você faz uma solicitação usando a solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. As respostas assíncronas são armazenadas por 14 dias. A URL de redirecionamento retorna uma resposta 404 se usada após o período de expiração.

Observe que a solicitação em lote assíncrona é uma solicitação de longa execução. Aqui está uma sequência típica de operações:

  1. O cliente envia uma solicitação do Lote POST de Endereço de Pesquisa para Azure Mapas

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted – A solicitação em lote foi aceita.

    HTTP Error - Houve um erro ao processar sua solicitação do Lote. Isso pode ser um 400 Bad Request ou qualquer outro Error código de status.

  3. Se a solicitação em lote foi aceita com êxito, o Location cabeçalho na resposta contém a URL para baixar os resultados da solicitação do lote. Esse URI de status é semelhante ao seguinte:

    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. O cliente emite uma GET solicitação na URL de download obtida na Etapa 3 para baixar os resultados do lote.

Corpo POST para solicitação em lote

Para enviar as consultas difusas de pesquisa , você usará uma solicitação POST em que o corpo da solicitação conterá a batchItems matriz no json formato e o Content-Type cabeçalho será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 5 consultas difusas de pesquisa :

{
    "batchItems": [
        {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
        {"query": "?query=Statue Of Liberty&limit=2"},
        {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
        {"query": "?query=Space Needle"},
        {"query": "?query=pizza&limit=10"}
    ]
}

Uma consulta difusa de pesquisa em um lote é apenas uma URL parcial sem o protocolo, a URL base, o caminho, api-version e a subscription-key. Ele pode aceitar qualquer um dos parâmetros de URIdifuso de pesquisa com suporte. Os valores de cadeia de caracteres na consulta difusa de pesquisa devem ser corretamente escapados (por exemplo, " caractere deve ser escapado com \ ) e também deve ser codificado corretamente em URL.

A API assíncrona permite que o chamador lote até 10.000 consultas e sincronize a API até 100 consultas, e o lote deve conter pelo menos 1 consulta.

Baixar resultados do lote assíncrono

Para baixar os resultados do lote assíncrono, você emitirá uma solicitação GET para o ponto de extremidade de download em lote. Essa URL de download pode ser obtida do Location cabeçalho de uma solicitação em lote bem-sucedida POST e tem a seguinte aparência:

https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Aqui está a sequência típica de operações para baixar os resultados do lote:

  1. O cliente envia uma solicitação GET usando a URL de download.

  2. O servidor responderá com um dos seguintes:

    HTTP 202 Accepted - A solicitação em lote foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

    HTTP 200 OK – Solicitação em lote processada com êxito. O corpo da resposta contém todos os resultados do lote.

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação em lote assíncrono, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um summary componente que indica que totalRequests fizeram parte da solicitação de lote original e successfulRequests, por exemplo, consultas que foram executadas com êxito. A resposta em lote também inclui uma batchItems matriz que contém uma resposta para cada consulta na solicitação em lote. Ele batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação do lote. Cada item em batchItems contém statusCode e response campos. Cada response um batchItems deles é de um dos seguintes tipos:

  • SearchAddressResponse - Se a consulta for concluída com êxito.

  • Error - Se a consulta falhou. A resposta conterá um code e um message neste caso.

Aqui está um exemplo de Resposta em Lote com 2 resultados bem-sucedidos e 1 com falha :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "atm"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "ATM at Wells Fargo"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "statue of liberty"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "Statue of Liberty"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "New York, NY 10004"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0

Parâmetros de URI

Name In Required Type Description
format
path True

Formato desejado da resposta. Há suporte apenas para o formato json.

api-version
query True
  • string

Número de versão da API de Mapas Azure.

Cabeçalho da solicitação

Name Required Type Description
x-ms-client-id
  • string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Azure AD. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento Azure Mapas. Para usar Azure AD segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Corpo da solicitação

Name Type Description
batchItems

A lista de consultas a serem processadas.

Respostas

Name Type Description
200 OK

OK

202 Accepted

Com suporte apenas para solicitação assíncrona. Solicitação Aceita: a solicitação foi aceita para processamento. Use a URL no Cabeçalho de Localização para tentar novamente ou acessar os resultados.

Headers

  • Location: string
Other Status Codes

Erro inesperado.

Segurança

AADToken

Esses são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelagem de aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.

Observações

  • Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

É Authorization URL específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

  • Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada que é provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação DE SAS de Lista no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

A Search Fuzzy Batch API call containing 5 Search Fuzzy API queries

Sample Request

POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"
    },
    {
      "query": "?query=Statue Of Liberty&limit=2"
    },
    {
      "query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"
    }
  ]
}

Sample Response

{
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "atm",
          "queryType": "NON_NEAR",
          "queryTime": 5,
          "numResults": 5,
          "offset": 0,
          "totalResults": 262,
          "fuzzyLevel": 1,
          "geoBias": {
            "lat": 47.639769,
            "lon": -122.128362
          }
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/3656546",
            "score": 2.671,
            "dist": 1336.1815386162032,
            "info": "search:ta:840539002005905-US",
            "poi": {
              "name": "US Bank ATM-MONEYPASS",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "14808",
              "streetName": "NE 24th St",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63229,
              "lon": -122.14232
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63319,
                "lon": -122.14365
              },
              "btmRightPoint": {
                "lat": 47.63139,
                "lon": -122.14099
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.63154,
                  "lon": -122.1423
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/8673325",
            "score": 2.671,
            "dist": 1206.8488178244172,
            "info": "search:ta:840539002022072-US",
            "poi": {
              "name": "US Bank ATM NATIONAL ASSOCIATION",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15000",
              "streetName": "Northeast 24Th Street",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525522",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63265,
              "lon": -122.14052
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63355,
                "lon": -122.14185
              },
              "btmRightPoint": {
                "lat": 47.63175,
                "lon": -122.13919
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14056
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14058
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14048
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.6324,
                  "lon": -122.13938
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/2736315",
            "score": 2.671,
            "dist": 864.7591776519859,
            "info": "search:ta:840539002187855-US",
            "poi": {
              "name": "US Bank ATM-MONEYPASS",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15521",
              "streetName": "Bel Red Rd",
              "municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
              "municipality": "Redmond, Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525501",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63259,
              "lon": -122.1328
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63349,
                "lon": -122.13413
              },
              "btmRightPoint": {
                "lat": 47.63169,
                "lon": -122.13147
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.63255,
                  "lon": -122.13275
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/3656412",
            "score": 2.67,
            "dist": 2140.198538580941,
            "info": "search:ta:840539001998867-US",
            "poi": {
              "name": "US Bank ATM NATIONAL ASSOCIATION",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1128",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62069,
              "lon": -122.13213
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62159,
                "lon": -122.13346
              },
              "btmRightPoint": {
                "lat": 47.61979,
                "lon": -122.1308
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62069,
                  "lon": -122.13236
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/2736876",
            "score": 2.67,
            "dist": 2140.198538580941,
            "info": "search:ta:840539001396789-US",
            "poi": {
              "name": "US Bank ATM",
              "phone": "+(1)-(800)-8722657",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "url": "www.usbank.com",
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1128",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62069,
              "lon": -122.13213
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62159,
                "lon": -122.13346
              },
              "btmRightPoint": {
                "lat": 47.61979,
                "lon": -122.1308
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62069,
                  "lon": -122.13236
                }
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "statue of liberty",
          "queryType": "NON_NEAR",
          "queryTime": 37,
          "numResults": 2,
          "offset": 0,
          "totalResults": 18,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/9189660",
            "score": 6.942,
            "info": "search:ta:840369001174316-US",
            "poi": {
              "name": "Statue of Liberty",
              "categorySet": [
                {
                  "id": 7376003
                }
              ],
              "classifications": [
                {
                  "code": "IMPORTANT_TOURIST_ATTRACTION",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "monument"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "important tourist attraction"
                    }
                  ]
                }
              ]
            },
            "address": {
              "municipalitySubdivision": "New York",
              "municipality": "New York",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivision": "NY",
              "postalCode": "10004",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "New York, NY 10004",
              "localName": "New York",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.68955,
              "lon": -74.04483
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.69045,
                "lon": -74.04602
              },
              "btmRightPoint": {
                "lat": 40.68865,
                "lon": -74.04364
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.69001,
                  "lon": -74.04683
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/3264566",
            "score": 6.942,
            "info": "search:ta:840019000670588-US",
            "poi": {
              "name": "Statue of Liberty",
              "phone": "+(1)-(205)-9700251",
              "categorySet": [
                {
                  "id": 7376003
                }
              ],
              "url": "www.1bsa.org",
              "classifications": [
                {
                  "code": "IMPORTANT_TOURIST_ATTRACTION",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "important tourist attraction"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "516",
              "streetName": "Liberty Pkwy",
              "municipalitySubdivision": "Vestavia Hills",
              "municipality": "Vestavia Hills, Birmingham",
              "countrySecondarySubdivision": "Jefferson",
              "countryTertiarySubdivision": "Leeds",
              "countrySubdivision": "AL",
              "postalCode": "35242",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
              "localName": "Vestavia Hills",
              "countrySubdivisionName": "Alabama"
            },
            "position": {
              "lat": 33.48234,
              "lon": -86.70719
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 33.48324,
                "lon": -86.70827
              },
              "btmRightPoint": {
                "lat": 33.48144,
                "lon": -86.70611
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 33.48129,
                  "lon": -86.7065
                }
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "starbucks",
          "queryType": "NON_NEAR",
          "queryTime": 35,
          "numResults": 10,
          "offset": 0,
          "totalResults": 17,
          "fuzzyLevel": 1,
          "geoBias": {
            "lat": 47.639769,
            "lon": -122.128362
          }
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/153678",
            "score": 2.671,
            "dist": 1206.8488178244172,
            "info": "search:ta:840531000006554-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8695816",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15000",
              "streetName": "NE 24th St",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525522",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63265,
              "lon": -122.14052
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63355,
                "lon": -122.14185
              },
              "btmRightPoint": {
                "lat": 47.63175,
                "lon": -122.13919
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14056
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14058
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14048
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.6324,
                  "lon": -122.13938
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/152316",
            "score": 2.67,
            "dist": 2315.294397491255,
            "info": "search:ta:840539000484552-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-6436471",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/store/15097",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15600",
              "streetName": "NE 8th St",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98008",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61896,
              "lon": -122.12945
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61986,
                "lon": -122.13078
              },
              "btmRightPoint": {
                "lat": 47.61806,
                "lon": -122.12812
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.619,
                  "lon": -122.12945
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167545",
            "score": 2.67,
            "dist": 1979.2222952267998,
            "info": "search:ta:840539001950429-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-7470690",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1350",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62212,
              "lon": -122.13179
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62302,
                "lon": -122.13312
              },
              "btmRightPoint": {
                "lat": 47.62122,
                "lon": -122.13046
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62213,
                  "lon": -122.13236
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/168519",
            "score": 2.67,
            "dist": 2490.3337046455963,
            "info": "search:ta:840539001015090-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-4556500",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "https://www.starbucks.com/store-locator/store/15901",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1645",
              "streetName": "140th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98005",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62626,
              "lon": -122.15487
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62716,
                "lon": -122.1562
              },
              "btmRightPoint": {
                "lat": 47.62536,
                "lon": -122.15354
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62645,
                  "lon": -122.15446
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.62579,
                  "lon": -122.15377
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/152428",
            "score": 2.668,
            "dist": 3529.7080738812224,
            "info": "search:ta:840539001033722-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-3789496",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "180",
              "streetName": "148th Ave SE",
              "municipalitySubdivision": "West Lake Hills, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.60901,
              "lon": -122.14
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.60991,
                "lon": -122.14133
              },
              "btmRightPoint": {
                "lat": 47.60811,
                "lon": -122.13867
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.60901,
                  "lon": -122.14008
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167147",
            "score": 2.668,
            "dist": 3479.393294615887,
            "info": "search:ta:840539000326896-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8619198",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "7425",
              "streetName": "166th Ave NE",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526288",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67055,
              "lon": -122.12001
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67145,
                "lon": -122.12135
              },
              "btmRightPoint": {
                "lat": 47.66965,
                "lon": -122.11867
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.67069,
                  "lon": -122.11889
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/153695",
            "score": 2.667,
            "dist": 3622.441074618729,
            "info": "search:ta:840531000006551-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8822881",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/store/15022",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "7625",
              "streetName": "170th Ave NE",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980520910",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67086,
              "lon": -122.11392
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67176,
                "lon": -122.11526
              },
              "btmRightPoint": {
                "lat": 47.66996,
                "lon": -122.11258
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.67073,
                  "lon": -122.1135
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167420",
            "score": 2.667,
            "dist": 3818.293513029088,
            "info": "search:ta:840539000640782-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8853323",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "17246",
              "streetName": "Redmond Way",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980524403",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67174,
              "lon": -122.10976
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67264,
                "lon": -122.1111
              },
              "btmRightPoint": {
                "lat": 47.67084,
                "lon": -122.10842
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.6706,
                  "lon": -122.11026
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/153686",
            "score": 2.666,
            "dist": 4009.922205147074,
            "info": "search:ta:840531000006548-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8859590",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15738",
              "streetName": "Redmond Way Pad 3 Redmond Center",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980523873",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67583,
              "lon": -122.12877
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67673,
                "lon": -122.13011
              },
              "btmRightPoint": {
                "lat": 47.67493,
                "lon": -122.12743
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.67456,
                  "lon": -122.12887
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.67668,
                  "lon": -122.12829
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/168511",
            "score": 2.666,
            "dist": 3987.80992387863,
            "info": "search:ta:840531000006669-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8818265",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "6617",
              "streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
              "municipalitySubdivision": "Kirkland, Bridle Trails",
              "municipality": "Kirkland",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98033",
              "extendedPostalCode": "980338234",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
              "localName": "Kirkland",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.66514,
              "lon": -122.16599
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.66604,
                "lon": -122.16733
              },
              "btmRightPoint": {
                "lat": 47.66424,
                "lon": -122.16465
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.666,
                  "lon": -122.16669
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.66553,
                  "lon": -122.16405
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  }
}
Location: URL to download the results of the long-running batch request.

Definições

Address

O endereço do resultado

AddressRanges

Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. As coordenadas para os locais de início e término do intervalo de endereços estão incluídas.

BatchRequest

Esse tipo representa o corpo da solicitação do serviço do Lote.

BatchRequestItem

Objeto de solicitação em lote

BoundingBox

O visor que aborda o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

BoundingBoxCompassNotation

A caixa delimitadora do local.

Brand

A marca associada ao POI

Classification

A classificação para o POI que está sendo retornado

ClassificationName

Nome da classificação

DataSources

Seção opcional. IDs de referência para uso com a API obter polígono de pesquisa.

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição.

EntryPoint

O ponto de entrada para o POI que está sendo retornado.

EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou menor.

ErrorAdditionalInfo

As informações adicionais de erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

GeographicEntityType

Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.

Geometry

Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geografia.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

MatchType

Tipos de correspondência para uma operação de pesquisa de endereço reverso.

OperatingHours

Horário de funcionamento de uma POI (Pontos de Interesse).

OperatingHoursTime

Representa uma data e hora

OperatingHoursTimeRange

Abrir intervalo de tempo por um dia

PointOfInterest

Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.

PointOfInterestCategorySet

Categoria POI

QueryType

O tipo de consulta que está sendo retornada: PRÓXIMO ou NON_NEAR.

Response

O resultado da consulta. SearchAddressResponse se a consulta tiver sido concluída com êxito, caso contrário, ErrorResponse.

SearchAddressBatchItem

Um item retornado da chamada de serviço do Lote de Endereço de Pesquisa.

SearchAddressBatchProcessResult

Esse objeto é retornado de uma chamada de serviço do Lote de Endereço de Pesquisa bem-sucedida.

SearchAddressResultItem

Objeto de resultado para uma resposta da API de Pesquisa.

SearchAddressResultType

Um destes:

  • POI
  • Street
  • painel Geografia do app's selecionado
  • Endereço de ponto
  • Intervalo de Endereços
  • Cruzamento
SearchSummary

Objeto summary para uma resposta da API de Pesquisa.

Summary

Resumo dos resultados da solicitação em lote

Address

O endereço do resultado

Name Type Description
boundingBox

A caixa delimitadora do local.

buildingNumber
  • string

O número do prédio na rua. PRETERIDO, use streetNumber em vez disso.

country
  • string

Nome do país

countryCode
  • string

País (Observação: este é um código de duas letras, não um nome de país.)

countryCodeISO3
  • string

Código de país ISO alfa-3

countrySecondarySubdivision
  • string

Município

countrySubdivision
  • string

Estado ou Província

countrySubdivisionName
  • string

O nome completo de uma hierarquia administrativa de primeiro nível de país. Esse campo aparece somente no caso de countrySubdivision ser apresentado em uma forma abreviada. Só há suporte para EUA, Canadá e Reino Unido.

countryTertiarySubdivision
  • string

Área Nomeada

crossStreet
  • string

O nome da rua que está sendo atravessada.

extendedPostalCode
  • string

Código postal estendido (a disponibilidade depende da região).

freeformAddress
  • string

Uma linha de endereço formatada de acordo com as regras de formatação do país de origem de um resultado ou, no caso de um país, seu nome de país completo.

localName
  • string

Um componente de endereço que representa o nome de uma área geográfica ou localidade que agrupa vários objetos endereçáveis para fins de endereçamento, sem ser uma unidade administrativa. Esse campo é usado para compilar a freeformAddress propriedade.

municipality
  • string

Cidade/Cidade

municipalitySubdivision
  • string

Sub/Super City

postalCode
  • string

Cep/Cep

routeNumbers
  • string[]

Os códigos usados para identificar de forma inequívoca a rua

street
  • string

O nome da rua. PRETERIDO, use streetName em vez disso.

streetName
  • string

O nome da rua.

streetNameAndNumber
  • string

O nome da rua e o número.

streetNumber
  • string

O número do prédio na rua.

AddressRanges

Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. As coordenadas para os locais de início e término do intervalo de endereços estão incluídas.

Name Type Description
from

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

rangeLeft
  • string

Intervalo de endereços no lado esquerdo da rua.

rangeRight
  • string

Intervalo de endereços no lado direito da rua.

to

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

BatchRequest

Esse tipo representa o corpo da solicitação do serviço do Lote.

Name Type Description
batchItems

A lista de consultas a serem processadas.

BatchRequestItem

Objeto de solicitação em lote

Name Type Description
query
  • string

Esse parâmetro contém uma cadeia de caracteres de consulta usada para executar uma operação de geocodificação não estruturada. A cadeia de caracteres de consulta será passada verbatim para a API de pesquisa para processamento.

BoundingBox

O visor que aborda o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

Name Type Description
btmRightPoint

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

topLeftPoint

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

BoundingBoxCompassNotation

A caixa delimitadora do local.

Name Type Description
entity

Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição.

northEast
  • string

Latitude do Nordeste, coordenada longitude da caixa delimitadora como floats separados por vírgulas

southWest
  • string

Latitude sudoeste, coordenada longitude da caixa delimitadora como floats separados por vírgula

Brand

A marca associada ao POI

Name Type Description
name
  • string

Nome da marca

Classification

A classificação para o POI que está sendo retornado

Name Type Description
code
  • string

Propriedade do código

names

Matriz de nomes

ClassificationName

Nome da classificação

Name Type Description
name
  • string

Propriedade Name

nameLocale
  • string

Propriedade Name Locale

DataSources

Seção opcional. IDs de referência para uso com a API obter polígono de pesquisa.

Name Type Description
geometry

Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geografia.

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição.

Name Type Description
position
  • string

Entidade position

EntryPoint

O ponto de entrada para o POI que está sendo retornado.

Name Type Description
position

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

type

O tipo de ponto de entrada. O valor pode ser principal ou menor.

EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou menor.

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

As informações adicionais de erro de gerenciamento de recursos.

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

ErrorResponse

Resposta de erro

Name Type Description
error

O objeto de erro.

GeographicEntityType

Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.

Name Type Description
Country
  • string

Nome do país

CountrySecondarySubdivision
  • string

Município

CountrySubdivision
  • string

Estado ou Província

CountryTertiarySubdivision
  • string

Área Nomeada

Municipality
  • string

Cidade/Cidade

MunicipalitySubdivision
  • string

Sub/Super City

Neighbourhood
  • string

Bairro

PostalCodeArea
  • string

Cep/Cep

Geometry

Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geografia.

Name Type Description
id
  • string

Passe isso como geometryId para a API obter polígono de pesquisa para buscar informações de geometria para esse resultado.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

Name Type Description
json
  • string

O formato de intercâmbio de dados de notação de objeto JavaScript

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

Name Type Description
lat
  • number

Propriedade Latitude

lon
  • number

Propriedade Longitude

MatchType

Tipos de correspondência para uma operação de pesquisa de endereço reverso.

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

Horário de funcionamento de uma POI (Pontos de Interesse).

Name Type Description
mode
  • string

Valor usado na solicitação: nenhum ou "nextSevenDays"

timeRanges

Lista de intervalos de tempo para os próximos 7 dias

OperatingHoursTime

Representa uma data e hora

Name Type Description
date
  • string

Representa a data do calendário atual no fuso horário poi, por exemplo, "2019-02-07".

hour
  • integer

As horas estão no formato de 24 horas na hora local de uma POI; os valores possíveis são 0 a 23.

minute
  • integer

Os minutos estão no horário local de uma POI; os valores possíveis são 0 a 59.

OperatingHoursTimeRange

Abrir intervalo de tempo por um dia

Name Type Description
endTime

O ponto no intervalo de 7 dias seguinte quando uma determinada POI está sendo fechada ou o início do intervalo se ele foi fechado antes do intervalo.

startTime

O ponto no intervalo de 7 dias seguinte quando uma determinada POI está sendo aberta ou o início do intervalo se ele foi aberto antes do intervalo.

PointOfInterest

Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.

Name Type Description
brands

Matriz de marcas. O nome da marca para o POI que está sendo retornado.

categories
  • string[]

Matriz de categorias

categorySet

A lista das categorias de POI mais específicas

classifications

Matriz de classificação

name
  • string

Nome da propriedade POI

openingHours

Horário de funcionamento de uma POI (Pontos de Interesse).

phone
  • string

Propriedade número de telefone

url
  • string

Propriedade URL do site

PointOfInterestCategorySet

Categoria POI

Name Type Description
id
  • integer

ID da categoria

QueryType

O tipo de consulta que está sendo retornada: PRÓXIMO ou NON_NEAR.

Name Type Description
NEARBY
  • string

A pesquisa foi realizada em torno de uma certa latitude e longitude com um raio definido

NON_NEAR
  • string

A pesquisa foi realizada globalmente, sem preconceitos para uma certa latitude e longitude, e nenhum raio definido

Response

O resultado da consulta. SearchAddressResponse se a consulta tiver sido concluída com êxito, caso contrário, ErrorResponse.

Name Type Description
error

O objeto de erro.

results

Uma lista de resultados da API de Pesquisa.

summary

Objeto Summary para uma resposta da API de Pesquisa

SearchAddressBatchItem

Um item retornado da chamada de serviço do Lote de Endereço de Pesquisa.

Name Type Description
response

O resultado da consulta. SearchAddressResponse se a consulta tiver sido concluída com êxito, caso contrário, ErrorResponse.

statusCode
  • integer

Código de status da solicitação HTTP.

SearchAddressBatchProcessResult

Esse objeto é retornado de uma chamada de serviço do Lote de Endereço de Pesquisa bem-sucedida.

Name Type Description
batchItems

Matriz que contém os resultados do lote.

summary

Resumo dos resultados da solicitação em lote

SearchAddressResultItem

Objeto de resultado para uma resposta da API de Pesquisa.

Name Type Description
address

O endereço do resultado

addressRanges

Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Coordenadas para os locais de início e término do intervalo de endereços estão incluídas.

dataSources

Seção opcional. ID de geometria de referência para uso com a API get search polygon .

detourTime
  • integer

Tempo de desvio em segundos. Retornou apenas para chamadas para a API de Pesquisa ao Longo da Rota.

dist
  • number

Distância de linha reta entre o resultado e a localização geográfica em metros.

entityType

Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.

entryPoints

Matriz de EntryPoints. Eles descrevem os tipos de entradas disponíveis no local. O tipo pode ser "principal" para entradas principais, como uma porta da frente ou um lobby, e "menor", para portas laterais e traseiras.

id
  • string

Propriedade ID

info
  • string

Informações sobre a fonte de dados original do Resultado. Usado para solicitações de suporte.

matchType

Informações sobre o tipo de correspondência.

Um destes:

  • AddressPoint
  • HouseNumberRange
  • Street
poi

Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.

position

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

score
  • number

O valor dentro de um conjunto de resultados para indicar a pontuação de correspondência relativa entre os resultados. Você pode usar isso para determinar que o resultado x tem duas vezes mais chances de ser tão relevante quanto o resultado y se o valor de x for 2x o valor de y. Os valores variam entre consultas e só se destinam a um valor relativo para um conjunto de resultados.

type

Um destes:

  • POI
  • Street
  • painel Geografia do app's selecionado
  • Endereço de ponto
  • Intervalo de Endereços
  • Cruzamento
viewport

O visor que aborda o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

SearchAddressResultType

Um destes:

  • POI
  • Street
  • painel Geografia do app's selecionado
  • Endereço de ponto
  • Intervalo de Endereços
  • Cruzamento
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

Objeto summary para uma resposta da API de Pesquisa.

Name Type Description
fuzzyLevel
  • integer

O nível máximo difuso necessário para fornecer resultados.

geoBias

Indicação quando o mecanismo de pesquisa interno tiver aplicado um viés geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isso pode ser afetado definindo os parâmetros lat e lon onde disponíveis. Em outros casos, é puramente interno.

limit
  • integer

Número máximo de respostas que serão retornadas

numResults
  • integer

Número de resultados na resposta.

offset
  • integer

O deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo.

query
  • string

O parâmetro de consulta usado para produzir esses resultados da pesquisa.

queryTime
  • integer

Tempo gasto para resolver a consulta, em milissegundos.

queryType

O tipo de consulta que está sendo retornada: PRÓXIMO ou NON_NEAR.

totalResults
  • integer

O número total de resultados encontrados.

Summary

Resumo dos resultados da solicitação em lote

Name Type Description
successfulRequests
  • integer

Número de solicitações bem-sucedidas no lote

totalRequests
  • integer

Número total de solicitações no lote