Search - Post Search Address Batch

検索アドレス Batch API

適用対象: 価格 レベルを参照してください。

Search Address Batch API は、単一の API 呼び出しを使用して、クエリのバッチを Search Address API に送信します。 Search Address Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 10,000 個のクエリをバッチ処理し、API を最大 100 個のクエリと同期できます。

同期バッチ要求の送信

軽量のバッチ要求には、同期 API を使用することをお勧めします。 サービスが要求を受信すると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 この API では、バッチ項目の数は 100 個に制限されています。

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

非同期バッチ要求の送信

非同期 API は、比較的複雑な検索要求の大量の処理に適しています

  • これにより、個別の呼び出しで結果を取得できます (複数のダウンロードが可能です)。
  • 非同期 API は信頼性のために最適化されており、タイムアウトになるとは限りません。
  • この API では、バッチ項目の数は 10,000 個に制限されています。

非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの [場所] フィールドのリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 非同期応答は 14 日間保存されます。 有効期限後に使用した場合、リダイレクト URL は 404 応答を返します。

非同期バッチ要求は実行時間の長い要求であることに注意してください。 一般的な一連の操作を次に示します。

  1. クライアントが検索アドレス バッチPOST要求を Azure Maps に送信する

  2. サーバーは、次のいずれかで応答します。

    HTTP 202 Accepted - バッチ要求が受け入れられた。

    HTTP Error - Batch 要求の処理中にエラーが発生しました。 これは、いずれかの状態コードまたはその他Error400 Bad Request状態コードである可能性があります。

  3. バッチ要求が正常に受け入れられた場合、 Location 応答のヘッダーには、バッチ要求の結果をダウンロードする URL が含まれます。 この状態 URI は次のようになります。

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. クライアントは、 GET 手順 3 で取得した ダウンロード URL で要求を発行して、バッチ結果をダウンロードします。

バッチ要求の POST 本文

検索アドレスクエリを送信するには、要求本文に形式の配列jsonが含まれる要求をbatchItems使用POSTし、ヘッダーを Content-Type .application/json 5 つの 検索アドレス クエリを含むサンプル要求本文を次に示します。

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

