Compartilhar via

Search - Post Search Inside Geometry

Serviço:
Maps
Versão da API:
1.0

Use para executar pesquisas de formulário livre dentro de mais uma geometria.

A Post Search Inside Geometry API é uma solicitação HTTP POST que permite realizar uma pesquisa de forma livre dentro de uma única geometria ou várias geometrias. Os resultados da pesquisa que se enquadram na geometria/geometrias serão retornados.

Para enviar a geometria, você usará uma solicitação POST em que o corpo da solicitação conterá o geometry objeto representado como GeoJSON e o cabeçalho Content-Type será definido como application/json. As feições geográficas a serem pesquisadas podem ser modeladas como geometrias de polígono e/ou círculo representadas usando qualquer um dos seguintes tipos GeoJSON:

  • Coleção de Recursos GeoJSON
    O geometry pode ser representado como um objeto GeoJSON FeatureCollection . Esta é a opção recomendada se a geometria contiver Polígonos e Círculos. O FeatureCollection pode conter até 50 objetos GeoJSON Feature . Cada Feature objeto deve representar um polígono ou um círculo com as seguintes condições:
    • Um Feature objeto para a geometria do polígono pode ter até 50 coordenadas e suas propriedades devem estar vazias.
    • Um Feature objeto para a geometria Circle é composto por um centro representado usando um tipo GeoJSON Point e um valor de raio (em metros) que deve ser especificado nas propriedades do objeto junto com a propriedade subType cujo valor deve ser 'Circle'.

    Consulte os Exemplos para obter uma representação de amostra FeatureCollection .

  • GeoJSON GeometryCollection
    O geometry pode ser representado como um objeto GeoJSON GeometryCollection . Esta é a opção recomendada se a geometria contiver apenas uma lista de polígonos. O GeometryCollection pode conter até 50 objetos GeoJSON Polygon . Cada Polygon objeto pode ter até 50 coordenadas. Consulte os Exemplos para obter uma representação de amostra GeometryCollection .

  • Polígono GeoJSON
    O geometry pode ser representado como um objeto GeoJSON Polygon . Esta é a opção recomendada se a geometria contiver um único polígono. O Polygon objeto pode ter até 50 coordenadas. Consulte os Exemplos para obter uma representação de amostra Polygon .

.

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
Com parâmetros opcionais: 
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays

Parâmetros de URI

Nome Em Obrigatório Tipo Description
format
 path True

ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.
api-version
 query True

string

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

string

O nome da POI a ser procurado (por exemplo, "estátua da liberdade", "starbucks", "pizza"). Deve ser codificado corretamente na URL.
categorySet
 query

integer[]

Uma lista separada por vírgulas de IDs de conjunto de categorias que pode ser usada para restringir o resultado a categorias específicas de Pontos de Interesse. A ordem de ID não importa. O número máximo de valores de categorySet com suporte por solicitação é 10. Quando vários identificadores de categoria forem fornecidos, somente as POIs que pertencem (pelo menos) a uma das categorias da lista fornecida serão retornadas. A lista de categorias com suporte pode ser descoberta usando categorias poi API. Exemplos de uso:

  • categorySet=7315 (Pontos de Pesquisa de Interesse da categoria Restaurante)

  • categorySet=7315025,7315017 (Search Points of Interest of category, italian or French Restaurant)
extendedPostalCodesFor
 query

SearchIndexes[]

Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de ponto

de POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (em qualquer ordem) ou Nenhum para nenhum índice.

Por padrão, códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de códigos postais estendidas para geografias podem ser bastante longas, portanto, elas precisam ser solicitadas explicitamente quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD, Addr, POI

extendedPostalCodesFor=None

O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.
idxSet
 query

SearchIndexes[]

Uma lista separada por vírgulas de índices que devem ser utilizados para a pesquisa. A ordem do item não importa. Os índices disponíveis são: Addr = Interpolação de intervalo de endereços, Geo = Geografias, PAD = Endereços de Ponto, POI = Pontos de interesse, Str = Ruas, Xstr = Cross Streets (interseções)
language
 query

string

Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado.

Consulte de idiomas com suporte para obter detalhes.
limit
 query

integer

minimum: 1
maximum: 100

Número máximo de respostas que serão retornadas. Padrão: 10, mínimo: 1 e máximo: 100
openingHours
 query

OperatingHoursRange

Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays
view
 query

LocalizedMapView

O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

