Method: cse.list

Gibt Metadaten zur durchgeführten Suche, zur verwendeten Suchmaschine und zu den Suchergebnissen zurück.

HTTP-Anfrage

GET https://customsearch.googleapis.com/customsearch/v1

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
c2coff

string

Aktiviert oder deaktiviert die Suche in vereinfachtem und traditionellem Chinesisch.

Der Standardwert für diesen Parameter ist 0 (null). Dies bedeutet, dass die Funktion aktiviert ist. Unterstützte Werte:

  • 1: deaktiviert

  • 0: Aktiviert (Standardeinstellung)

cr

string

Beschränkt die Suchergebnisse auf Dokumente aus einem bestimmten Land. Sie können im Wert des Parameters „cr“ Boolesche Operatoren verwenden.

Das Land eines Dokuments wird in der Google Suche anhand folgender Daten bestimmt:

  • die Top-Level-Domain (TLD) der Dokument-URL

  • den geografischen Standort der IP-Adresse des Webservers

Auf der Seite Länderparameterwerte finden Sie eine Liste der gültigen Werte für diesen Parameter.

cx

string

Die Programmable Search Engine-ID, die für diese Anfrage verwendet werden soll.

dateRestrict

string

Beschränkt die Ergebnisse auf URLs basierend auf dem Datum. Unterstützte Werte sind:

  • d[number]: Fordert Ergebnisse für die angegebene Anzahl der letzten Tage an.

  • w[number]: Fordert Ergebnisse für die angegebene Anzahl der letzten Wochen an.

  • m[number]: Fordert Ergebnisse für die angegebene Anzahl der letzten Monate an.

  • y[number]: Fordert Ergebnisse für die angegebene Anzahl vergangener Jahre an.

exactTerms

string

Kennzeichnet eine Wortgruppe, die alle Dokumente in den Suchergebnissen enthalten müssen.

excludeTerms

string

Kennzeichnet ein Wort oder eine Wortgruppe, das bzw. die in keinem Dokument in den Suchergebnissen angezeigt werden soll.

fileType

string

Beschränkt die Ergebnisse auf Dateien mit einer bestimmten Erweiterung. Eine Liste der Dateitypen, die von Google indexiert werden können, finden Sie in der Search Console-Hilfe.

filter

string

Hiermit können Sie festlegen, ob der Filter für duplizierte Inhalte aktiviert oder deaktiviert werden soll.

  • Weitere Informationen zu den Suchergebnisfiltern von Google finden Sie unter Automatische Filterung. Der Host Crowding-Filter gilt nur für Suchanfragen auf mehreren Websites.

  • Standardmäßig wendet Google Filter auf alle Suchergebnisse an, um die Qualität dieser Ergebnisse zu verbessern.

Akzeptable Werte sind:

  • 0: Der Filter für duplizierte Inhalte wird deaktiviert.

  • 1: Aktiviert den Filter für duplizierte Inhalte.

gl

string

Standortbestimmung des Endnutzers.

  • Der Parameterwert gl ist ein zweistelliger Ländercode. Mit dem Parameter gl werden Suchergebnisse optimiert, deren Ursprungsland mit dem Parameterwert übereinstimmt. Eine Liste der gültigen Werte finden Sie auf der Seite Ländercodes.

  • Die Angabe eines gl-Parameterwerts sollte zu relevanteren Ergebnissen führen. Dies gilt insbesondere für internationale Kunden und insbesondere für Kunden in englischsprachigen Ländern außer den USA.

googlehost

string

Verworfen. Verwenden Sie den Parameter gl für einen ähnlichen Effekt.

Die lokale Google-Domain (z. B. google.com, google.de oder google.fr), die für die Suche verwendet werden soll.

highRange

string

Gibt den Endwert für einen Suchbereich an.

  • Verwende lowRange und highRange, um einen inklusiven Suchbereich von lowRange...highRange an die Abfrage anzuhängen.
hl

string

Legt die Sprache der Benutzeroberfläche fest.

hq

string

Hängt die angegebenen Suchbegriffe so an die Abfrage an, als wären sie mit einem logischen UND-Operator kombiniert worden.

imgColorType

enum (ImgColorType)

Gibt Schwarz-Weiß-, Graustufen-, transparente oder farbige Bilder zurück. Akzeptable Werte sind:

  • "color"

  • "gray"

  • "mono": Schwarz-Weiß

  • "trans": transparenter Hintergrund

