Search - Post Search Fuzzy Batch

Используйте для отправки пакета запросов в ПОИСК API нечеткости в одном асинхронном запросе.
API Post Search Fuzzy Batch — это HTTP-запросPOST, который отправляет пакеты запросов в Поиск НЕчеткий API в одном асинхронном вызове. Вы можете вызвать Поиск API нечеткой пакетной службы для выполнения асинхронно (асинхронно) или синхронно (синхронизация). Асинхронный API позволяет вызывающей службе пакетировать до 10 000 запросов и синхронизировать API до 100 запросов.

Отправка синхронного пакетного запроса

Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, она ответит, как только вычисляются элементы пакета, и позже не будет возможности получить результаты. Синхронный API вернет ошибку времени ожидания (ответ 408), если запрос занимает больше 60 секунд. Количество элементов пакета ограничено 100 для этого API.

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

Отправка асинхронного пакетного запроса

Асинхронный API подходит для обработки больших объемов относительно сложных поисковых запросов.

  • Он позволяет получать результаты в отдельном вызове (возможно несколько скачиваний).
  • Асинхронный API оптимизирован для обеспечения надежности и, как ожидается, не будет превышено время ожидания.
  • Количество элементов пакета ограничено 10 000 для этого API.

При выполнении запроса с помощью асинхронного запроса служба по умолчанию возвращает код ответа 202 вместе с URL-адресом перенаправления в поле Расположение заголовка ответа. Этот URL-адрес следует периодически проверять, пока не будут доступны данные ответа или сведения об ошибке. Асинхронные ответы хранятся в течение 14 дней. URL-адрес перенаправления возвращает ответ 404, если он используется после истечения срока действия.

Обратите внимание, что асинхронный пакетный запрос является длительной операцией. Ниже приведена типичная последовательность операций.

  1. Клиент отправляет Поиск нечеткий пакетный POST запрос Azure Maps.
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}
  1. Сервер ответит одним из следующих вариантов:

    HTTP 202 Accepted — пакетный запрос принят.

    HTTP Error — произошла ошибка при обработке запроса пакетной службы. Это может быть либо код состояния, либо любой 400 Bad Request другой Error код состояния.

  2. Если пакетный запрос был успешно принят, Location заголовок в ответе содержит URL-адрес для скачивания результатов пакетного запроса. Этот универсальный код ресурса (URI) состояния выглядит следующим образом:

    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Клиент отправляет GET запрос по URL-адресу для скачивания , полученному на шаге 3, для скачивания результатов пакета.

Текст POST для пакетного запроса

Для отправки нечетких запросов поиска используется POST запрос, в котором текст запроса будет содержать batchItems массив в json формате , а Content-Type заголовок будет иметь значение application/json. Ниже приведен пример текста запроса, содержащего 5 нечетких запросов поиска :

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