Indica a conta destinada ao uso com o modelo de segurança de ID do Microsoft Entra. Essa ID exclusiva para a conta do Azure Mapas pode ser obtida na API da conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas.

Corpo da solicitação

Nome Tipo Description
geometry GeoJsonObject:

Um objeto de GeoJSON válido. Consulte RFC 7946 para obter detalhes.

Respostas

Nome Tipo Description
200 OK

SearchAddressResult

OKEY
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 APIs REST do Azure Mapas.

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

Observação

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra.
  • O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
  • O uso do SDK da Web do do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
  • Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do 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 o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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ão(s) 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 de recursos da conta de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Solicitação de exemplo

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.43576049804686,
              37.7524152343544
            ],
            [
              -122.43301391601562,
              37.70660472542312
            ],
            [
              -122.36434936523438,
              37.712059855877314
            ],
            [
              -122.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      },
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -123.43576049804686,
              37.7524152343544
            ],
            [
              -123.43301391601562,
              37.70660472542312
            ],
            [
              -123.36434936523438,
              37.712059855877314
            ],
            [
              -123.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      }
    ]
  }
}

Resposta de exemplo

Código de status:
200 
{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 21,
    "numResults": 2,
    "offset": 0,
    "totalResults": 4,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "9P2i9inRyndAA-_V40J8oA",
      "score": 2.0041828156,
      "info": "search:ta:840061003419653-US",
      "poi": {
        "name": "Burger Joint",
        "phone": "+1 415-349-4331",
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "categories": [
          "fast food",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "hkr-N07YS6Gv2dOciQ9lwA",
      "score": 2.0041515827,
      "info": "search:ta:840067000526682-US",
      "poi": {
        "name": "Sound of Burgers",
        "categorySet": [
          {
            "id": 7315
          }
        ],
        "categories": [
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    }
  ]
}

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Solicitação de exemplo

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.143035,
                47.653536
              ],
              [
                -122.187164,
                47.617556
              ],
              [
                -122.114981,
                47.570599
              ],
              [
                -122.132756,
                47.654009
              ],
              [
                -122.143035,
                47.653536
              ]
            ]
          ]
        },
        "properties": {}
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.126986,
            47.639754
          ]
        },
        "properties": {
          "subType": "Circle",
          "radius": 100
        }
      }
    ]
  }
}

Resposta de exemplo

Código de status:
200 
{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 34,
    "numResults": 2,
    "offset": 0,
    "totalResults": 21,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "-UuwTye4GGsea4KmCLvoqQ",
      "score": 2.1455535889,
      "info": "search:ta:840537000108972-US",
      "poi": {
        "name": "Biryani & Pizza House",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "15025",
        "streetName": "Northeast 24th Street",
        "municipality": "Redmond",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "98052-5531",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
        "localName": "Redmond"
      },
      "position": {
        "lat": 47.630786,
        "lon": -122.139302
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63169,
          "lon": -122.14064
        },
        "btmRightPoint": {
          "lat": 47.62989,
          "lon": -122.13797
        }
      },
      "entryPoints": [
        {
          "type": "minor",
          "position": {
            "lat": 47.63079,
            "lon": -122.13931
          }
        },
        {
          "type": "main",
          "position": {
            "lat": 47.63147,
            "lon": -122.13935
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "7r095LCcCSkdoGoeLcnvsQ",
      "score": 2.1454992294,
      "info": "search:ta:840537000103468-US",
      "poi": {
        "name": "Pagliacci Pizza",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "www.pagliacci.com/",
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-20",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-20",
                "hour": 11,
                "minute": 0
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "15238",
        "streetName": "Bel Red Road",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "extendedPostalCode": "98007-3815",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
        "localName": "Bellevue"
      },
      "position": {
        "lat": 47.628008,
        "lon": -122.13646
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.62891,
          "lon": -122.13779
        },
        "btmRightPoint": {
          "lat": 47.62711,
          "lon": -122.13513
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6283,
            "lon": -122.13611
          }
        }
      ]
    }
  ]
}

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Solicitação de exemplo

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.43576049804686,
          37.7524152343544
        ],
        [
          -122.43301391601562,
          37.70660472542312
        ],
        [
          -122.36434936523438,
          37.712059855877314
        ],
        [
          -122.43576049804686,
          37.7524152343544
        ]
      ]
    ]
  }
}

Resposta de exemplo

