Partilhar via

Search - Post Search Inside Geometry

  • Referência
Serviço:
Maps
Versão da API:
1.0

Use para realizar pesquisas de forma livre dentro de mais uma geometria.

A API Post Search Inside Geometry é e HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a POSTrequest where the request body will contain thegeometriaobject represented as aGeoJSONtype and theContent-Typeheader will be set toapplication/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>Thegeometrycan be represented as aGeoJSON FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. TheFeatureCollectioncan contain a max of 50GeoJSON Featureobjects. EachFeatureobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>AFeatureobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>AFeatureobject for the Circle geometry is composed of a _center_ represented using aGeoJSON Pointtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sampleFeatureCollectionrepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>Thegeometrycan be represented as aGeoJSON GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. TheGeometryCollectioncan contain a max of 50GeoJSON Polygonobjects. EachPolygonobject can have a max of 50 coordinates. Please see the Examples section below for a sampleGeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>Thegeometrycan be represented as aGeoJSON Polygonobject. This is the recommended option if the geometry contains a single Polygon. ThePolygonobject can have a max of 50 coordinates. Please see the Examples section below for a samplePolygon' representation.

.

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 do URI

Name Em Necessá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 da versão da API do Azure Maps.
query
 query True

string

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

integer[]

Uma lista separada por vírgulas de IDs de conjunto de categorias que podem ser usadas para restringir o resultado a categorias específicas de Pontos de Interesse. A ordem de identificação não importa. O número máximo de valores de categorySet suportados por solicitação é 10. Quando vários identificadores de categoria são fornecidos, somente POIs que pertencem a (pelo menos) uma das categorias da lista fornecida serão retornados. A lista de categorias suportadas pode ser descoberta usando Categorias de POI API. Exemplos de uso:

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

  • categorySet=7315025,7315017 (Pesquisar Pontos de Interesse da categoria Restaurante italiano ou francês)
extendedPostalCodesFor
 query

SearchIndexes[]

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

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de Pontos

POI = Pontos de Interesse

Str = Ruas

XStr = Ruas transversais (cruzamentos)

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, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas alargadas de códigos postais para geografias podem ser bastante longas, pelo que têm de ser explicitamente solicitadas quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=Nenhum

O código postal estendido é devolvido como um código postal estendido propriedade 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 dos itens não importa. Os índices disponíveis são: Addr = Interpolação de intervalo de endereços, Geo = Geografias, PAD = Endereços de pontos, POI = Pontos de interesse, Str = Ruas, Xstr = Ruas transversais (cruzamentos)
language
 query

string

Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e 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 suportados para obter detalhes.
limit
 query

integer

minimum: 1
maximum: 100

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

OperatingHoursRange

Horário de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horários de funcionamento variará de acordo com os dados disponíveis. Se não for aprovado, nenhuma informação de horário de funcionamento será devolvida. Valor suportado: 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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Corpo do Pedido

Name Tipo Description
geometry GeoJsonObject:

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

Respostas

Name Tipo Description
200 OK

SearchAddressResult

OK
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de 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 Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento de do Maps.
  • O 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 de ID do Microsoft Entra.
  • O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • O uso do SDK da Web do Azure Maps 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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

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

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 segura 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 do Map 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

Pedido de amostra

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 da amostra

Código de estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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

Name Description
Address

O endereço do resultado
AddressRanges

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

O visor que cobre 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 devolvido
ClassificationName

Nome para a classificação
DataSources

Secçã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

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
GeographicEntityType

Tipo de entidade geográfica. 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 GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString

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

Um tipo de geometria 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 GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon

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

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

Um local representado como uma 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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.
MatchType

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

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

Horário de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horários de funcionamento variará de acordo com os dados disponíveis. Se não for aprovado, nenhuma informação de horário de funcionamento será devolvida. Valor suportado: nextSevenDays
OperatingHoursTime

Representa uma data e hora
OperatingHoursTimeRange

Intervalo de tempo aberto por um dia
PointOfInterest

Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.
PointOfInterestCategorySet

Categoria POI
QueryType

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

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

Este objeto é retornado de uma chamada de Pesquisa bem-sucedida.
SearchAddressResultItem

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

Um dos seguintes:

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

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

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de Pontos

POI = Pontos de Interesse

Str = Ruas

XStr = Ruas transversais (cruzamentos)

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, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas alargadas de códigos postais para geografias podem ser bastante longas, pelo que têm de ser explicitamente solicitadas quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=Nenhum

O código postal estendido é devolvido como um código postal estendido propriedade 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 de resumo para uma resposta da API de pesquisa.

