Search - Post Search Fuzzy Batch

유사 항목 Batch API 검색

적용 대상: 가격 책정 계층을 참조하세요.

검색 주소 일괄 처리 API는 단일 API 호출을 사용하여 검색 유사 항목 API 에 쿼리 일괄 처리를 보냅니다. 검색 주소 유사 항목 Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)로 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 10,000 개의 쿼리를 일괄 처리하고 최대 100 개의 쿼리를 API를 동기화할 수 있습니다.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성은 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 이 API의 일괄 처리 항목 수는 100 개로 제한됩니다.

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

비동기 일괄 처리 요청 제출

비동기 API는 비교적 복잡한 검색 요청의 큰 볼륨을 처리하는 데 적합합니다.

  • 별도의 호출에서 결과를 검색할 수 있습니다(여러 다운로드 가능).
  • 비동기 API는 안정성에 최적화되어 있으며 시간 초과로 실행되지 않을 것으로 예상됩니다.
  • 일괄 처리 항목 수는 이 API에 대해 10,000 개로 제한됩니다.

비동기 요청을 사용하여 요청을 수행할 때 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 비동기 응답은 14 일 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

비동기 일괄 처리 요청은 장기 실행 요청입니다. 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트가 Azure Maps 검색 주소 일괄 처리 POST 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - Batch 요청이 수락되었습니다.

    HTTP Error - Batch 요청을 처리하는 동안 오류가 발생했습니다. 이 코드는 A 400 Bad Request 또는 다른 Error 상태 코드일 수 있습니다.

  3. 일괄 처리 요청이 성공적으로 수락된 경우 응답의 Location 헤더에는 일괄 처리 요청의 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. 클라이언트는 GET 3단계에서 가져온 다운로드 URL 에 대한 요청을 실행하여 일괄 처리 결과를 다운로드합니다.

Batch 요청에 대한 POST 본문

