メソッド entities.search

制約に一致するエンティティをナレッジグラフで検索します。

HTTP リクエスト

GET https://kgsearch.googleapis.com/v1/entities:search

クエリパラメータ

パラメータ名	型	説明
`query`	`string`	ナレッジグラフで検索するリテラル文字列。
`ids`	`string`	ナレッジグラフで検索するエンティティ ID のリスト。HTTP リクエストで複数の ID を指定するには、URL でパラメータを繰り返します（例: ...?ids=A&ids=B）。
`languages`	`string`	クエリを実行する言語コードのリスト（ISO 639 で定義）。例: `en`。
`types`	`string`	返されるエンティティを指定されたタイプに制限します。たとえば、http://schema.org/Person で定義されている `Person` を指定して、結果を人物を表すエンティティに制限できます。複数のタイプが指定されている場合、返されるエンティティにはこれらのタイプの 1 つ以上が含まれます。
`indent`	`boolean`	JSON 結果のインデントを有効にします。
`prefix`	`boolean`	エンティティの名前とエイリアスに対する接頭辞（初期部分文字列）の一致を有効にします。たとえば、接頭辞「Jung」は、「Jung」、「Jungle」、「Jung-ho Kang」などのエンティティとエイリアスに一致します。
`limit`	`number`	返されるエンティティの数を制限します。最大値は 500 です。デフォルトは 20 です。上限が高いリクエストは、タイムアウトする可能性が高くなります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

レスポンスメッセージには、JSON-LD 形式で表され、schema.org スキーマ（外部拡張機能が制限されている）と互換性があるエンティティのリストが含まれています。

次の JSON-LD の例は、レスポンス本文の構造を示しています。

{
  "@context": {
    "@vocab": "http://schema.org/",
    "goog": "http://schema.googleapis.com/",
    "resultScore": "goog:resultScore",
    "detailedDescription": "goog:detailedDescription",
    "EntitySearchResult": "goog:EntitySearchResult",
    "kg": "http://g.co/kg"
  },
  "@type": "ItemList",
  "itemListElement": [
    {
      "@type": "EntitySearchResult",
      "result": {
        "@id": "kg:/m/0dl567",
        "name": "Taylor Swift",
        "@type": [
          "Thing",
          "Person"
        ],
        "description": "Singer-songwriter",
        "image": {
          "contentUrl": "https://t1.gstatic.com/images?q=tbn:ANd9GcQmVDAhjhWnN2OWys2ZMO3PGAhupp5tN2LwF_BJmiHgi19hf8Ku",
          "url": "https://en.wikipedia.org/wiki/Taylor_Swift",
          "license": "http://creativecommons.org/licenses/by-sa/2.0"
        },
        "detailedDescription": {
          "articleBody": "Taylor Alison Swift is an American singer-songwriter and actress. Raised in Wyomissing, Pennsylvania, she moved to Nashville, Tennessee, at the age of 14 to pursue a career in country music. ",
          "url": "http://en.wikipedia.org/wiki/Taylor_Swift",
          "license": "https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License"
        },
        "url": "http://taylorswift.com/"
      },
      "resultScore": 4850
    }
  ]
}

レスポンスのフィールド

フィールド名	タイプ	説明
`@id`	`string`	エンティティの正規 URI。
`name`	`string`	エンティティの名前。
`@type`	`array`	エンティティに一致する、サポートされている schema.org タイプのリスト。
`description`	`string`	エンティティの簡単な説明。
`image`	`URL`	エンティティの識別に役立つ画像。
`detailedDescription`	`string`	エンティティの詳細な説明。
`url`	`URL`	エンティティの公式ウェブサイトの URL（ある場合）。
`resultScore`	`number`	エンティティがリクエストの制約にどの程度一致したかを示す指標。

JSON-LD のキーワード

@context、@vocab、@type、@id などの JSON-LD キーワードについては、JSON-LD 仕様を参照してください。

Schema.org の互換性

レスポンスでは、schema.org でホストされているボキャブラリが使用されます。このボキャブラリと互換性のある拡張機能（resultScore など）は制限されています。これらの拡張機能の詳細については、スキーマ拡張機能のリストをご覧ください。

Schema.org の各タイプ（Person など）とプロパティ（name など）には、次の例のように対応する完全な URI があります。

Person -> http://schema.org/Person
Thing -> http://schema.org/Thing
name -> http://schema.org/name
description -> http://schema.org/description

Google スキーマ拡張機能として定義されたタイプとプロパティは、http://schema.googleapis.com で拡張できます。たとえば、

EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
detailedDescription -> http://schema.googleapis.com/detailedDescription

各タイプとプロパティのドキュメントは、対応する URI で確認できます。

スキーマ拡張機能のリスト

この API で使用されるスキーマ拡張機能は、外部拡張機能として http://schema.googleapis.com でホストされています。

Schema.org の type 拡張機能は次のとおりです。

EntitySearchResult

Schema.org のプロパティの拡張機能は次のとおりです。