Search - Get Search POI Category Tree

リファレンス

Service:: Maps

API Version:: 1.0

サポートされているポイントオブインタレスト (POI) カテゴリとサブカテゴリの一覧を取得するには、を使用します。

Get Search POI Category Tree API は HTTP GET 要求であり、サポートされているポイントオブインタレスト (POI) カテゴリとサブカテゴリの完全な一覧とその翻訳とシノニムを提供します。返されたコンテンツを使用すると、get Search POI などの他のSearch サービス API を使用して、より意味のある結果を提供できます。

GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0

With optional parameters:

GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0&language={language}

URI パラメーター

名前 / 必須型説明

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。
language	query		string	検索結果を返す言語。 NGT と NGT-Latn を除き、サポートされている IETF 言語タグのいずれかである必要があります。言語タグでは大文字と小文字が区別されません。指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語 (英語) が使用されます。詳細については、「サポートされている言語」を参照してください。

format

path

True

JsonFormat

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

api-version

query

True

string

Azure Maps API のバージョン番号。

language

query

string

検索結果を返す言語。 NGT と NGT-Latn を除き、サポートされている IETF 言語タグのいずれかである必要があります。言語タグでは大文字と小文字が区別されません。指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語 (英語) が使用されます。

詳細については、「サポートされている言語」を参照してください。

要求ヘッダー

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

応答

名前	型	説明
200 OK	PointOfInterestCategoryTreeResult	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

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 プラットフォームの概要」を参照してください。

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

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure 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

例

Get the POI Category Tree (only partial response shown below)

Sample Request

HTTP

GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0

Sample Response

Status code:: 200

{
  "poiCategories": [
    {
      "id": 7320,
      "name": "Sports Center",
      "childCategoryIds": [
        7320002,
        7320003,
        7320005
      ],
      "synonyms": [
        "Gym",
        "Indoors Sports",
        "Sports Centre"
      ]
    },
    {
      "id": 7374,
      "name": "Stadium",
      "childCategoryIds": [
        7374002,
        7374009,
        7374012,
        7374003,
        7374010,
        7374005,
        7374008,
        7374011,
        7374006,
        7374014,
        7374013,
        7374007,
        7374004
      ],
      "synonyms": [
        "Arena",
        "Gymnasium",
        "Sports Ground",
        "Sports Stadium"
      ]
    },
    {
      "id": 7315,
      "name": "Restaurant",
      "childCategoryIds": [
        7315081,
        7315002,
        7315082,
        7315003,
        7315083,
        7315084,
        7315085,
        7315062,
        7315086,
        7315004,
        7315146,
        7315005,
        7315087,
        7315006,
        7315007,
        7315088,
        7315089,
        7315072,
        7315008,
        7315142,
        7315090,
        7315091,
        7315147,
        7315009,
        7315092,
        7315010,
        7315011,
        7315070,
        7315093,
        7315012,
        7315094,
        7315095,
        7315063,
        7315013,
        7315096,
        7315097,
        7315068,
        7315098,
        7315099,
        7315057,
        7315079,
        7315014,
        7315100,
        7315101,
        7315132,
        7315102,
        7315133,
        7315015,
        7315016,
        7315104,
        7315134,
        7315017,
        7315071,
        7315018,
        7315019,
        7315020,
        7315054,
        7315069,
        7315021,
        7315058,
        7315052,
        7315022,
        7315078,
        7315023,
        7315024,
        7315073,
        7315105,
        7315065,
        7315106,
        7315025,
        7315066,
        7315026,
        7315027,
        7315028,
        7315067,
        7315029,
        7315030,
        7315107,
        7315135,
        7315108,
        7315031,
        7315109,
        7315032,
        7315033,
        7315034,
        7315110,
        7315074,
        7315136,
        7315111,
        7315112,
        7315075,
        7315035,
        7315127,
        7315061,
        7315036,
        7315037,
        7315129,
        7315038,
        7315130,
        7315039,
        7315041,
        7315131,
        7315040,
        7315143,
        7315042,
        7315113,
        7315114,
        7315115,
        7315043,
        7315053,
        7315055,
        7315056,
        7315116,
        7315117,
        7315080,
        7315139,
        7315064,
        7315140,
        7315044,
        7315045,
        7315118,
        7315046,
        7315148,
        7315119,
        7315047,
        7315120,
        7315059,
        7315145,
        7315076,
        7315121,
        7315048,
        7315122,
        7315123,
        7315049,
        7315124,
        7315050,
        7315125,
        7315051,
        7315126,
        7315060,
        7315149
      ],
      "synonyms": [
        "Dining",
        "Eatery",
        "Eating House",
        "Eating Place"
      ]
    }
  ]
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
PointOfInterestCategory	POI カテゴリの結果
PointOfInterestCategoryTreeResult	このオブジェクトは、POI カテゴリツリー呼び出しが成功した場合に返されます

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

JsonFormat

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

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

PointOfInterestCategory

POI カテゴリの結果

名前	型	説明
childCategoryIds	integer[]	子カテゴリ ID の配列
id	integer	カテゴリの一意の ID。 ID を使用すると、get Search POI など、他のSearch サービス API を使用して検索結果を特定のカテゴリに制限できます。
name	string	カテゴリの名前。
synonyms	string[]	カテゴリの別名の配列

PointOfInterestCategoryTreeResult

このオブジェクトは、POI カテゴリツリー呼び出しが成功した場合に返されます

名前	型	説明
poiCategories	PointOfInterestCategory[]	Categories 配列

Share via

Search - Get Search POI Category Tree

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

Scopes

subscription-key

SAS Token

例

Get the POI Category Tree (only partial response shown below)

Sample Request

Sample Response

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

PointOfInterestCategory

PointOfInterestCategoryTreeResult

その他のリソース