Address

Object

O endereço do resultado

Name Tipo Description
boundingBox

BoundingBoxCompassNotation

A caixa delimitadora do local.
buildingNumber

string

O número do edifício na rua. DEPRECATED, use streetNumber em vez disso.
country

string

Nome do país/região
countryCode

string

País (Nota: Este é um código de duas letras, não um nome de país/região.)
countryCodeISO3

string

Código ISO alpha-3 do país
countrySecondarySubdivision

string

Condado
countrySubdivision

string

Distrito
countrySubdivisionCode

string

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

string

O nome completo de um primeiro nível de hierarquia administrativa de país/região. Este campo aparece apenas no caso de paísSubdivisão ser apresentado de forma abreviada. Apenas suportado 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/região de origem de um Resultado ou, no caso de um país/região, o 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. Este campo é usado para construir a propriedade freeformAddress. localName representa o município postal. Dependendo da localização, localName é o nome comumente conhecido de uma cidade ou vila. Para o nome comumente conhecido de uma cidade ou vila, use localName em vez de municipality.
municipality

string

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

string

Sub / Super Cidade
neighbourhood

string

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

string

Código Postal / Código Postal
routeNumbers

string[]

Os códigos utilizados para identificar inequivocamente a rua
street

string

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

string

O nome da rua.
streetNameAndNumber

string

O nome e o número da rua.
streetNumber

string

O número do edifício na rua.

AddressRanges

Object

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

Name Tipo Description
from

LatLongPairAbbreviated

Um local representado como uma 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 uma latitude e longitude usando nomes curtos 'lat' & 'lon'.

BoundingBox

Object

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

Name Tipo Description
btmRightPoint

LatLongPairAbbreviated

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

LatLongPairAbbreviated

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

BoundingBoxCompassNotation

Object

A caixa delimitadora do local.

Name 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, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas
southWest

string

latitude sudoeste, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas

Brand

Object

A marca associada ao POI

Name Tipo Description
name

string

Nome da marca

Classification

Object

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

Name Tipo Description
code

string

Propriedade de Código
names

ClassificationName[]

Matriz de nomes

ClassificationName

Object

Nome para a classificação

Name Tipo Description
name

string

Propriedade Name
nameLocale

string

Propriedade Name Locale

DataSources

Object

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

Name Tipo Description
geometry

Geometry

Informações sobre a forma geométrica do resultado. Presente apenas 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

Object

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

Name Tipo Description
position

LatLongPairAbbreviated

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

EntryPointType

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

EntryPointType

Enumeração

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

Valor Description
main
minor

ErrorAdditionalInfo

Object

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

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GeographicEntityType

Enumeração

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

Valor Description
Country

Nome do país/região
CountrySecondarySubdivision

Condado
CountrySubdivision

Distrito
CountryTertiarySubdivision

Área nomeada
Municipality

Cidade
MunicipalitySubdivision

Sub / Super Cidade
Neighbourhood

Bairro
PostalCodeArea

Código Postal / Código Postal

GeoJsonFeature

Object

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

Name 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

Object

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

Name 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

Object

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.

Name 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

Object

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

Name Tipo Description
geometries GeoJsonGeometry[]:

Contém uma lista de objetos de geometria GeoJSON válidos. Observe que as coordenadas no GeoJSON estão na 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

Object

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

Name 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

Object

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

Name 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

Object

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

Name 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

Object

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

Name Tipo Description
coordinates

number[] (double)

Contém uma lista de objetos GeoJSON Polygon válidos. Observe que as coordenadas no GeoJSON estão na 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

Object

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

Name Tipo Description
coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente nesta ordem. de 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

Object

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

Name 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

Object

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

Name Tipo Description
id

string

Passe isso como geometryId para o Get Search Polygon API para buscar informações de geometria para esse resultado.

LatLongPairAbbreviated

Object

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

Name 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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Valor Description
AE

Emirados Árabes Unidos (Vista árabe)
AR

Argentina (Vista Argentina)
Auto

Retornar os dados do mapa com base no endereço IP da solicitação.
BH

Bahrein (Vista árabe)
IN

Índia (Vista indiana)
IQ

Iraque (Vista árabe)
JO

Jordânia (Vista árabe)
KW

Kuwait (Vista árabe)
LB

Líbano (Vista árabe)
MA

Marrocos (Vista Marroquina)
OM

Omã (Vista árabe)
PK

Paquistão (Vista paquistanesa)
PS

Autoridade Palestiniana (Vista árabe)
QA

Qatar (Vista árabe)
SA

Arábia Saudita (Vista árabe)
SY

