メソッド entities.search

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

HTTP リクエスト

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

クエリ パラメータ

パラメータ名	型	説明
query	string	ナレッジグラフで検索するリテラル文字列。
ids	string	ナレッジグラフで検索するエンティティ ID のリスト。 HTTP リクエストで複数の ID を指定するには、 ...?ids=A&ids=B のような URL
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 キーワード

JSON-LD キーワード（@context など） 、@vocab、 @type、または @id については、このモジュールの 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 のプロパティ拡張機能は次のとおりです。

• detailedDescription
• resultScore