Нечеткий запрос поиска в пакете — это всего лишь частичный URL-адрес без протокола, базового URL-адреса, пути, api-версии и ключа подписки. Он может принимать любые поддерживаемые нечеткиепараметры URI поиска. Строковые значения в нечетком запросе поиска должны быть надлежащим образом экранированы (например, символ " должен быть экранирован с \ ), а также правильно закодирован URL-адрес.

Асинхронный API позволяет вызывающей службе пакетировать до 10 000 запросов и API синхронизации до 100 запросов, а пакет должен содержать не менее 1 запроса.

Скачивание результатов асинхронной пакетной обработки

Чтобы скачать результаты асинхронного пакета, отправьте запрос к конечной GET точке пакетной загрузки. Этот URL-адрес для скачивания можно получить из заголовка Location успешного POST пакетного запроса и выглядеть следующим образом:

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

Ниже приведена типичная последовательность операций для скачивания результатов пакета.

  1. Клиент отправляет запрос по GETURL-адресу для скачивания.

  2. Сервер ответит одним из следующих вариантов:

    HTTP 202 Accepted — пакетный запрос был принят, но все еще обрабатывается. Повторите попытку через некоторое время.

    HTTP 200 OK — пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.

Модель пакетного ответа

Возвращаемое содержимое данных аналогично для асинхронных запросов и запросов синхронизации. Если при скачивании результатов асинхронного пакетного запроса обработка пакета завершена, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит summary компонент , который указывает totalRequests , которые были частью исходного пакетного запроса, и successfulRequestsт. е. запросы, которые были успешно выполнены. Пакетный ответ также содержит batchItems массив, содержащий ответ для каждого запроса в пакетном запросе. будет batchItems содержать результаты в том же порядке, в котором были отправлены исходные запросы в пакетном запросе. Каждый элемент в batchItems содержит statusCode поля и response . Каждое response в batchItems относится к одному из следующих типов:

  • SearchAddressResult — если запрос выполнен успешно.

  • Error — если запрос завершился ошибкой. В этом случае ответ будет содержать code и .message

Ниже приведен пример пакетного ответа с результатом 2 успешных и 1 сбоем :

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

Параметры URI

Имя В Обязательно Тип Описание
format
path True

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

api-version
query True

string

Номер версии API Azure Maps

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Текст запроса

Имя Тип Описание
batchItems

BatchRequestItem[]

Список запросов для обработки.

Ответы

Имя Тип Описание
200 OK

SearchAddressBatchProcessResult

ОК

202 Accepted

Поддерживается только для асинхронного запроса. Запрос принят: запрос принят для обработки. Используйте URL-адрес в заголовке расположения, чтобы повторить попытку или получить доступ к результатам.

Headers

Location: string

Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечание

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами .
  • Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID.
  • Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
  • Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
  • Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

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

Scopes

Имя Описание
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы обеспечить безопасное хранение ключа.

Type: apiKey
In: query

SAS Token

Это маркер подписанного URL-адреса, созданный с помощью операции List SAS для ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов, используемых для конкретного маркера. Другими словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера SAS и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

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

Sample Request

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

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

Sample Response

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

Определения

Имя Описание
Address

Адрес результата

AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.

BatchRequest

Этот тип представляет текст запроса для пакетной службы.

BatchRequestItem

Объект пакетного запроса

BoundingBox

Окно просмотра, охватывающее результат, представленный верхней левой и нижней правой координатами окна просмотра.

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

Brand

Торговая марка, связанная с POI

Classification

Классификация возвращаемого POI

ClassificationName

Имя классификации

DataSources

Необязательный раздел. Идентификаторы ссылок для использования с API получения Поиск polygon.

Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.

EntryPoint

Точка входа для возвращаемого poI.

EntryPointType

Тип точки входа. Значение может быть main или дополнительным.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если entityType был запрошен и доступен.

Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

MatchType

Типы совпадений для операции обратного поиска адресов.

OperatingHours

Часы работы для POI (точки интереса).

OperatingHoursTime

Представляет дату и время.

OperatingHoursTimeRange

Диапазон времени открытия в день

PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.

PointOfInterestCategorySet

Категория POI

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

Response

Результат запроса. SearchAddressResult, если запрос выполнен успешно, ErrorResponse — в противном случае.

SearchAddressBatchItem

Элемент, возвращенный вызовом пакетной службы Поиск address.

SearchAddressBatchProcessResult

Этот объект возвращается из успешного вызова пакетной службы Поиск address.

SearchAddressResultItem

Результирующий объект для ответа API Поиск.

SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
SearchSummary

Объект Summary для ответа API Поиск.

Summary

Сводка результатов пакетного запроса

Address

Адрес результата

Имя Тип Описание
boundingBox

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

buildingNumber

string

Номер здания на улице. Не рекомендуется, вместо этого используйте streetNumber.

country

string

название страны или региона

countryCode

string

Страна (примечание. Это двухбуквенный код, а не название страны или региона.)

countryCodeISO3

string

Код страны ISO alpha-3

countrySecondarySubdivision

string

Округ

countrySubdivision

string

Область, республика, край

countrySubdivisionCode

string

countrySubdivisionCode с префиксом countryCode ( countryCode-countrySubdivisionCode ), а дефис формирует код ISO 3166-2. Примеры: TX для Техаса, SCT для Шотландии и ON для Онтарио.

countrySubdivisionName

string

Полное имя первого уровня административной иерархии страны или региона. Это поле отображается только в том случае, если countrySubdivision представлено в сокращенной форме. Поддерживается только для США, Канады и Соединенного Королевства.

countryTertiarySubdivision

string

Именованной области

crossStreet

string

Название пересекаемой улицы.

extendedPostalCode

string

Расширенный почтовый индекс (доступность зависит от региона).

freeformAddress

string

Адресная строка, отформатированная в соответствии с правилами форматирования страны или региона источника результата или в случае страны или региона, его полного названия страны или региона.

localName

string

Компонент адреса, представляющий имя географической области или местности, которая группирует несколько адресуемых объектов для целей адресации, не являясь административной единицей. Это поле используется для сборки freeformAddress свойства . localName представляет почтовый муниципалитет. В зависимости от расположения — localName это общеизвестное название города или города. Для общеизвестного названия города или города используйте localName вместо municipality.

municipality

string

Город или город
Примечание. municipality Представляет жилой муниципалитет. В зависимости от расположения municipality значение может отличаться от общего имени города или города. Для общего имени города или города рекомендуется localName использовать значение вместо municipality значения.

municipalitySubdivision

string

Sub / Super City

neighbourhood

string

Район — это географически локализованная территория в пределах города или города с отличительными характеристиками и социальными взаимодействиями между жителями.

postalCode

string

Почтовый индекс / почтовый индекс

routeNumbers

string[]

Коды, используемые для однозначной идентификации улицы

street

string

Название улицы. Не рекомендуется, вместо этого используйте streetName.

streetName

string

Название улицы.

streetNameAndNumber

string

Название и номер улицы.

streetNumber

string

Номер здания на улице.

AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.

Имя Тип Описание
from

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

rangeLeft

string

Диапазон адресов в левой части улицы.

rangeRight

string

Диапазон адресов на правой стороне улицы.

to

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

BatchRequest

Этот тип представляет текст запроса для пакетной службы.

Имя Тип Описание
batchItems

BatchRequestItem[]

Список запросов для обработки.

BatchRequestItem

Объект пакетного запроса

Имя Тип Описание
query

string

Этот параметр содержит строку запроса, используемую для выполнения неструктурированной операции геокодирования. Строка запроса будет передана в API поиска для обработки дословно.

BoundingBox

Окно просмотра, охватывающее результат, представленный верхней левой и нижней правой координатами окна просмотра.

Имя Тип Описание
btmRightPoint

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

topLeftPoint

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

Имя Тип Описание
entity

Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.

northEast

string

Северо-восточная широта,долгота координаты ограничивающего прямоугольника в виде поплавков с раздели-запятыми

southWest

string

Широта юго-запада, координата долготы ограничивающего прямоугольника в виде поплавков с разделимы-запятыми

Brand

Торговая марка, связанная с POI

Имя Тип Описание
name

string

Название торговой марки

Classification

Классификация возвращаемого POI

Имя Тип Описание
code

string

Свойство Code

names

ClassificationName[]

Массив имен

ClassificationName

Имя классификации

Имя Тип Описание
name

string

Name - свойство

nameLocale

string

Имя свойства Locale

DataSources

Необязательный раздел. Идентификаторы ссылок для использования с API получения Поиск polygon.

Имя Тип Описание
geometry

Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.

Имя Тип Описание
position

string

Сущность Position

EntryPoint

Точка входа для возвращаемого poI.

Имя Тип Описание
position

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

type

EntryPointType

Тип точки входа. Значение может быть main или дополнительным.

EntryPointType

Тип точки входа. Значение может быть main или дополнительным.

Имя Тип Описание
main

string

minor

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если entityType был запрошен и доступен.

Имя Тип Описание
Country

string

название страны или региона

CountrySecondarySubdivision

string

Округ

CountrySubdivision

string

Область, республика, край

CountryTertiarySubdivision

string

Именованной области

Municipality

string

Город или город

MunicipalitySubdivision

string

Sub / Super City

Neighbourhood

string

Районе

PostalCodeArea

string

Почтовый индекс / почтовый индекс

Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

Имя Тип Описание
id

string

Передайте его как geometryId в API получения Поиск многоугольников, чтобы получить геометрическую информацию для этого результата.

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

Имя Тип Описание
json

string

Формат обмена данными нотации объектов JavaScript

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

Имя Тип Описание
lat

number

Свойство Latitude

lon

number

Свойство Долгота

MatchType

Типы совпадений для операции обратного поиска адресов.

Имя Тип Описание
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Часы работы для POI (точки интереса).

Имя Тип Описание
mode

string

Значение, используемое в запросе: none или "nextSevenDays"

timeRanges

OperatingHoursTimeRange[]

Список диапазонов времени на следующие 7 дней

OperatingHoursTime

Представляет дату и время.

Имя Тип Описание
date

string

Представляет текущую дату календаря в часовом поясе POI, например 2019-02-07.

hour

integer

Часы находятся в формате 24 часов по местному времени poI; Возможные значения: от 0 до 23.

minute

integer

Минуты относятся к местному времени poI; Возможные значения: от 0 до 59.

OperatingHoursTimeRange

Диапазон времени открытия в день

Имя Тип Описание
endTime

OperatingHoursTime

Точка в диапазоне ближайших 7 дней при закрытии заданного poI или начало диапазона, если он был закрыт до диапазона.

startTime

OperatingHoursTime

Точка в диапазоне ближайших 7 дней, когда открывается данный poI, или начало диапазона, если он был открыт до диапазона.

PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.

Имя Тип Описание
brands

Brand[]

Массив торговых марок. Имя торговой марки для возвращаемого poI.

categories

string[]

Массив категорий

categorySet

PointOfInterestCategorySet[]

Список наиболее конкретных категорий POI

classifications

Classification[]

Массив классификации

name

string

Имя свойства POI

openingHours

OperatingHours

Часы работы для POI (точки интереса).

phone

string

Свойство "Номер телефона"

url

string

Свойство URL-адреса веб-сайта

PointOfInterestCategorySet

Категория POI

Имя Тип Описание
id

integer

Идентификатор категории

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

Имя Тип Описание
NEARBY

string

Поиск выполнялись вокруг определенной широты и долготы с определенным радиусом

NON_NEAR

string

Поиск выполняется глобально, без смещений на определенную широту и долготу, без определенного радиуса

Response

Результат запроса. SearchAddressResult, если запрос выполнен успешно, ErrorResponse — в противном случае.

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

results

SearchAddressResultItem[]

Список результатов Поиск API.

summary

SearchSummary

Объект Summary для ответа API Поиск

SearchAddressBatchItem

Элемент, возвращенный вызовом пакетной службы Поиск address.

Имя Тип Описание
response

Response

Результат запроса. SearchAddressResult, если запрос выполнен успешно, ErrorResponse — в противном случае.

statusCode

integer

Код состояния HTTP-запроса.

SearchAddressBatchProcessResult

Этот объект возвращается из успешного вызова пакетной службы Поиск address.

Имя Тип Описание
batchItems

SearchAddressBatchItem[]

Массив, содержащий результаты пакета.

summary

Summary

Сводка результатов пакетного запроса

SearchAddressResultItem

Результирующий объект для ответа API Поиск.

Имя Тип Описание
address

Address

Адрес результата

addressRanges

AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.

dataSources

DataSources

Необязательный раздел. Идентификатор геометрии ссылки для использования с API получения Поиск polygon.

detourTime

integer

Время объезда в секундах. Возвращается только для вызовов API маршрута Поиск.

dist

number

Прямое расстояние между результатом и расположением геобия в метрах.

entityType

GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если entityType был запрошен и доступен.

entryPoints

EntryPoint[]

Массив точек входа. Они описывают типы входов, доступных на месте. Тип может быть "main" для main входов, таких как входная дверь или вестибюль, и "дополнительный" для боковых и задних дверей.

id

string

Свойство Id

info

string

Сведения об исходном источнике данных result. Используется для запросов на поддержку.

matchType

MatchType

Сведения о типе соответствия.

Одно из двух значений:

  • AddressPoint
  • HouseNumberRange
  • Улица
poi

PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.

position

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

score

number

Значение в результирующем наборе, указывающее относительную оценку соответствия между результатами. Это позволяет определить, что результат x в два раза выше, чем результат y, если значение x равно 2x значению y. Значения зависят от запросов и предназначены только как относительное значение для одного результирующих наборов.

type

SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
viewport

BoundingBox

Окно просмотра, охватывающее результат, представленный верхней левой и нижней правой координатами окна просмотра.

SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
Имя Тип Описание
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchSummary

Объект Summary для ответа API Поиск.

Имя Тип Описание
fuzzyLevel

integer

Максимальный уровень нечеткости, необходимый для предоставления результатов.

geoBias

LatLongPairAbbreviated

Указание того, что внутренняя поисковая система применила геопространственный уклон для улучшения ранжирования результатов. В некоторых методах на это можно повлиять, задав параметры lat и lon там, где они доступны. В других случаях это чисто внутренний.

limit

integer

Максимальное число ответов, которые будут возвращены

numResults

integer

Количество результатов в ответе.

offset

integer

Начальная смещение возвращаемых результатов в полном результирующем наборе.

query

string

Параметр запроса, который использовался для получения этих результатов поиска.

queryTime

integer

Время, затраченное на разрешение запроса, в миллисекундах.

queryType

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

totalResults

integer

Общее число найденных результатов.

Summary

Сводка результатов пакетного запроса

Имя Тип Описание
successfulRequests

integer

Число успешных запросов в пакете

totalRequests

integer

Общее количество запросов в пакете