Código de status:
200 
{
  "summary": {
    "query": "subs",
    "queryType": "NON_NEAR",
    "queryTime": 42,
    "numResults": 2,
    "offset": 0,
    "totalResults": 5,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "HOIWGiNwVv0z6bF8MO3EbA",
      "score": 2.1455111504,
      "info": "search:ta:840069009512242-US",
      "poi": {
        "name": "Adams Grub Truck",
        "phone": "+1 415-307-8844",
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1465",
        "streetName": "Carroll Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Bayview",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94124",
        "extendedPostalCode": "94124-3604",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.72328,
        "lon": -122.39091
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.72418,
          "lon": -122.39205
        },
        "btmRightPoint": {
          "lat": 37.72238,
          "lon": -122.38977
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72348,
            "lon": -122.39073
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "bXbc0QxTRlkSo8GnU7EU-Q",
      "score": 2.1454677582,
      "info": "search:ta:840061001992959-US",
      "poi": {
        "name": "SUBWAY San Francisco San Francisco",
        "phone": "+1 415-657-9898",
        "brands": [
          {
            "name": "SUBWAY"
          }
        ],
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-13",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-13",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-15",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-15",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-16",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-16",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 8,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 20,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 21,
                "minute": 30
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "2599",
        "streetName": "San Bruno Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Portola",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-1504",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.729004,
        "lon": -122.403956
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.7299,
          "lon": -122.40509
        },
        "btmRightPoint": {
          "lat": 37.7281,
          "lon": -122.40282
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72892,
            "lon": -122.40414
          }
        }
      ]
    }
  ]
}

Definições

Nome 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.
BoundingBox

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

A caixa delimitadora do local.
Brand

A marca associada à POI
Classification

A classificação para a POI que está sendo retornada
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 a POI que está sendo retornada.
EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou secundária.
ErrorAdditionalInfo

As informações adicionais do 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.
GeoJsonFeature

Um tipo de objeto GeoJSON Feature válido. Consulte RFC 7946 para obter detalhes.
GeoJsonFeatureCollection

Um tipo de objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometry

Um objeto de geometria GeoJSON válido. O tipo deve ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollection

Um tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obter detalhes.
GeoJsonLineString

Um tipo de geometria de GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString

Um tipo de geometria de GeoJSON MultiLineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint

Um tipo de geometria de GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygon

Um tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPoint

Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon

Um tipo de geometria de GeoJSON Polygon válido. Consulte RFC 7946 para obter detalhes.
Geometry

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

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

O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.
MatchType

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

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

Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays
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: NEARBY ou NON_NEAR.

Importante: Esta propriedade está obsoleta e pode ser omitida na resposta.
ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.
SearchAddressResult

Esse objeto é retornado de chamadas de pesquisa bem-sucedidas.
SearchAddressResultItem

Objeto de resultado para uma resposta da API de Pesquisa.
SearchAddressResultType

Um destes:

  • POI
  • Rua
  • Geografia
  • Endereço de ponto
  • Intervalo de endereços
  • Cruzamento
SearchIndexes

Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de ponto

de POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (em qualquer ordem) ou Nenhum para nenhum índice.

Por padrão, códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de códigos postais estendidas para geografias podem ser bastante longas, portanto, elas precisam ser solicitadas explicitamente quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD, Addr, POI

extendedPostalCodesFor=None

O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.
SearchInsideGeometryRequest

Esse tipo representa o corpo da solicitação para o serviço Pesquisar Dentro da Geometria.
SearchSummary

Objeto resumo de uma resposta da API de Pesquisa.

Address

Objeto

O endereço do resultado.

Nome Tipo Description
boundingBox

BoundingBoxCompassNotation

Define a caixa delimitadora do local. Essa propriedade só é retornada pelas APIs reversas de endereço de pesquisa. Todas as outras APIs de Pesquisa retornam a viewport propriedade do SearchAddressResultItem objeto.
buildingNumber

string

O número do prédio na rua.

Importante: Essa propriedade foi descontinuada. Use streetNumber em seu lugar.
country

string

O nome do país/região.
countryCode

string

Um código alfabético de duas letras definido pela norma ISO 3166-1 Alpha-2 para representar um país/região e territórios dependentes.
countryCodeISO3

string

Um código alfabético de três letras definido pela norma ISO 3166-1 Alpha-3 para representar um país/região e territórios dependentes.
countrySecondarySubdivision

string

A divisão administrativa de segundo nível dentro de um país/região. Identifica uma subdivisão que está abaixo da subdivisão principal, como estado ou província, mas acima de unidades menores, como municípios ou bairros. Exemplos incluem County nos Estados Unidos e District no Reino Unido.
countrySubdivision

