制約に一致するエンティティをナレッジグラフで検索します。
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 |
返されるエンティティを、指定されたタイプのエンティティに制限します。たとえば、「Person」と指定すると(http://schema.org/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 でホストされているボキャブラリが使用され、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
- detailsDescription -> http://schema.googleapis.com/detailedDescription
各タイプとプロパティのドキュメントは、対応する URI で確認できます。
スキーマ拡張機能のリスト
この API で使用されるスキーマ拡張は、外部拡張として http://schema.googleapis.com でホストされています。
Schema.org の type 拡張は次のとおりです。
Schema.org のプロパティ拡張は次のとおりです。