メソッドエンティティ.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	返されるエンティティを、指定された型のものに限定します。たとえば、「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	エンティティがリクエストの制約にどの程度合致しているかを示す指標。

注: イメージ URL は、正しいエンティティが選択されていることを確認するのに役立ちます。Google API で取得するすべてのコンテンツと同様に、画像の使用も適用される法律を遵守する必要があります。

JSON-LD キーワード

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

Schema.org の互換性

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

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

• ユーザー -> http://schema.org/Person

• 項目 -> http://schema.org/Thing

• 名前 -> http://schema.org/name

• 説明 -> http://schema.org/description

Google スキーマ拡張機能として定義されるタイプとプロパティは、http://schema.googleapis.com で展開できます。次に例を示します。

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

各タイプとプロパティに関するドキュメントは、対応する URI で参照できます。

スキーマ拡張のリスト

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

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

• EntitySearchResult

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

• detailedDescription
• resultScore