Yöntem varlıklar.search

Kısıtlamalarla eşleşen öğeler için Bilgi Grafiği 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 düz dize.
ids	string	Bilgi Grafiği'nde aranacak varlık kimliklerinin listesi. HTTP isteğinde birden çok kimlik belirtmek için URL'deki parametreyi ...?ids=A&ids=B bölümünde olduğu gibi tekrarlayın.
languages	string	Sorgunun birlikte çalıştırılacağı dil kodlarının (ISO 639'da tanımlanır) listesi (ör. "en").
types	string	Döndürülen varlıkları, belirtilen türlerle kısıtlar. Örneğin, sonuçları kişileri temsil eden varlıklarla kısıtlamak için "Person" (http://schema.org/Person adresinde tanımlandığı gibi) belirtebilirsiniz. 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 girintilendirilmesini etkinleştirir.
prefix	boolean	Varlıkların ad ve takma adlarıyla ön ekin (ilk alt dize) eşleşmesini etkinleştirir. Örneğin, "Jung" ön eki "Jung", "Jungle" ve "Jung-ho Kang" gibi varlıklar ve takma adlarla eşleşir.
limit	number	Döndürülecek varlıkların 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

Yanıt mesajı, JSON-LD biçiminde sunulan ve schema.org şemalarıyla uyumlu (sınırlı harici uzantılar ile) bir varlık listesi içerir.

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ık için standart URI.
name	string	Varlığın adı.
@type	array	Varlıkla eşleşen, desteklenen schema.org türlerinin listesi.
description	string	Varlığın kısa bir açıklaması.
image	URL	Varlığı tanımlamaya yardımcı olacak bir resim.
detailedDescription	string	Varlığın ayrıntılı açıklamasıdır.
url	URL	Varsa tüzel kişinin resmi web sitesi URL'si.
resultScore	number	Varlığın istek kısıtlamalarıyla ne kadar iyi eşleştiğini gösteren bir gösterge.

Not: Resim URL'leri, doğru varlığı seçtiğinizi onaylamanıza yardımcı olmak için sağlanır. Google API'leri üzerinden elde ettiğiniz tüm içeriklerde olduğu gibi, resimleri kullanımınızın geçerli yasalara uygun olmasını sağlamak sizin sorumluluğunuzdadır.

JSON-LD anahtar kelimeleri

@context, @vocab, @type veya @id gibi JSON-LD anahtar kelimeler için JSON-LD spesifikasyonuna bakın.

Schema.org uyumluluğu

Yanıt, schema.org sözlüğüyle uyumlu olan sınırlı uzantılarla (örneğin, resultScore) schema.org adresinde barındırılan sözlüğü kullanır. Bu uzantılar hakkında daha fazla bilgi için Şema uzantılarının listesi bölümüne bakın.

Schema.org türlerinin (Person gibi) ve mülklerinin (ör. name) her biri için aşağıdaki örneklerde olduğu gibi karşılık gelen bir tam URI vardır:

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

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

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

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

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

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

Her tür ve mülkle ilgili dokümanlar, ilgili URI'da mevcuttur.

Şema uzantılarının listesi

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

Schema.org'un type uzantısı:

• EntitySearchResult

Schema.org'daki mülk uzantıları şunlardır:

• detailedDescription
• resultScore