Yöntem varlıklar.search

Sınırlamalarla eşleşen öğeleri Bilgi Grafiği'nde arar.

HTTP isteği

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

Sorgu parametreleri

Parametre adı	Tür	Açıklama
query	string	Bilgi Grafiği'nde aranacak bir dize.
ids	string	Bilgi Grafiği'nde aranacak varlık kimliklerinin listesi. HTTP isteğinde birden fazla kimlik belirtmek için ...?ids=A&ids=B gibi URL
languages	string	Sorgunun çalıştırılacağı dil kodlarının listesi (ISO 639'da tanımlanmıştır). Örneğin "en".
types	string	Döndürülen varlıkları, belirtilen türlerdeki varlıklarla kısıtlar. Örneğin, "Person" (Kişi) belirtebilirsiniz (http://schema.org/Person'de tanımlandığı gibi) seçeneğini belirleyin. Birden fazla tür belirtilirse döndürülen varlıklar bu türlerden birini veya daha fazlasını içerir.
indent	boolean	JSON sonuçlarının girintilenmesini etkinleştirir.
prefix	boolean	Ön ekin (ilk alt dize) adlar ve takma adlarla eşleşmesini etkinleştirir varlıklarından oluşur. Örneğin, "Jung" öneki ise şunun gibi varlıklarla ve takma adlarla eşleşir: "Jung", "Jungle" ve "Jung-ho Kang" olarak.
limit	number	Döndürülecek varlık sayısını sınırlar. Maksimum değer 500'dür. Varsayılan değer 20'dir. Yüksek sınırlara sahip isteklerin zaman aşımına uğrama olasılığı daha yüksektir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Bir yanıt iletisi, aşağıdaki birimde sunulan öğelerin listesini içerir: JSON-LD biçiminde ve schema.org şemaları (sınırlı harici uzantılar ile).

Aşağıdaki JSON-LD örneğinde, yanıt gövdesinin nasıl yapılandırıldığı gösterilmektedir:

{
  "@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
    }
  ]
}

Yanıt alanları

Alan adı	Tür	Açıklama
@id	string	Varlığın standart URI'si.
name	string	Tüzel kişinin adı.
@type	array	Öğeyle eşleşen, desteklenen schema.org türlerinin listesi.
description	string	Varlığın kısa bir açıklamasıdır.
image	URL	Varlığı tanımlamaya yardımcı olacak bir resim.
detailedDescription	string	Varlığın ayrıntılı açıklamasıdır.
url	URL	Tüzel kişinin resmi web sitesi URL'si (varsa).
resultScore	number	Varlığın, istek sınırlamalarıyla ne kadar iyi eşleştiğine dair bir gösterge.

Not: Resim URL'leri, seçtiğiniz resim URL'lerini emin olun. Google API'leri aracılığıyla edindiğiniz tüm içeriklerde olduğu gibi, uygun olmasını sağlamakla yükümlüdür. hukuki yaptırımları.

JSON-LD anahtar kelimeleri

@context gibi JSON-LD anahtar kelimeleri için , @vocab, @type veya @id daha fazla bilgi için JSON-LD spesifikasyonu.

Schema.org uyumluluğu

Yanıt, schema.org, (örneğin, örnek, resultScore). Bu uzantılarla ilgili daha fazla bilgi için Şema uzantılarının listesi.

Schema.org türlerinin (ör. Person) ve özelliklerinin (ör. name), aşağıdaki örneklerde olduğu gibi karşılık gelen bir tam URI vardır:

• Kişi -> http://schema.org/Person

• Konu -> http://schema.org/Thing

• ad -> http://schema.org/name

• açıklama -> http://schema.org/description

Google şema uzantıları olarak tanımlanan türler ve özellikler http://schema.googleapis.com ile genişletildi. Örneğin,

• EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
• ayrıntılıAçıklama -> http://schema.googleapis.com/detailedDescription

Her tür ve özellik için gereken belgeleri şu adreste bulabilirsiniz: URI'yı kullanabilirsiniz.

Şema uzantılarının listesi

Bu API'de kullanılan şema uzantıları şu konumda barındırılır: http://schema.googleapis.com harici uzantılar olarak kullanın.

Schema.org'un type uzantısı:

• EntitySearchResult

Schema.org mülk uzantıları:

• detailedDescription
• resultScore