string

A principal divisão administrativa dentro de um país, como um estado, província. Ele é usado para representar a subdivisão de primeiro nível abaixo do nível nacional.
countrySubdivisionCode

string

countrySubdivisionCode prefixado por countryCode ( countryCode-countrySubdivisionCode ) e o hífen forma o código ISO 3166-2. Exemplos: TX para Texas, SCT para Escócia e ON para Ontário.

Essa propriedade não está disponível na Get Search Nearby API e Get Search POI .
countrySubdivisionName

string

Representa o nome completo da divisão administrativa de primeiro nível (como estado, província ou região) dentro de um país ou região. Essa propriedade é incluída apenas quando o countrySubdivision valor é fornecido em forma abreviada. Atualmente apoiado pelos Estados Unidos, Canadá e Reino Unido.
countryTertiarySubdivision

string

A divisão administrativa de terceiro nível dentro de um país/região. Ele oferece uma granularidade ainda mais fina do que a subdivisão secundária (como condado ou distrito). Exemplos incluem municípios como cidade, vila, vila, vila ou município e bairros de uma área geográfica menor e informal dentro de um município, como Capitol Hill, Green Lake e Wallingford em Seattle.
crossStreet

string

O nome da rua que está sendo atravessada.

Essa propriedade está disponível apenas na Get Search Address Reverse Cross Street API.
extendedPostalCode

string

Um código postal estendido refere-se a um formato de código postal que vai além do conjunto padrão de dígitos para fornecer maior precisão de localização. É comumente usado em sistemas como o código U.S. ZIP+4 ou formatos estendidos similares em outros países/regiões. A disponibilidade depende da região.

Não disponível na Get Search Address Reverse Cross Street API.
freeformAddress

string

Uma linha de endereço formatada de acordo com as regras de formatação do país/região de origem do resultado, ou, no caso de um país/região, seu nome completo do país/região.
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 criar a propriedade freeformAddress. localName representa o município postal. Dependendo do local, localName é o nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido de uma cidade ou cidade, use localName em vez de municipality.
municipality

string

Cidade/Cidade
Observação: municipality representa o município residencial. Dependendo do local, o valor de municipality pode ser diferente do nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido da cidade ou vila, sugere-se que o localName valor seja usado em vez do municipality valor.
municipalitySubdivision

string

Uma subdivisão dentro de um município. Representa uma unidade administrativa ou geográfica menor dentro de uma cidade, vila ou outra entidade municipal.
neighbourhood

string

Um Bairro é uma área geograficamente localizada dentro de uma cidade ou cidade com características distintas e interações sociais entre os habitantes.
postalCode

string

Uma série de números ou letras (ou ambos) adicionados a um endereço para ajudar a identificar uma área geográfica específica. Um CEP é a versão dos EUA de um CEP; outros países/regiões usam outros formatos como CEP, PIN e PLZ.
routeNumbers

string[]

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

Disponível apenas para as APIs de Reversão de Endereço de Pesquisa.
street

string

O nome da rua.

Importante: Essa propriedade foi descontinuada. Use streetName em seu lugar.
streetName

string

O nome da rua.
streetNameAndNumber

string

O nome e o número da rua.

Disponível apenas para as APIs de Reversão de Endereço de Pesquisa.
streetNumber

string

O número do prédio na rua.

Não disponível na Get Search Address Reverse Cross Street API.

AddressRanges

Objeto

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.

Nome Tipo Description
from

LatLongPairAbbreviated

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

LatLongPairAbbreviated

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

BoundingBox

Objeto

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

Nome Tipo Description
btmRightPoint

LatLongPairAbbreviated

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

LatLongPairAbbreviated

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

BoundingBoxCompassNotation

Objeto

A caixa delimitadora do local.

Nome Tipo Description
entity

Entity

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

string

Latitude 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írgulas

Brand

Objeto

A marca associada à POI

Nome Tipo Description
name

string

Nome da marca

Classification

Objeto

A classificação para a POI que está sendo retornada

Nome Tipo Description
code

string

Propriedade Code
names

ClassificationName[]

Matriz de nomes

ClassificationName

Objeto

Nome da classificação

Nome Tipo Description
name

string

Propriedade Name
nameLocale

string

Propriedade Name Locale

DataSources

Objeto

Seção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa.

Nome Tipo Description
geometry