imgDominantColor

enum (ImgDominantColor)

Gibt Bilder einer bestimmten dominanten Farbe zurück. Akzeptable Werte sind:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"

imgSize

enum (ImgSize)

Gibt Bilder einer bestimmten Größe zurück. Akzeptable Werte sind:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"

imgType

enum (ImgType)

Gibt Bilder eines bestimmten Typs zurück. Akzeptable Werte sind:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"

lowRange

string

Gibt den Startwert für einen Suchbereich an. Verwende lowRange und highRange, um einen inklusiven Suchbereich von lowRange...highRange an die Abfrage anzuhängen.

lr

string

Beschränkt die Suche auf Dokumente in einer bestimmten Sprache (z.B. lr=lang_ja).

Akzeptable Werte sind:

  • "lang_ar": Arabisch

  • "lang_bg": Bulgarisch

  • "lang_ca": Katalanisch

  • "lang_cs": Tschechisch

  • "lang_da": Dänisch

  • "lang_de": Deutsch

  • "lang_el": Griechisch

  • "lang_en": Englisch

  • "lang_es": Spanisch

  • "lang_et": Estnisch

  • "lang_fi": Finnisch

  • "lang_fr": Französisch

  • "lang_hr": Kroatisch

  • "lang_hu": Ungarisch

  • "lang_id": Indonesisch

  • "lang_is": Isländisch

  • "lang_it": Italienisch

  • "lang_iw": Hebräisch

  • "lang_ja": Japanisch

  • "lang_ko": Koreanisch

  • "lang_lt": Litauisch

  • "lang_lv": Lettisch

  • "lang_nl": Niederländisch

  • "lang_no": Norwegisch

  • "lang_pl": Polnisch

  • "lang_pt": Portugiesisch

  • "lang_ro": Rumänisch

  • "lang_ru": Russisch

  • "lang_sk": Slowakisch

  • "lang_sl": Slowenisch

  • "lang_sr": Serbisch

  • "lang_sv": Schwedisch

  • "lang_tr": Türkisch

  • "lang_zh-CN": Chinesisch (vereinfacht)

  • "lang_zh-TW": Chinesisch (traditionell)

num

integer

Anzahl der zurückzugebenden Suchergebnisse.

  • Gültige Werte sind Ganzzahlen zwischen 1 und 10 (einschließlich).
orTerms

string

Liefert zusätzliche Suchbegriffe, nach denen in einem Dokument gesucht werden soll, wobei jedes Dokument in den Suchergebnissen mindestens einen der zusätzlichen Suchbegriffe enthalten muss.

q

string

Abfrage

relatedSite
(deprecated)

string

Veraltet.

rights

string

Filter sind lizenzbasiert. Unterstützte Werte sind: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived und Kombinationen davon. Siehe Typische Kombinationen.

safe

enum (Safe)

Sicherheitsebene für Suche. Akzeptable Werte sind:

  • "active": Aktiviert die SafeSearch-Filterung.

  • "off": Deaktiviert den SafeSearch-Filter. (Standard)

searchType

enum (SearchType)

Gibt den Suchtyp an: image. Wenn keine Vorgabe erfolgt, werden die Ergebnisse auf Webseiten beschränkt.

Akzeptable Werte sind:

  • "image": benutzerdefinierte Bildersuche
siteSearchFilter

enum (SiteSearchFilter)

Steuert, ob Ergebnisse der im siteSearch-Parameter genannten Website ein- oder ausgeschlossen werden.

Akzeptable Werte sind:

  • "e": ausschließen

  • "i": einschließen

sort

string

Der Sortierausdruck, der auf die Ergebnisse angewendet werden soll. Der Parameter sort gibt an, dass die Ergebnisse nach dem angegebenen Ausdruck sortiert werden sollen, d.h. nach Datum. Beispiel: sort=date.

start

integer (uint32 format)

Index des ersten zurückzugebenden Ergebnisses Die Standardanzahl der Ergebnisse pro Seite ist 10, sodass &start=11 oben auf der zweiten Ergebnisseite beginnt. Hinweis: Die JSON API gibt nie mehr als 100 Ergebnisse zurück, selbst wenn mehr als 100 Dokumente mit der Abfrage übereinstimmen. Wenn Sie die Summe von start + num auf eine Zahl größer als 100 setzen, wird daher ein Fehler ausgegeben. Beachten Sie auch, dass der Maximalwert für num 10 ist.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Search.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cse

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.