Search - Post Search Address Batch Sync

リファレンス

サービス:: Maps

API バージョン:: 1.0

1 つの同期要求でクエリのバッチを Search Fuzzy API に送信するには、を使用します。
Search Address Batch API

この API はPost Search Address Batch sync、単一の同期 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 個に制限されています。

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

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

クライアントは、Search Address Batch POST 要求をAzure Mapsに送信します。

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

サーバーは、次のいずれかの応答を行います。

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

HTTP Error - Batch 要求の処理中にエラーが発生しました。または他Errorの400 Bad Request状態コードを指定できます。
バッチ要求が正常に受け入れられた場合、 Location 応答のヘッダーには、バッチ要求の結果をダウンロードするための URL が含まれます。この状態 URI は次のようになります。

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

クライアントは、 GET 手順 3 で取得した ダウンロード URL に対して要求を発行して、バッチ結果をダウンロードします。

バッチ要求の POST 本文

検索アドレス クエリを送信するには、要求本文に形式のjson配列が含まれておりbatchItems、ヘッダーがに設定される要求をContent-Typeapplication/json使用POSTします。 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 は、成功したLocationPOSTバッチ要求のヘッダーから取得でき、次のようになります。

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

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

クライアントは、ダウンロード URL をGET使用して要求を送信します。
サーバーは、次のいずれかの応答を行います。

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

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

バッチ応答モデル

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

SearchAddressResult - クエリが正常に完了した場合。
Error - クエリが失敗した場合。この場合、応答にはとがmessage含まれますcode。

成功した結果が 2 件、失敗した結果が 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/sync/json?api-version=1.0

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。

要求本文

名前	型	説明
batchItems	BatchRequestItem[]	処理するクエリの一覧。

応答

名前	型	説明
200 OK	SearchAddressBatchProcessResult	OK
Other Status Codes	ErrorResponse	タイムアウト: 要求の完了に、API で定義された最大時間よりも長い時間がかかりました。
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

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

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

注意

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。
Authorization URLは、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、固有の承認 URL とMicrosoft Entra ID構成があります。
Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
Azure Maps Web SDK を使用すると、複数のユースケースに対するアプリケーションの構成ベースのセットアップが可能になります。
Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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 にアクセスすることをお勧めします。

型: apiKey
/: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

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

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

型: apiKey
/: header

例

A Sync Address Geocoding Batch API call containing 5 Address Geocoding API queries

要求のサンプル

HTTP

POST https://atlas.microsoft.com/search/address/batch/sync/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"
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "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",
              "countrySubdivisionCode": "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",
              "countrySubdivisionCode": "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",
              "countrySubdivisionCode": "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",
              "countrySubdivisionCode": "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",
              "countrySubdivisionCode": "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",
              "countrySubdivisionCode": "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
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

状態コード:: 408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

定義

名前	説明
Address	結果のアドレス
AddressRanges	検索結果の番地の両側のアドレス範囲について説明します。アドレス範囲の開始位置と終了位置の座標が含まれます。
BatchRequest	この型は、Batch サービスの要求本文を表します。
BatchRequestItem	Batch 要求オブジェクト
BoundingBox	ビューポートの左上と右下の座標で表される結果をカバーするビューポート。
BoundingBoxCompassNotation	場所の境界ボックス。
Brand	POI に関連付けられているブランド
Classification	返される POI の分類
ClassificationName	分類の名前
DataSources	省略可能なセクション。 Get Search Polygon API で使用する参照 ID。
Entity	境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。
EntryPoint	返される POI のエントリポイント。
EntryPointType	エントリポイントの種類。値には、メインまたはマイナーのいずれかを指定できます。
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	クエリの結果です。クエリが正常に完了した場合は SearchAddressResult、それ以外の場合は ErrorResponse。
SearchAddressBatchItem	Address Batch サービス呼び出しSearchから返されるアイテム。
SearchAddressBatchProcessResult	このオブジェクトは、Address Batch サービス呼び出しの成功Searchから返されます。
SearchAddressResultItem	Search API 応答の結果オブジェクト。
SearchAddressResultType	つぎのいずれかです。 POI Street [地理的な場所] ポイント住所アドレス範囲交差道路
SearchSummary	Search API 応答の Summary オブジェクト。
Summary	バッチ要求の結果の概要

Address

結果のアドレス