バッチ内の 検索アドレス クエリは、プロトコル、ベース URL、パス、api バージョン、サブスクリプション キー のない 部分 URL にすぎません。 サポートされている 検索アドレスURI パラメーターのいずれかを受け入れます。 検索アドレス クエリの文字列値は適切にエスケープする必要があります (例: " 文字は \でエスケープする必要があります) と、URL エンコードも正しく行う必要があります。

非同期 API を使用すると、呼び出し元は最大 10,000 個のクエリをバッチ処理し、API を最大 100 個のクエリと同期でき、バッチには少なくとも 1 つの クエリを含める必要があります。

非同期バッチ結果のダウンロード

非同期バッチの結果をダウンロードするには、バッチ ダウンロード エンドポイントに要求を発行 GET します。 この ダウンロード URL は、バッチ要求が Location 成功した POST ヘッダーから取得でき、次のようになります。

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

バッチ結果をダウンロードするための一般的な一連の操作を次に示します。

  1. クライアントは、GETダウンロード URL を使用して要求を送信します。

  2. サーバーは、次のいずれかで応答します。

    HTTP 202 Accepted - バッチ要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

    HTTP 200 OK - バッチ要求が正常に処理されました。 応答本文には、すべてのバッチ結果が含まれています。

バッチ応答モデル

返されるデータ コンテンツは、非同期要求と同期要求で似ています。 非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。 このバッチ応答には、 summary 元のバッチ要求の一部であることを示す totalRequests コンポーネント、 successfulRequestsつまり正常に実行されたクエリが含まれます。 バッチ応答には、 batchItems バッチ要求内の各クエリに対する応答を含む配列も含まれます。 元 batchItems のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 内の各項目はbatchItems、フィールドをstatusCoderesponse含みます。 各 response 入力 batchItems は、次のいずれかの種類です。

  • SearchAddressResponse - クエリが正常に完了した場合。

  • Error - クエリが失敗した場合。 応答には、この場合は a code と a message が含まれます。

成功した結果と失敗した結果が 1 つのバッチ応答の例を次示します。

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "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/address/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

OK

202 Accepted

非同期要求でのみサポートされます。 要求が受け入れ済み: 要求は処理のために受け入れ済みです。 Location ヘッダーの URL を使用して、結果を再試行またはアクセスしてください。

Headers

  • Location: string
Other Status Codes

予期しないエラーが発生しました。

セキュリティ

AADToken

これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Maps リソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 ユーザー、グループ、またはサービス プリンシパルには、組み込みロールまたは REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成されたカスタム ロールを使用してアクセス権を付与できます。

シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデリングするためのソリューションを提供します。

Notes

  • このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Mapsを示す必要があります。 これは、 Maps 管理 API から取得できます。

これは Authorization URL 、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンから構成されます。 * Azure Maps Web 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 リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、アプリケーションは Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用する有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。 言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。

公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Sample Request

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

{
  "batchItems": [
    {
      "query": "?query=400 Broad St, Seattle, WA 98109&limit=3"
    },
    {
      "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
    },
    {
      "query": "?query=350 5th Ave, New York, NY 10118&limit=1"
    }
  ]
}

Sample Response

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivision": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivision": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivision": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivision": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
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

エントリ ポイントの種類。 値には、 main または minor のいずれかを指定できます。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

GeographicEntityType

Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。

Geometry

結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。

JsonFormat

応答の目的の形式。 サポートされているのは json 形式のみです。

LatLongPairAbbreviated

短い名前 'lat' 'lon' & を使用して緯度と経度として表される場所。

MatchType

逆引きアドレス検索操作の一致の種類。

OperatingHours

POI (ポイント オブ インタレスト) の営業時間。

OperatingHoursTime

日付と時刻を表します

OperatingHoursTimeRange

1 日のオープン時間範囲

PointOfInterest

名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。

PointOfInterestCategorySet

POI カテゴリ

QueryType

返されるクエリの種類: NEARBY または NON_NEAR。

Response

クエリの結果です。 クエリが正常に完了した場合は SearchAddressResponse、それ以外の場合は ErrorResponse。

SearchAddressBatchItem

Search Address Batch サービス呼び出しから返されるアイテム。

SearchAddressBatchProcessResult

このオブジェクトは、検索アドレス バッチ サービスの呼び出しが成功した場合に返されます。

SearchAddressResultItem

Search API 応答の結果オブジェクト。

SearchAddressResultType

つぎのいずれかです。

  • POI
  • Street
  • [地理的な場所]
  • ポイント住所
  • アドレス範囲
  • 交差道路
SearchSummary

Search API 応答の概要オブジェクト。

Summary

バッチ要求の結果の概要

Address

結果のアドレス

Name Type Description
boundingBox

場所の境界ボックス。

buildingNumber
  • string

通りの建物番号。 非推奨の場合は、代わりに streetNumber を使用してください。

country
  • string

国名

countryCode
  • string

国 (注: 国名ではなく、2 文字のコードです)。

countryCodeISO3
  • string

ISO alpha-3 の国コード

countrySecondarySubdivision
  • string

County

countrySubdivision
  • string

都道府県

countrySubdivisionName
  • string

国管理階層の第 1 レベルの完全名。 このフィールドは、countrySubdivision が省略形で表示される場合にのみ表示されます。 米国、カナダ、イギリスでのみサポートされています。

countryTertiarySubdivision
  • string

名前付き領域

crossStreet
  • string

交差している通りの名前。

extendedPostalCode
  • string

拡張郵便番号 (利用可能状況は地域によって異なります)。

freeformAddress
  • string

結果の原産国の書式規則に従って書式設定された住所行、または国の場合は完全な国名。

localName
  • string

管理単位を使用せずに、アドレス指定可能なオブジェクトの数をグループ化する地理的領域または地域の名前を表すアドレス コンポーネント。 このフィールドは、プロパティのビルドに freeformAddress 使用されます。

municipality
  • string

市区町村

municipalitySubdivision
  • string

Sub / Super City

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

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

エントリ ポイントの種類。 値には、 main または minor のいずれかを指定できます。

EntryPointType

エントリ ポイントの種類。 値には、 main または minor のいずれかを指定できます。

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

Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。

Name Type Description
Country
  • string

国名

CountrySecondarySubdivision
  • string

County

CountrySubdivision
  • string

都道府県

CountryTertiarySubdivision
  • string

名前付き領域

Municipality
  • string

市区町村

MunicipalitySubdivision
  • string

Sub / Super City

Neighbourhood
  • string

近所

PostalCodeArea
  • string

郵便番号/郵便番号

Geometry

結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。

Name Type Description
id
  • string

これを geometryId として Get Search Polygon API に渡して、この結果のジオメトリ情報を取得します。

JsonFormat

応答の目的の形式。 サポートされているのは json 形式のみです。

Name Type Description
json
  • string

JavaScript オブジェクト表記データ交換形式

LatLongPairAbbreviated

短い名前 'lat' 'lon' & を使用して緯度と経度として表される場所。

Name Type Description
lat
  • number

Latitude プロパティ

lon
  • number

Longitude プロパティ

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

1 日のオープン時間範囲

Name Type Description
endTime

次の 7 日間の範囲のポイントは、特定の POI が閉じられている場合は範囲の先頭、または範囲の前に閉じられた場合は範囲の先頭です。

startTime

特定の POI が開かれている次の 7 日間の範囲のポイント、または範囲の前に開かれた場合は範囲の先頭。

PointOfInterest

名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。

Name Type Description
brands

ブランド配列。 返される POI のブランド名。

categories
  • string[]

Categories 配列

categorySet

最も具体的な POI カテゴリの一覧

classifications

分類配列

name
  • string

POI プロパティの名前

openingHours

POI (ポイント オブ インタレスト) の営業時間。

phone
  • string

電話番号プロパティ

url
  • string

Web サイトの 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

Search 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

省略可能なセクション。 Get Search Polygon API で使用する参照ジオメトリ ID。

detourTime
  • integer

迂回時間 (秒単位)。 ルートに沿った検索 API の呼び出しに対してのみ返されます。

dist
  • number

結果とジオビアの位置の間の直線距離 (メートル単位)。

entityType

Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。

entryPoints

EntryPoint の配列。 これらは、場所で利用可能な入り口の種類を記述します。 種類は、正面ドアやロビーなどのメインの入り口の "メイン" と、サイド ドアとバック ドア用の "マイナー" です。

id
  • string

Id プロパティ

info
  • string

結果の元のデータ ソースに関する情報。 サポート要求に使用されます。

matchType

一致の種類に関する情報。

つぎのいずれかです。

  • AddressPoint
  • HouseNumberRange
  • Street
poi

名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。

position

短い名前 'lat' 'lon' & を使用して緯度と経度として表される場所。

score
  • number

結果セット内の値。結果間の相対的な一致スコアを示します。 これを使用して、x の値が y の値の 2 倍の場合、結果 x が結果 y と同じ 2 倍の関連性を持つ可能性があることを判断できます。 値はクエリによって異なり、1 つの結果セットの相対値としてのみ使用されます。

type

つぎのいずれかです。

  • POI
  • Street
  • [地理的な場所]
  • ポイント住所
  • アドレス範囲
  • 交差道路
viewport

ビューポートの左上と右下の座標で表される結果をカバーするビューポート。

SearchAddressResultType

つぎのいずれかです。

  • POI
  • 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

内部検索エンジンが地理空間バイアスを適用して結果のランク付けを改善したタイミングを示します。 一部の方法では、lat パラメーターと 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

バッチ内の要求の合計数