Geometry

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

Entity

Enumeração

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

Valor Description
position

Entidade de posição

EntryPoint

Objeto

O ponto de entrada para a POI que está sendo retornada.

Nome Tipo Description
position

LatLongPairAbbreviated

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

EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou secundária.

EntryPointType

Enumeração

O tipo de ponto de entrada. O valor pode ser principal ou secundária.

Valor Description
main
minor

ErrorAdditionalInfo

Objeto

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

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

GeographicEntityType

Enumeração

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

Valor Description
Country

nome do país/região
CountrySubdivision

Estado ou Província
CountrySecondarySubdivision

Município
CountryTertiarySubdivision

Área Nomeada
Municipality

Cidade/Cidade
MunicipalitySubdivision

Sub/Super City
Neighbourhood

Vizinhança
PostalCodeArea

Cep/Cep

GeoJsonFeature

Objeto

Um tipo de objeto GeoJSON Feature válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
featureType

string

O tipo do recurso. O valor depende do modelo de dados do qual o recurso atual faz parte. Alguns modelos de dados podem ter um valor vazio.
geometry GeoJsonGeometry:

Um objeto de geometria GeoJSON válido. O tipo deve ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
id

string

Identificador do recurso.
type string:

Feature

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonFeatureCollection

Objeto

Um tipo de objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
features

GeoJsonFeature[]

Contém uma lista de objetos GeoJSON Feature válidos.
type string:

FeatureCollection

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometry

Objeto

Um objeto de geometria GeoJSON válido. O tipo deve ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
type

GeoJsonObjectType

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Objeto

Um tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
geometries GeoJsonGeometry[]:

Contém uma lista de objetos de geometria GeoJSON válidos. Observação que as coordenadas em GeoJSON estão em ordem x, y (longitude, latitude).
type string:

GeometryCollection

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Objeto

Um tipo de geometria de GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[] (double)

Coordenadas para a geometria GeoJson LineString.
type string:

LineString

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Objeto

Um tipo de geometria de GeoJSON MultiLineString válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[] (double)

Coordenadas para a geometria GeoJson MultiLineString.
type string:

MultiLineString

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Objeto

Um tipo de geometria de GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[] (double)

Coordenadas para a geometria GeoJson MultiPoint.
type string:

MultiPoint

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Objeto

Um tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[] (double)

Contém uma lista de objetos GeoJSON Polygon válidos. Observação que as coordenadas em GeoJSON estão em ordem x, y (longitude, latitude).
type string:

MultiPolygon

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Objeto

Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são de longitude e de latitude, precisamente nessa ordem. altitude/elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Objeto

Um tipo de geometria de GeoJSON Polygon válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[] (double)

Coordenadas para o tipo de geometria GeoJson Polygon.
type string:

Polygon

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Geometry

Objeto

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

Nome Tipo Description
id

string

Passe isso como geometryId para a API Obter Polígono de Pesquisa para buscar informações de geometria para esse resultado.

LatLongPairAbbreviated

Objeto

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

Nome Tipo Description
lat

number (double)

Propriedade Latitude
lon

number (double)

Propriedade Longitude

LocalizedMapView

Enumeração

O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.

Valor Description
AE

Emirados Árabes Unidos (Exibição árabe)
AR

Argentina (Exibição argentina)
BH

Bahrein (exibição árabe)
IN

Índia (Modo de Exibição Indiano)
IQ

Iraque (exibição árabe)
JO

Jordânia (exibição árabe)
KW

Kuwait (exibição árabe)
LB

Líbano (exibição árabe)
MA

Marrocos (Vista Marroquina)
OM

Omã (exibição árabe)
PK

Paquistão (Exibição paquistanesa)
PS

Autoridade Palestina (Exibição Árabe)
QA

Catar (exibição árabe)
SA

Arábia Saudita (exibição árabe)
SY

Síria (Exibição árabe)
US

Estados Unidos da América
YE

Iêmen (exibição árabe)
Auto

Retorne os dados do mapa com base no endereço IP da solicitação.
Unified

Exibição unificada (outros)

MatchType

Enumeração

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

Valor Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Objeto

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

Nome Tipo Description
mode

string

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

OperatingHoursTimeRange[]

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

OperatingHoursRange

Enumeração

Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays

Valor Description
nextSevenDays

Mostra as horas de operação para a próxima semana, começando com o dia atual no horário local da POI.

OperatingHoursTime

Objeto

Representa uma data e hora

