Search - Get Search Fuzzy Batch
を使用して、1 つの非同期要求でクエリのバッチを Search Fuzzy API に送信します。
Get Search Fuzzy Batch
API は、1 つの非同期 API 呼び出しでクエリのバッチを Search Fuzzy API に送信する HTTP GET
要求です。 あいまいバッチ API Search呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 10,000 個のクエリをバッチ処理し、最大 100 個のクエリを同期できます。
同期バッチ要求を送信する
軽量バッチ要求には、同期 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 個に制限されています。
非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドにリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 非同期応答は 14 日間保存されます。 リダイレクト URL は、有効期限後に使用した場合、404 応答を返します。
非同期バッチ要求は実行時間の長い操作であることに注意してください。 一般的な一連の操作を次に示します。
- クライアントは、Searchあいまいバッチ
POST
要求をAzure Mapsに送信します。
POST https://atlas.microsoft.com/search/fuzzy/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/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- クライアントは、
GET
手順 3 で取得した ダウンロード URL で要求を発行して、バッチ結果をダウンロードします。
バッチ要求の 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}
バッチ結果をダウンロードするための一般的な一連の操作を次に示します。
クライアントは、ダウンロード URL を
GET
使用して要求を送信します。サーバーは、次のいずれかで応答します。
HTTP
202 Accepted
- バッチ要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。HTTP
200 OK
- バッチ要求が正常に処理されました。 応答本文には、すべてのバッチ結果が含まれています。
バッチ応答モデル
返されるデータ コンテンツは、非同期要求と同期要求に似ています。 非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。 このバッチ応答には、 summary
元のバッチ要求の一部であった を示す totalRequests
コンポーネント、 successfulRequests
つまり正常に実行されたクエリが含まれます。 バッチ応答には、 batchItems
バッチ要求内のすべてのクエリに対する応答を含む配列も含まれます。
batchItems
には、元のクエリがバッチ要求で送信された順序とまったく同じ順序で結果が含まれます。 内のbatchItems
各項目には と response
フィールドがstatusCode
含まれています。 の各 response
は batchItems
、次のいずれかの種類です。
SearchAddressResult
- クエリが正常に完了した場合。Error
- クエリが失敗した場合。 この場合、応答には と がmessage
含まれますcode
。
成功した結果 が 2 つ 、 失敗した 結果が 1 件のバッチ応答の例を次に示します。
{
"summary": {
"successfulRequests": 2,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response":
{
"summary": {
"query": "atm"
},
"results": [
{
"type": "POI",
"poi": {
"name": "ATM at Wells Fargo"
},
"address": {
"country": "United States Of America",
"freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
}
}
]
}
},
{
"statusCode": 200,
"response":
{
"summary": {
"query": "statue of liberty"
},
"results": [
{
"type": "POI",
"poi": {
"name": "Statue of Liberty"
},
"address": {
"country": "United States Of America",
"freeformAddress": "New York, NY 10004"
}
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
GET https://atlas.microsoft.com/search/fuzzy/batch/{format}?api-version=1.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
format
|
path | True |
string |
操作のクエリを実行するためのバッチ ID。 |
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セキュリティを使用するには、次の記事を参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
202 Accepted |
非同期要求でのみサポートされます。 [Request Accepted]\(要求を受け入れた\): 要求は処理のために受け入れ済みです。 Location ヘッダーの URL を使用して、再試行するか、結果にアクセスしてください。 ヘッダー Location: string |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、ユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の 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 Search Fuzzy Batch API GET call containing 5 Search Fuzzy API queries
要求のサンプル
GET https://atlas.microsoft.com/search/fuzzy/batch/11111111-2222-3333-4444-555555555555?api-version=1.0
応答のサンプル
{
"batchItems": [
{
"statusCode": 200,
"response": {
"summary": {
"query": "atm",
"queryType": "NON_NEAR",
"queryTime": 5,
"numResults": 5,
"offset": 0,
"totalResults": 262,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/3656546",
"score": 2.671,
"dist": 1336.1815386162032,
"info": "search:ta:840539002005905-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "14808",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63229,
"lon": -122.14232
},
"viewport": {
"topLeftPoint": {
"lat": 47.63319,
"lon": -122.14365
},
"btmRightPoint": {
"lat": 47.63139,
"lon": -122.14099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63154,
"lon": -122.1423
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/8673325",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840539002022072-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "Northeast 24Th Street",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736315",
"score": 2.671,
"dist": 864.7591776519859,
"info": "search:ta:840539002187855-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15521",
"streetName": "Bel Red Rd",
"municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
"municipality": "Redmond, Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525501",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63259,
"lon": -122.1328
},
"viewport": {
"topLeftPoint": {
"lat": 47.63349,
"lon": -122.13413
},
"btmRightPoint": {
"lat": 47.63169,
"lon": -122.13147
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63255,
"lon": -122.13275
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/3656412",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001998867-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736876",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001396789-US",
"poi": {
"name": "US Bank ATM",
"phone": "+(1)-(800)-8722657",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"url": "www.usbank.com",
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "statue of liberty",
"queryType": "NON_NEAR",
"queryTime": 37,
"numResults": 2,
"offset": 0,
"totalResults": 18,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9189660",
"score": 6.942,
"info": "search:ta:840369001174316-US",
"poi": {
"name": "Statue of Liberty",
"categorySet": [
{
"id": 7376003
}
],
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "monument"
},
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"municipalitySubdivision": "New York",
"municipality": "New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "New York, NY 10004",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.68955,
"lon": -74.04483
},
"viewport": {
"topLeftPoint": {
"lat": 40.69045,
"lon": -74.04602
},
"btmRightPoint": {
"lat": 40.68865,
"lon": -74.04364
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.69001,
"lon": -74.04683
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/3264566",
"score": 6.942,
"info": "search:ta:840019000670588-US",
"poi": {
"name": "Statue of Liberty",
"phone": "+(1)-(205)-9700251",
"categorySet": [
{
"id": 7376003
}
],
"url": "www.1bsa.org",
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"streetNumber": "516",
"streetName": "Liberty Pkwy",
"municipalitySubdivision": "Vestavia Hills",
"municipality": "Vestavia Hills, Birmingham",
"countrySecondarySubdivision": "Jefferson",
"countryTertiarySubdivision": "Leeds",
"countrySubdivisionCode": "AL",
"postalCode": "35242",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
"localName": "Vestavia Hills",
"countrySubdivisionName": "Alabama"
},
"position": {
"lat": 33.48234,
"lon": -86.70719
},
"viewport": {
"topLeftPoint": {
"lat": 33.48324,
"lon": -86.70827
},
"btmRightPoint": {
"lat": 33.48144,
"lon": -86.70611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 33.48129,
"lon": -86.7065
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "starbucks",
"queryType": "NON_NEAR",
"queryTime": 35,
"numResults": 10,
"offset": 0,
"totalResults": 17,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/153678",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840531000006554-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8695816",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152316",
"score": 2.67,
"dist": 2315.294397491255,
"info": "search:ta:840539000484552-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-6436471",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15097",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15600",
"streetName": "NE 8th St",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98008",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61896,
"lon": -122.12945
},
"viewport": {
"topLeftPoint": {
"lat": 47.61986,
"lon": -122.13078
},
"btmRightPoint": {
"lat": 47.61806,
"lon": -122.12812
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.619,
"lon": -122.12945
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167545",
"score": 2.67,
"dist": 1979.2222952267998,
"info": "search:ta:840539001950429-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-7470690",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1350",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62212,
"lon": -122.13179
},
"viewport": {
"topLeftPoint": {
"lat": 47.62302,
"lon": -122.13312
},
"btmRightPoint": {
"lat": 47.62122,
"lon": -122.13046
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62213,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168519",
"score": 2.67,
"dist": 2490.3337046455963,
"info": "search:ta:840539001015090-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-4556500",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "https://www.starbucks.com/store-locator/store/15901",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1645",
"streetName": "140th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98005",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62626,
"lon": -122.15487
},
"viewport": {
"topLeftPoint": {
"lat": 47.62716,
"lon": -122.1562
},
"btmRightPoint": {
"lat": 47.62536,
"lon": -122.15354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62645,
"lon": -122.15446
}
},
{
"type": "minor",
"position": {
"lat": 47.62579,
"lon": -122.15377
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152428",
"score": 2.668,
"dist": 3529.7080738812224,
"info": "search:ta:840539001033722-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-3789496",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "180",
"streetName": "148th Ave SE",
"municipalitySubdivision": "West Lake Hills, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60901,
"lon": -122.14
},
"viewport": {
"topLeftPoint": {
"lat": 47.60991,
"lon": -122.14133
},
"btmRightPoint": {
"lat": 47.60811,
"lon": -122.13867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.60901,
"lon": -122.14008
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167147",
"score": 2.668,
"dist": 3479.393294615887,
"info": "search:ta:840539000326896-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8619198",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7425",
"streetName": "166th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980526288",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67055,
"lon": -122.12001
},
"viewport": {
"topLeftPoint": {
"lat": 47.67145,
"lon": -122.12135
},
"btmRightPoint": {
"lat": 47.66965,
"lon": -122.11867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67069,
"lon": -122.11889
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153695",
"score": 2.667,
"dist": 3622.441074618729,
"info": "search:ta:840531000006551-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8822881",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15022",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7625",
"streetName": "170th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980520910",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67086,
"lon": -122.11392
},
"viewport": {
"topLeftPoint": {
"lat": 47.67176,
"lon": -122.11526
},
"btmRightPoint": {
"lat": 47.66996,
"lon": -122.11258
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67073,
"lon": -122.1135
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167420",
"score": 2.667,
"dist": 3818.293513029088,
"info": "search:ta:840539000640782-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8853323",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "17246",
"streetName": "Redmond Way",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980524403",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67174,
"lon": -122.10976
},
"viewport": {
"topLeftPoint": {
"lat": 47.67264,
"lon": -122.1111
},
"btmRightPoint": {
"lat": 47.67084,
"lon": -122.10842
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6706,
"lon": -122.11026
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153686",
"score": 2.666,
"dist": 4009.922205147074,
"info": "search:ta:840531000006548-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8859590",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15738",
"streetName": "Redmond Way Pad 3 Redmond Center",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980523873",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67583,
"lon": -122.12877
},
"viewport": {
"topLeftPoint": {
"lat": 47.67673,
"lon": -122.13011
},
"btmRightPoint": {
"lat": 47.67493,
"lon": -122.12743
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.67456,
"lon": -122.12887
}
},
{
"type": "main",
"position": {
"lat": 47.67668,
"lon": -122.12829
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168511",
"score": 2.666,
"dist": 3987.80992387863,
"info": "search:ta:840531000006669-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8818265",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "6617",
"streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
"municipalitySubdivision": "Kirkland, Bridle Trails",
"municipality": "Kirkland",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98033",
"extendedPostalCode": "980338234",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
"localName": "Kirkland",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66514,
"lon": -122.16599
},
"viewport": {
"topLeftPoint": {
"lat": 47.66604,
"lon": -122.16733
},
"btmRightPoint": {
"lat": 47.66424,
"lon": -122.16465
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.666,
"lon": -122.16669
}
},
{
"type": "minor",
"position": {
"lat": 47.66553,
"lon": -122.16405
}
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 3,
"totalRequests": 3
}
}
定義
名前 | 説明 |
---|---|
Address |
結果のアドレス |
Address |
検索結果の番地の両側のアドレス範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。 |
Bounding |
ビューポートの左上と右下の座標で表される結果をカバーするビューポート。 |
Bounding |
場所の境界ボックス。 |
Brand |
POI に関連付けられているブランド |
Classification |
返される POI の分類 |
Classification |
分類の名前 |
Data |
省略可能なセクション。 Get Search Polygon API で使用する参照 ID。 |
Entity |
境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。 |
Entry |
返される POI のエントリ ポイント。 |
Entry |
エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Geographic |
Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。 |
Geometry |
結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。 |
Lat |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
Match |
逆アドレス検索操作の一致の種類。 |
Operating |
POI (目的地) の営業時間。 |
Operating |
日付と時刻を表します |
Operating |
1 日のオープン時間範囲 |
Point |
名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。 |
Point |
POI カテゴリ |
Query |
返されるクエリの種類: NEARBY または NON_NEAR。 |
Response |
クエリの結果です。 クエリが正常に完了した場合は SearchAddressResult、それ以外の場合は ErrorResponse。 |
Search |
Address Batch サービス呼び出しSearchから返されるアイテム。 |
Search |
このオブジェクトは、Address Batch サービス呼び出しの成功Searchから返されます。 |
Search |
Search API 応答の Result オブジェクト。 |
Search |
つぎのいずれかです。
|
Search |
Search API 応答の Summary オブジェクト。 |
Summary |
バッチ要求の結果の概要 |
Address
結果のアドレス
名前 | 型 | 説明 |
---|---|---|
boundingBox |
場所の境界ボックス。 |
|
buildingNumber |
string |
通りの建物番号。 非推奨です。代わりに streetNumber を使用してください。 |
country |
string |
国/地域名 |
countryCode |
string |
国 (注: 国/地域名ではなく、2 文字のコードです)。 |
countryCodeISO3 |
string |
ISO alpha-3 国コード |
countrySecondarySubdivision |
string |
County |
countrySubdivision |
string |
都道府県 |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
国/地域管理階層の最初のレベルの完全名。 このフィールドは、countrySubdivision が省略形で表示される場合にのみ表示されます。 米国、カナダ、英国でのみサポートされています。 |
countryTertiarySubdivision |
string |
名前付き領域 |
crossStreet |
string |
交差している通りの名前。 |
extendedPostalCode |
string |
拡張郵便番号 (利用可能期間は地域によって異なります)。 |
freeformAddress |
string |
結果の元の国/地域の書式設定規則に従って書式設定された住所行、または国/地域の場合は完全な国/地域名。 |
localName |
string |
管理単位でなくても、アドレス指定の目的で複数のアドレス指定可能オブジェクトをグループ化する地理的領域または地域の名前を表すアドレス コンポーネント。 このフィールドは、 プロパティをビルドするために使用されます |
municipality |
string |
市区町村 |
municipalitySubdivision |
string |
サブ/スーパーシティ |
neighbourhood |
string |
近隣は、都市または町内の地理的にローカライズされた地域であり、住民間の独特の特徴と社会的相互作用があります。 |
postalCode |
string |
郵便番号/郵便番号 |
routeNumbers |
string[] |
道路を明確に識別するために使用されるコード |
street |
string |
通りの名前。 非推奨です。代わりに streetName を使用してください。 |
streetName |
string |
通りの名前。 |
streetNameAndNumber |
string |
番地の名前と番号。 |
streetNumber |
string |
通りの建物番号。 |
AddressRanges
検索結果の番地の両側のアドレス範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。
名前 | 型 | 説明 |
---|---|---|
from |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
rangeLeft |
string |
通りの左側の住所範囲。 |
rangeRight |
string |
通りの右側の住所範囲。 |
to |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
BoundingBox
ビューポートの左上と右下の座標で表される結果をカバーするビューポート。
名前 | 型 | 説明 |
---|---|---|
btmRightPoint |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
topLeftPoint |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
BoundingBoxCompassNotation
場所の境界ボックス。
名前 | 型 | 説明 |
---|---|---|
entity |
境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。 |
|
northEast |
string |
北東緯度、境界ボックスの経度座標 (コンマ区切り浮動小数点数) |
southWest |
string |
南西緯度、境界ボックスの経度座標 (コンマ区切り浮動小数点数) |
Brand
POI に関連付けられているブランド
名前 | 型 | 説明 |
---|---|---|
name |
string |
ブランドの名前 |
Classification
返される POI の分類
名前 | 型 | 説明 |
---|---|---|
code |
string |
code プロパティ |
names |
Names 配列 |
ClassificationName
分類の名前
名前 | 型 | 説明 |
---|---|---|
name |
string |
Name プロパティ |
nameLocale |
string |
Name Locale プロパティ |
DataSources
省略可能なセクション。 Get Search Polygon API で使用する参照 ID。
名前 | 型 | 説明 |
---|---|---|
geometry |
結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。 |
Entity
境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。
名前 | 型 | 説明 |
---|---|---|
position |
string |
位置エンティティ |
EntryPoint
返される POI のエントリ ポイント。
名前 | 型 | 説明 |
---|---|---|
position |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
type |
エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。 |
EntryPointType
エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。
名前 | 型 | 説明 |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
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 に渡して、この結果のジオメトリ情報をフェッチします。 |
LatLongPairAbbreviated
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
名前 | 型 | 説明 |
---|---|---|
lat |
number |
Latitude プロパティ |
lon |
number |
Longitude プロパティ |
MatchType
逆アドレス検索操作の一致の種類。
名前 | 型 | 説明 |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
POI (目的地) の営業時間。
名前 | 型 | 説明 |
---|---|---|
mode |
string |
要求で使用される値: none または "nextSevenDays" |
timeRanges |
次の 7 日間の時間範囲の一覧 |
OperatingHoursTime
日付と時刻を表します
名前 | 型 | 説明 |
---|---|---|
date |
string |
POI タイム ゾーンの現在のカレンダー日付 (例: "2019-02-07") を表します。 |
hour |
integer |
時間は POI の現地時刻の 24 時間形式です。指定できる値は 0 ~ 23 です。 |
minute |
integer |
分は POI の現地時刻です。指定できる値は 0 ~ 59 です。 |
OperatingHoursTimeRange
1 日のオープン時間範囲
名前 | 型 | 説明 |
---|---|---|
endTime |
特定の POI が閉じられている次の 7 日間の範囲のポイント、または範囲の前に閉じられた場合は範囲の先頭。 |
|
startTime |
特定の POI を開くときの次の 7 日間の範囲のポイント、または範囲の前に開かれた場合は範囲の先頭。 |
PointOfInterest
名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。
名前 | 型 | 説明 |
---|---|---|
brands |
Brand[] |
ブランド配列。 返される POI のブランド名。 |
categories |
string[] |
Categories 配列 |
categorySet |
最も具体的な POI カテゴリの一覧 |
|
classifications |
分類配列 |
|
name |
string |
POI プロパティの名前 |
openingHours |
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 |
error オブジェクト。 |
|
results |
Search API の結果の一覧。 |
|
summary |
Search API 応答の Summary オブジェクト |
SearchAddressBatchItem
Address Batch サービス呼び出しSearchから返されるアイテム。
名前 | 型 | 説明 |
---|---|---|
response |
クエリの結果です。 クエリが正常に完了した場合は SearchAddressResult、それ以外の場合は ErrorResponse。 |
|
statusCode |
integer |
HTTP 要求の状態コード。 |
SearchAddressBatchProcessResult
このオブジェクトは、Address Batch サービス呼び出しの成功Searchから返されます。
名前 | 型 | 説明 |
---|---|---|
batchItems |
バッチ結果を含む配列。 |
|
summary |
バッチ要求の結果の概要 |
SearchAddressResultItem
Search API 応答の Result オブジェクト。
名前 | 型 | 説明 |
---|---|---|
address |
結果のアドレス |
|
addressRanges |
検索結果の通りの両側のアドレス範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。 |
|
dataSources |
省略可能なセクション。 Get Search Polygon API で使用する参照ジオメトリ ID。 |
|
detourTime |
integer |
迂回時間 (秒単位)。 Search Along Route API の呼び出しに対してのみ返されます。 |
dist |
number |
結果とジオビアスの位置間の直線距離 (メートル単位)。 |
entityType |
Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。 |
|
entryPoints |
EntryPoints の配列。 これらは、場所で利用可能な入り口の種類を説明します。 種類は、フロント ドアやロビーなどのメインの入り口には "メイン"、サイド ドアとバック ドアの場合は "マイナー" です。 |
|
id |
string |
Id プロパティ |
info |
string |
Result の元のデータ ソースに関する情報。 サポート要求に使用されます。 |
matchType |
一致の種類に関する情報。 つぎのいずれかです。
|
|
poi |
名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。 |
|
position |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
score |
number |
結果セット内の値。結果間の相対的な一致スコアを示します。 これを使用すると、x の値が y の値の 2 倍の場合、結果 x が結果 y と同じ 2 倍の関連性を持つ可能性が高いと判断できます。 値はクエリによって異なり、1 つの結果セットの相対値としてのみ使用されます。 |
type |
つぎのいずれかです。
|
|
viewport |
ビューポートの左上と右下の座標で表される結果をカバーするビューポート。 |
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 |
内部検索エンジンが地理空間バイアスを適用して結果のランク付けが向上したことを示します。 一部のメソッドでは、利用可能な場合に lat パラメーターと lon パラメーターを設定すると、これが影響を受ける可能性があります。 それ以外の場合は、純粋に内部的です。 |
|
limit |
integer |
返される応答の最大数 |
numResults |
integer |
応答の結果の数。 |
offset |
integer |
完全な結果セット内で返される結果の開始オフセット。 |
query |
string |
これらの検索結果の生成に使用されたクエリ パラメーター。 |
queryTime |
integer |
クエリの解決に費やされた時間 (ミリ秒単位)。 |
queryType |
返されるクエリの種類: NEARBY または NON_NEAR。 |
|
totalResults |
integer |
検出された結果の合計数。 |
Summary
バッチ要求の結果の概要
名前 | 型 | 説明 |
---|---|---|
successfulRequests |
integer |
バッチ内の成功した要求の数 |
totalRequests |
integer |
バッチ内の要求の合計数 |