Síria (Vista árabe)
Unified

Modo de Exibição Unificado (Outros)
YE

Iémen (Vista árabe)

MatchType

Enumeração

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

Valor Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

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

Name Tipo Description
mode

string

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

OperatingHoursTimeRange[]

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

OperatingHoursRange

Enumeração

Horário de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horários de funcionamento variará de acordo com os dados disponíveis. Se não for aprovado, nenhuma informação de horário de funcionamento será devolvida. Valor suportado: nextSevenDays

Valor Description
nextSevenDays

Mostra o horário de funcionamento para a semana seguinte, começando com o dia atual na hora local do POI.

OperatingHoursTime

Object

Representa uma data e hora

Name Tipo Description
date

string

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

integer

As horas estão no formato de 24 horas no horário local de um POI; Os valores possíveis são 0 - 23.
minute

integer

Os minutos estão na hora local de um POI; Os valores possíveis são 0 - 59.

OperatingHoursTimeRange

Object

Intervalo de tempo aberto por um dia

Name Tipo Description
endTime

OperatingHoursTime

O ponto no próximo intervalo de 7 dias quando um determinado POI está sendo fechado, ou o início do intervalo se ele foi fechado antes do intervalo.
startTime

OperatingHoursTime

O ponto no intervalo de 7 dias seguintes quando um determinado POI está sendo aberto, ou o início do intervalo se ele foi aberto antes do intervalo.

PointOfInterest

Object

Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.

Name Tipo Description
brands

Brand[]

Matriz de marcas. O nome da marca para o POI sendo devolvido.
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 de um POI (Pontos de Interesse).
phone

string

Propriedade do número de telefone
url

string

Propriedade URL do site

PointOfInterestCategorySet

Object

Categoria POI

Name Tipo Description
id

integer

ID da categoria

QueryType

Enumeração

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

Valor Description
NEARBY

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

A pesquisa foi realizada globalmente, sem polarização para uma determinada latitude e longitude, e sem 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

Object

Este objeto é retornado de uma chamada de Pesquisa bem-sucedida.

Name Tipo Description
results

SearchAddressResultItem[]

Uma lista de resultados da API de pesquisa.
summary

SearchSummary

Objeto de resumo para uma resposta da API de Pesquisa

SearchAddressResultItem

Object

Objeto de resultado para uma resposta da API de pesquisa.

Name Tipo Description
address

Address

O endereço do resultado
addressRanges

AddressRanges

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

DataSources

Secçã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 somente para chamadas para a API Pesquisar ao longo da rota.
dist

number (double)

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

GeographicEntityType

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

EntryPoint[]

Matriz de EntryPoints. Estes 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 dos seguintes:

  • Ponto de endereço
  • CasaNúmeroGama
  • Rua
poi

PointOfInterest

Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.
position

LatLongPairAbbreviated

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

number (double)

O valor dentro de um conjunto de resultados para indicar a pontuação correspondente relativa entre os resultados. Você pode usar isso para determinar que o resultado x tem duas vezes mais probabilidade 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 apenas um valor relativo para um conjunto de resultados.
type

SearchAddressResultType

Um dos seguintes:

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

BoundingBox

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

SearchAddressResultType

Enumeração

Um dos seguintes:

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

SearchIndexes

Enumeração

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

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de Pontos

POI = Pontos de Interesse

Str = Ruas

XStr = Ruas transversais (cruzamentos)

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, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas alargadas de códigos postais para geografias podem ser bastante longas, pelo que têm de ser explicitamente solicitadas quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=Nenhum

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

Valor Description
Addr
Geo
PAD
POI
Str
Xstr

SearchInsideGeometryRequest

Object

Esse tipo representa o corpo da solicitação para o serviço Pesquisar dentro da geometria.

Name Tipo Description
geometry GeoJsonObject:

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

SearchSummary

Object

Objeto de resumo para uma resposta da API de pesquisa.

Name Tipo Description
fuzzyLevel

integer

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

LatLongPairAbbreviated

Indicação de quando o motor de busca interno aplicou um viés geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isso pode ser afetado pela definição dos parâmetros lat e lon, quando disponíveis. Noutros casos, é puramente interna.
limit

integer

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

integer

Número de resultados na resposta.
offset

integer

O deslocamento inicial dos Resultados retornados dentro do conjunto completo de Resultados.
query

string

O parâmetro de consulta que foi usado para produzir esses resultados de pesquisa.
queryTime

integer

Tempo gasto na resolução da consulta, em milissegundos.
queryType

QueryType

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

integer

O número total de Resultados encontrados.