Nome Tipo Description
date

string

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

integer

As horas estão no formato de 24 horas no horário 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

Objeto

Abrir intervalo de tempo por um dia

Nome Tipo Description
endTime

OperatingHoursTime

O ponto nos próximos 7 dias intervalo quando uma determinada POI está sendo fechada ou o início do intervalo se ele foi fechado antes do intervalo.
startTime

OperatingHoursTime

O ponto nos próximos 7 dias intervalo quando uma determinada POI está sendo aberta ou o início do intervalo se ele foi aberto antes do intervalo.

PointOfInterest

Objeto

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

Nome Tipo Description
brands

Brand[]

Matriz de marcas. O nome da marca para a POI que está sendo retornada.
categories

string[]

Matriz de categorias
categorySet

PointOfInterestCategorySet[]

A lista das categorias de POI mais específicas
classifications

Classification[]

Matriz de classificação
name

string

Nome da propriedade POI
openingHours

OperatingHours

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

string

Propriedade número de telefone
url

string

Propriedade URL do site

PointOfInterestCategorySet

Objeto

Categoria poi

Nome Tipo Description
id

integer

ID da categoria

QueryType

Enumeração

O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR.

Importante: Esta propriedade está obsoleta e pode ser omitida na resposta.

Valor Description
NEARBY

A busca era realizada ao redor de uma certa latitude e longitude com um raio definido.
NON_NEAR

A pesquisa foi realizada globalmente, sem ser tendenciosa para uma determinada latitude e longitude, e nenhum raio definido

ResponseFormat

Enumeração

Formato desejado da resposta. O valor pode ser json ou xml.

Valor Description
json

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

a linguagem de marcação extensível

SearchAddressResult

Objeto

Esse objeto é retornado de chamadas de pesquisa bem-sucedidas.

Nome Tipo Description
results

SearchAddressResultItem[]

Uma lista de resultados da API de Pesquisa.
summary

SearchSummary

Objeto resumo de uma resposta à API de Pesquisa

SearchAddressResultItem

Objeto

Objeto de resultado para uma resposta da API de Pesquisa.

Nome Tipo Description
address

Address

O endereço do resultado.
addressRanges

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

DataSources

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

integer

Tempo de desvio em segundos. Retornado apenas para chamadas para a API pesquisar ao longo da rota.
dist

number (double)

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

GeographicEntityType

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

EntryPoint[]

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

MatchType

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

Um destes:

  • Ponto de Endereço
  • CasaNúmeroIntervalo
  • Rua
poi

PointOfInterest

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

LatLongPairAbbreviated

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

number (double)

O valor dentro de um conjunto de resultados para indicar a pontuação de correspondência relativa entre os resultados. Você pode usá-lo 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ão destinados apenas como um valor relativo para um conjunto de resultados.

Importante: Esta propriedade está obsoleta e pode ser omitida na resposta.
type

SearchAddressResultType

Um destes:

  • POI
  • Rua
  • Geografia
  • Endereço de ponto
  • Intervalo de endereços
  • Cruzamento
viewport

BoundingBox

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

SearchAddressResultType

Enumeração

Um destes:

  • POI
  • Rua
  • Geografia
  • Endereço de ponto
  • Intervalo de endereços
  • Cruzamento
Valor Description
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchIndexes

Enumeração

Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de ponto

de POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (em qualquer ordem) ou Nenhum para nenhum índice.

Por padrão, códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de códigos postais estendidas para geografias podem ser bastante longas, portanto, elas precisam ser solicitadas explicitamente quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD, Addr, POI

extendedPostalCodesFor=None

O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.

Valor Description
Addr
Geo
PAD
POI
Str
Xstr

SearchInsideGeometryRequest

Objeto

Esse tipo representa o corpo da solicitação para o serviço Pesquisar Dentro da Geometria.

Nome Tipo Description
geometry GeoJsonObject:

Um objeto de GeoJSON válido. Consulte RFC 7946 para obter detalhes.

SearchSummary

Objeto

Objeto resumo de uma resposta da API de Pesquisa.

Nome Tipo Description
fuzzyLevel

integer

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

LatLongPairAbbreviated

Indicação de quando o mecanismo de pesquisa interno aplicou 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 quando 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 resolvendo a consulta, em milissegundos.
queryType

QueryType

O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR.

Importante: Esta propriedade está obsoleta e pode ser omitida na resposta.
totalResults

integer

O número total de resultados encontrados.