名前	型	説明
boundingBox	BoundingBoxCompassNotation	場所の境界ボックス。
buildingNumber	string	通りの建物番号。非推奨です。代わりに streetNumber を使用してください。
country	string	国/地域名
countryCode	string	国 (注: 国/地域名ではなく、2 文字のコードです)。
countryCodeISO3	string	ISO alpha-3 国コード
countrySecondarySubdivision	string	County
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` は都市または町の一般的に知られている名前です。都市または町の一般的に知られている名前の場合は、ではなく `municipality`を使用`localName`します。
municipality	string	市区町村注: `municipality` は、居住区を表します。場所によっては、値が `municipality` 都市または町の一般的に知られている名前とは異なる場合があります。市区町村の一般的に知られている名前の場合は、値の代わりに`municipality`値を`localName`使用することをお勧めします。
municipalitySubdivision	string	サブ/スーパーシティ
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

この型は、Batch サービスの要求本文を表します。

名前	型	説明
batchItems	BatchRequestItem[]	処理するクエリの一覧。

BatchRequestItem

Batch 要求オブジェクト

名前	型	説明
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[]	Names 配列

ClassificationName

分類の名前

名前	型	説明
name	string	Name プロパティ
nameLocale	string	Name Locale プロパティ

DataSources

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

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

Entity

境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。

名前	型	説明
position	string	位置エンティティ

EntryPoint

返される POI のエントリポイント。

名前	型	説明
position	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
type	EntryPointType	エントリポイントの種類。値には、メインまたはマイナーのいずれかを指定できます。

EntryPointType

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

名前	型	説明
main	string
minor	string

ErrorAdditionalInfo

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

GeographicEntityType

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

名前	型	説明
Country	string	国/地域名
CountrySecondarySubdivision	string	County
CountrySubdivision	string	都道府県
CountryTertiarySubdivision	string	名前付き領域
Municipality	string	市区町村
MunicipalitySubdivision	string	サブ/スーパーシティ
Neighbourhood	string	近所
PostalCodeArea	string	郵便番号/郵便番号

Geometry

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

名前	型	説明
id	string	これを geometryId として Get Search Polygon API に渡して、この結果のジオメトリ情報をフェッチします。

JsonFormat

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

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

LatLongPairAbbreviated

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

名前	型	説明
lat	number	Latitude プロパティ
lon	number	Longitude プロパティ

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	時間は POI の現地時刻の 24 時間形式です。指定できる値は 0 ~ 23 です。
minute	integer	分は POI の現地時刻です。指定できる値は 0 ~ 59 です。

OperatingHoursTimeRange

1 日のオープン時間範囲

名前	型	説明
endTime	OperatingHoursTime	特定の POI が閉じられている次の 7 日間の範囲のポイント、または範囲の前に閉じられた場合は範囲の先頭。
startTime	OperatingHoursTime	特定の POI を開くときの次の 7 日間の範囲のポイント、または範囲の前に開かれた場合は範囲の先頭。

PointOfInterest

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

名前	型	説明
brands	Brand[]	ブランド配列。返される POI のブランド名。
categories	string[]	Categories 配列
categorySet	PointOfInterestCategorySet[]	最も具体的な POI カテゴリの一覧
classifications	Classification[]	分類配列
name	string	POI プロパティの名前
openingHours	OperatingHours	POI (目的地) の営業時間。
phone	string	電話番号プロパティ
url	string	Web サイトの URL プロパティ

PointOfInterestCategorySet

POI カテゴリ

名前	型	説明
id	integer	カテゴリ ID。

QueryType

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

名前	型	説明
NEARBY	string	Searchは、定義された半径を持つ特定の緯度と経度を中心に実行されました
NON_NEAR	string	Searchは、特定の緯度と経度に偏らず、半径が定義されていない、グローバルに実行されました

Response

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

名前	型	説明
error	ErrorDetail	error オブジェクト。
results	SearchAddressResultItem[]	SEARCH API の結果の一覧。
summary	SearchSummary	Search API 応答の Summary オブジェクト

SearchAddressBatchItem

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

名前	型	説明
response	Response	クエリの結果です。クエリが正常に完了した場合は SearchAddressResult、それ以外の場合は ErrorResponse。
statusCode	integer	HTTP 要求の状態コード。

SearchAddressBatchProcessResult

このオブジェクトは、Address Batch サービス呼び出しの成功Searchから返されます。

名前	型	説明
batchItems	SearchAddressBatchItem[]	バッチ結果を含む配列。
summary	Summary	バッチ要求の結果の概要

SearchAddressResultItem

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

名前	型	説明
address	Address	結果のアドレス
addressRanges	AddressRanges	検索結果の番地の両側のアドレス範囲について説明します。アドレス範囲の開始位置と終了位置の座標が含まれます。
dataSources	DataSources	省略可能なセクション。 Get Search Polygon API で使用する参照ジオメトリ ID。
detourTime	integer	迂回時間 (秒単位)。 Search Along Route API の呼び出しに対してのみ返されます。
dist	number	結果とジオビアスの位置の間の直線距離 (メートル単位)。
entityType	GeographicEntityType	Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。
entryPoints	EntryPoint[]	EntryPoints の配列。これらは、場所で利用可能な入り口の種類を説明します。種類は、フロントドアやロビーなどのメインの入り口には "メイン"、サイドドアとバックドアの場合は "マイナー" です。
id	string	Id プロパティ
info	string	結果の元のデータソースに関する情報。サポート要求に使用されます。
matchType	MatchType	一致の種類に関する情報。つぎのいずれかです。 AddressPoint HouseNumberRange Street
poi	PointOfInterest	名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。
position	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
score	number	結果セット内の値。結果間の相対的な一致スコアを示します。これを使用して、x の値が y の値の 2 倍の場合、結果 x が結果 y の 2 倍の関連性を持つ可能性があることを判断できます。値はクエリによって異なり、1 つの結果セットの相対値としてのみ使用されます。
type	SearchAddressResultType	つぎのいずれかです。 POI Street [地理的な場所] ポイント住所アドレス範囲交差道路
viewport	BoundingBox	ビューポートの左上と右下の座標で表される結果をカバーするビューポート。

SearchAddressResultType

つぎのいずれかです。

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

名前	型	説明
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

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

名前	型	説明
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	バッチ内の要求の合計数

次の方法で共有