검색 유사 항목 쿼리를 보내려면 요청 본문에 배열 json 형식이 포함 batchItems 되고 Content-Type 헤더가 설정application/json되는 요청을 사용합니다POST. 다음은 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, 경로, api-version 및 subscription-key 가 없는 부분 URL일 뿐입니다. 지원되는 검색 유사 항목URI 매개 변수를 수락할 수 있습니다. 검색 유사 항목 쿼리의 문자열 값은 제대로 이스케이프되어야 하며(예: " 문자는 \로 이스케이프되어야 함) URL로 인코딩되어야 합니다.

비동기 API를 사용하면 호출자가 최대 10,000 개의 쿼리를 일괄 처리하고 API를 최대 100 개의 쿼리와 동기화할 수 있으며 일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.

비동기 일괄 처리 결과 다운로드

비동기 일괄 처리 결과를 다운로드하려면 일괄 처리 다운로드 엔드포인트에 요청을 실행 GET 합니다. 이 다운로드 URL은 성공적인 POST 일괄 처리 요청의 헤더에서 Location 가져올 수 있으며 다음과 같습니다.

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

일괄 처리 결과를 다운로드하기 위한 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 다운로드 URLGET 사용하여 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - Batch 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

    HTTP 200 OK - 일괄 처리 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 일괄 처리 결과가 포함됩니다.

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 구성 요소와 successfulRequests성공적으로 실행된 쿼리를 나타내는 totalRequests 구성 요소가 포함되어 summary 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 batchItems 각 쿼리와 모든 쿼리에 대한 응답이 포함된 배열도 포함됩니다. 원래 batchItems 쿼리가 일괄 처리 요청에서 전송된 것과 동일한 순서로 결과를 포함합니다. 포함된 batchItems 각 항목에는 필드가 포함됩니다 statusCoderesponse . 각 response 유형 batchItems 은 다음 유형 중 하나입니다.

  • SearchAddressResponse - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 a code 와 a가 message 포함됩니다.

다음은 2개 성공 및 1개 실패 결과가 포함된 샘플 Batch 응답입니다.

{
    "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 매개 변수

Name In Required Type Description
format
path True

원하는 응답 형식입니다. json 형식만 지원됩니다.

api-version
query True
  • string

Azure Maps API의 버전 번호.

요청 헤더

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

Azure AD 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정에 대한 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps Azure AD 보안을 사용하려면 다음 문서를 참조하세요.

요청 본문

Name Type Description
batchItems

처리할 쿼리 목록입니다.

응답

Name Type Description
200 OK

정상

202 Accepted

비동기 요청에 대해서만 지원됩니다. 요청 수락됨: 처리를 위해 요청이 수락되었습니다. 위치 헤더의 URL을 사용하여 결과를 다시 시도하거나 액세스하세요.

Headers

  • Location: string
Other Status Codes

예기치 않은 오류가 발생했습니다.

보안

AADToken

Azure Active Directory OAuth2 흐름입니다. Azure 역할 기반 액세스 제어와 쌍을 이루는 경우 AZURE MAPS REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 기본 제공 역할 또는 REST API를 Azure Maps 하나 이상의 권한으로 구성된 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.

시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하기 위한 솔루션을 제공합니다.

참고

  • 이 보안 정의에서는 애플리케이션이 액세스를 요청하는 Azure Maps 리소스를 나타내기 위해 헤더를 사용해야 x-ms-client-id 합니다. 이는 Maps 관리 API에서 가져올 수 있습니다.

Azure Authorization URL 퍼블릭 클라우드 인스턴스에만 해당됩니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Azure Active Directory 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps 웹 SDK를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 허용합니다.

  • 현재 Azure Active Directory v1.0 또는 v2.0 은 회사, 학교 및 게스트를 지원하지만 개인 계정은 지원하지 않습니다.

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

Scopes

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

subscription-key

이 키는 Azure Portal Azure Maps 계정을 만들거나 PowerShell, CLI, Azure SDK 또는 REST API를 사용할 때 프로비전되는 공유 키입니다.

이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있습니다. 즉, 이 키를 발급된 계정에서 마스터 키로 사용할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 기밀 클라이언트 애플리케이션 접근 방식을 사용하여 키를 안전하게 저장할 수 있도록 Azure Maps REST API에 액세스하는 것이 좋습니다.

Type: apiKey
In: query

SAS Token

공유 액세스 서명 토큰은 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스의 SAS 나열 작업에서 만들어집니다.

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

정의

Address

결과의 주소

AddressRanges

검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다.

BatchRequest

이 형식은 Batch 서비스에 대한 요청 본문을 나타냅니다.

BatchRequestItem

Batch 요청 개체

BoundingBox

뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다.

BoundingBoxCompassNotation

위치의 경계 상자입니다.

Brand

POI와 연결된 브랜드

Classification

반환되는 POI에 대한 분류

ClassificationName

분류 이름

DataSources

선택 단원. 검색 다각형 가져오기 API에 사용할 참조 ID입니다.

Entity

경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다.

EntryPoint

반환되는 POI의 진입점입니다.

EntryPointType

진입점의 형식입니다. 값은 또는 값일 수 있습니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

오류 응답

GeographicEntityType

지리 엔터티 형식입니다. entityType을 요청하여 사용할 수 있는 경우에만 표시합니다.

Geometry

결과의 기하 도형에 대한 정보입니다. == Geography 형식인 경우에만 존재합니다.

JsonFormat

원하는 응답 형식입니다. json 형식만 지원됩니다.

LatLongPairAbbreviated

짧은 이름 'lat' & 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

MatchType

역방향 주소 검색 작업에 대한 일치 유형입니다.

OperatingHours

POI의 영업 시간(관심 지점).

OperatingHoursTime

날짜 및 시간을 나타냅니다.

OperatingHoursTimeRange

하루 동안의 여는 시간 범위

PointOfInterest

이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다.

PointOfInterestCategorySet

POI 범주

QueryType

반환되는 쿼리 유형: NEARBY 또는 NON_NEAR.

Response

쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 SearchAddressResponse, 그렇지 않으면 ErrorResponse입니다.

SearchAddressBatchItem

Search Address Batch 서비스 호출에서 반환된 항목입니다.

SearchAddressBatchProcessResult

이 개체는 성공적인 검색 주소 일괄 처리 서비스 호출에서 반환됩니다.

SearchAddressResultItem

Search API 응답에 대한 결과 개체입니다.

SearchAddressResultType

다음 중 하나:

  • 지점
  • Street
  • 지리
  • 지점 주소
  • 주소 범위
  • 교차로
SearchSummary

Search API 응답에 대한 요약 개체입니다.

Summary

일괄 처리 요청에 대한 결과 요약

Address

결과의 주소

Name Type Description
boundingBox

위치의 경계 상자입니다.

buildingNumber
  • string

거리의 건물 번호입니다. 사용되지 않습니다. 대신 streetNumber를 사용합니다.

country
  • string

국가 이름

countryCode
  • string

국가(참고: 국가 이름이 아닌 두 글자 코드입니다.)

countryCodeISO3
  • string

ISO alpha-3 국가 코드

countrySecondarySubdivision
  • string

국가

countrySubdivision
  • string

시/도

countrySubdivisionName
  • string

국가 관리 계층 구조의 첫 번째 수준의 전체 이름입니다. 이 필드는 countrySubdivision이 축약된 형식으로 표시되는 경우에만 나타납니다. 미국, 캐나다 및 영국에서만 지원됩니다.

countryTertiarySubdivision
  • string

명명된 영역

crossStreet
  • string

교차되는 거리의 이름입니다.

extendedPostalCode
  • string

확장된 우편 번호(가용성은 지역에 따라 다발성)입니다.

freeformAddress
  • string

결과 원본 국가의 서식 규칙에 따라 서식이 지정된 주소 줄 또는 국가의 경우 전체 국가 이름입니다.

localName
  • string

관리 단위가 아니어도 주소 지정이 가능한 여러 개체를 주소 지정 가능한 개체로 그룹화한 지리적 영역 또는 지역 이름을 나타내는 주소 구성 요소입니다. 이 필드는 속성을 빌드 freeformAddress 하는 데 사용됩니다.

municipality
  • string

City / Town

municipalitySubdivision
  • string

서브/슈퍼 시티

postalCode
  • string

우편 번호/우편 번호

routeNumbers
  • string[]

거리를 명확하게 식별하는 데 사용되는 코드

street
  • string

거리 이름입니다. 사용되지 않습니다. 대신 streetName을 사용합니다.

streetName
  • string

거리 이름입니다.

streetNameAndNumber
  • string

거리 이름 및 번호입니다.

streetNumber
  • string

거리의 건물 번호입니다.

AddressRanges

검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다.

Name Type Description
from

짧은 이름 'lat' & 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

rangeLeft
  • string

거리의 왼쪽에 있는 주소 범위입니다.

rangeRight
  • string

거리의 오른쪽에 있는 주소 범위입니다.

to

짧은 이름 'lat' & 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

BatchRequest

이 형식은 Batch 서비스에 대한 요청 본문을 나타냅니다.

Name Type Description
batchItems

처리할 쿼리 목록입니다.

BatchRequestItem

Batch 요청 개체

Name Type Description
query
  • string

이 매개 변수에는 구조화되지 않은 지오코딩 작업을 수행하는 데 사용되는 쿼리 문자열이 포함되어 있습니다. 쿼리 문자열은 처리를 위해 검색 API에 축자 그대로 전달됩니다.

BoundingBox

뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다.

Name Type Description
btmRightPoint

짧은 이름 'lat' & 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

topLeftPoint

짧은 이름 'lat' & 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

BoundingBoxCompassNotation

위치의 경계 상자입니다.

Name Type Description
entity

경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다.

northEast
  • string

북동 위도, 경계 상자의 경도 좌표(쉼표로 구분된 부동 소수선)

southWest
  • string

남서 위도, 경계 상자의 경도 좌표(쉼표로 구분된 수레)

Brand

POI와 연결된 브랜드

Name Type Description
name
  • string

브랜드 이름

Classification

반환되는 POI에 대한 분류

Name Type Description
code
  • string

Code 속성

names

이름 배열

ClassificationName

분류 이름

Name Type Description
name
  • string

Name 속성

nameLocale
  • string

Name Locale 속성

DataSources

선택 단원. 검색 다각형 가져오기 API에 사용할 참조 ID입니다.

Name Type Description
geometry

결과의 기하 도형에 대한 정보입니다. == Geography 형식인 경우에만 존재합니다.

Entity

경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다.

Name Type Description
position
  • string

위치 엔터티

EntryPoint

반환되는 POI의 진입점입니다.

Name Type Description
position

짧은 이름 'lat' & 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

type

진입점의 형식입니다. 값은 또는 값일 수 있습니다.

EntryPointType

진입점의 형식입니다. 값은 또는 값일 수 있습니다.

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name Type Description
info
  • object

추가 정보입니다.

type
  • string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name Type Description
additionalInfo

오류 추가 정보입니다.

code
  • string

오류 코드입니다.

details

오류 세부 정보입니다.

message
  • string

오류 메시지입니다.

target
  • string

오류 대상입니다.

ErrorResponse

오류 응답

Name Type Description
error

오류 개체입니다.

GeographicEntityType

지리 엔터티 형식입니다. entityType을 요청하여 사용할 수 있는 경우에만 표시합니다.

Name Type Description
Country
  • string

국가 이름

CountrySecondarySubdivision
  • string

국가

CountrySubdivision
  • string

시/도

CountryTertiarySubdivision
  • string

명명된 영역

Municipality
  • string

City / Town

MunicipalitySubdivision
  • string

서브/슈퍼 시티

Neighbourhood
  • string

이웃

PostalCodeArea
  • string

우편 번호/우편 번호

Geometry

결과의 기하 도형에 대한 정보입니다. == Geography 형식인 경우에만 존재합니다.

Name Type Description
id
  • string

이 결과를 위해 기하 도형 정보를 가져오려면 검색 다각형 API 가져오기에 geometryId로 전달합니다.

JsonFormat

원하는 응답 형식입니다. json 형식만 지원됩니다.

Name Type Description
json
  • string

JavaScript 개체 표기법 데이터 교환 형식

LatLongPairAbbreviated

짧은 이름 'lat' & 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

Name Type Description
lat
  • number

위도 속성

lon
  • number

경도 속성

MatchType

역방향 주소 검색 작업에 대한 일치 유형입니다.

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

OperatingHours

POI의 영업 시간(관심 지점).

Name Type Description
mode
  • string

요청에 사용된 값: none 또는 "nextSevenDays"

timeRanges

다음 7일 동안의 시간 범위 목록

OperatingHoursTime

날짜 및 시간을 나타냅니다.

Name Type Description
date
  • string

POI 표준 시간대의 현재 달력 날짜를 나타냅니다(예: "2019-02-07").

hour
  • integer

시간은 POI의 현지 시간에 24시간 형식입니다. 가능한 값은 0 - 23입니다.

minute
  • integer

분은 POI의 현지 시간에 있습니다. 가능한 값은 0 - 59입니다.

OperatingHoursTimeRange

하루 동안의 여는 시간 범위

Name Type Description
endTime

지정된 POI가 닫히는 다음 7일 범위의 지점이거나 범위 이전에 닫힌 경우 범위의 시작점입니다.

startTime

지정된 POI가 열려 있는 다음 7일 범위의 지점이거나 범위 이전에 열린 경우 범위의 시작점입니다.

PointOfInterest

이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다.

Name Type Description
brands

브랜드 배열입니다. 반환되는 POI의 브랜드 이름입니다.

categories
  • string[]

범주 배열

categorySet

가장 구체적인 POI 범주 목록

classifications

분류 배열

name
  • string

POI 속성의 이름

openingHours

POI의 영업 시간(관심 지점).

phone
  • string

전화 번호 속성

url
  • string

웹 사이트 URL 속성

PointOfInterestCategorySet

POI 범주

Name Type Description
id
  • integer

범주 ID입니다.

QueryType

반환되는 쿼리 유형: NEARBY 또는 NON_NEAR.

Name Type Description
NEARBY
  • string

정의된 반경을 사용하여 특정 위도 및 경도를 중심으로 검색을 수행했습니다.

NON_NEAR
  • string

검색은 특정 위도 및 경도에 편향되지 않고 전역적으로 수행되었으며 정의된 반경이 없습니다.

Response

쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 SearchAddressResponse, 그렇지 않으면 ErrorResponse입니다.

Name Type Description
error

오류 개체입니다.

results

검색 API 결과 목록입니다.

summary

Search API 응답에 대한 요약 개체

SearchAddressBatchItem

Search Address Batch 서비스 호출에서 반환된 항목입니다.

Name Type Description
response

쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 SearchAddressResponse, 그렇지 않으면 ErrorResponse입니다.

statusCode
  • integer

HTTP 요청 상태 코드입니다.

SearchAddressBatchProcessResult

이 개체는 성공적인 검색 주소 일괄 처리 서비스 호출에서 반환됩니다.

Name Type Description
batchItems

일괄 처리 결과를 포함하는 배열입니다.

summary

일괄 처리 요청에 대한 결과 요약

SearchAddressResultItem

Search API 응답에 대한 결과 개체입니다.

Name Type Description
address

결과의 주소

addressRanges

검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다.

dataSources

선택 단원. 검색 다각형 가져오기 API에 사용할 참조 기하 도형 ID입니다.

detourTime
  • integer

우회 시간(초)입니다. 경로 API를 따라 검색에 대한 호출에 대해서만 반환됩니다.

dist
  • number

결과 위치와 지오비아 위치 사이의 직선 거리(미터)입니다.

entityType

지리 엔터티 형식입니다. entityType을 요청하여 사용할 수 있는 경우에만 표시합니다.

entryPoints

EntryPoint의 배열입니다. 이들은 위치에서 사용할 수있는 입구의 유형을 설명합니다. 이 유형은 정문 또는 로비와 같은 정문의 경우 "main"이고 측면 및 뒷문의 경우 "부"일 수 있습니다.

id
  • string

Id 속성

info
  • string

결과의 원래 데이터 원본에 대한 정보입니다. 지원 요청에 사용됩니다.

matchType

일치 유형에 대한 정보입니다.

다음 중 하나:

  • AddressPoint
  • HouseNumberRange
  • Street
poi

이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다.

position

짧은 이름 'lat' & 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

score
  • number

결과 집합 내의 값으로, 결과 간의 상대적 일치 점수를 나타냅니다. x 값이 y 값의 2배인 경우 결과 x가 결과 y보다 두 배 더 관련성이 높은지 확인하는 데 사용할 수 있습니다. 값은 쿼리마다 다르며 하나의 결과 집합에 대한 상대 값으로만 사용됩니다.

type

다음 중 하나:

  • 지점
  • Street
  • 지리
  • 지점 주소
  • 주소 범위
  • 교차로
viewport

뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다.

SearchAddressResultType

다음 중 하나:

  • 지점
  • Street
  • 지리
  • 지점 주소
  • 주소 범위
  • 교차로
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

Search API 응답에 대한 요약 개체입니다.

Name Type Description
fuzzyLevel
  • integer

결과를 제공하는 데 필요한 최대 유사 항목 수준입니다.

geoBias

내부 검색 엔진이 지리 공간적 바이어스를 적용하여 결과의 순위를 향상하는 경우를 나타냅니다. 일부 메서드에서는 사용 가능한 경우 위도 및 lon 매개 변수를 설정하여 영향을 받을 수 있습니다. 다른 경우에는 순전히 내부입니다.

limit
  • integer

반환될 최대 응답 수

numResults
  • integer

응답의 결과 수입니다.

offset
  • integer

전체 결과 집합 내에서 반환된 결과의 시작 오프셋입니다.

query
  • string

이러한 검색 결과를 생성하는 데 사용된 쿼리 매개 변수입니다.

queryTime
  • integer

쿼리를 확인하는 데 소요된 시간(밀리초)입니다.

queryType

반환되는 쿼리 유형: NEARBY 또는 NON_NEAR.

totalResults
  • integer

검색된 총 결과 수입니다.

Summary

일괄 처리 요청에 대한 결과 요약

Name Type Description
successfulRequests
  • integer

일괄 처리에서 성공한 요청 수

totalRequests
  • integer

일괄 처리의 총 요청 수