Diese Seite wurde von der Cloud Translation API übersetzt.

Search Analytics: query

Sie können Ihre Suchzugriffe mithilfe von von Ihnen definierten Filtern und Parametern abfragen. Die Methode gibt null oder mehr Zeilen zurück, die nach den von Ihnen definierten Zeilenschlüsseln (Dimensionen) gruppiert sind. Sie müssen einen Zeitraum von einem oder mehreren Tagen festlegen.

Wenn „Datum“ eine der Dimensionen ist, werden Tage ohne Daten aus der Ergebnisliste ausgeschlossen. Wenn Sie wissen möchten, für welche Tage Daten vorhanden sind, führen Sie eine Abfrage ohne Filter aus, die nach Datum gruppiert ist, für den gewünschten Zeitraum.

Die Ergebnisse werden absteigend nach Klickzahl sortiert. Wenn zwei Zeilen dieselbe Klickzahl haben, werden sie in einer beliebigen Reihenfolge sortiert.

Weitere Informationen zum Aufrufen dieser Methode finden Sie im Python-Beispiel.

Die API unterliegt internen Einschränkungen der Search Console und gibt keine Garantie dafür, dass alle Datenzeilen zurückgegeben werden, sondern nur die obersten.

Informationen zu den Limits für die verfügbare Datenmenge

JSON POST-Beispiel:

POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query?key={MY_API_KEY}
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

Jetzt testen

Anfrage

HTTP-Anfrage

POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query

Parameter

Parametername	Wert	Beschreibung
Pfadparameter
`siteUrl`	`string`	Die URL der Property, die in der Search Console definiert wurde. Beispiele:`http://www.example.com/` (für eine URL-Präfix-Property) oder `sc-domain:example.com` (für eine Domain-Property)

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

Bereich
`https://www.googleapis.com/auth/webmasters.readonly`
`https://www.googleapis.com/auth/webmasters`

Anfragetext

Geben Sie im Anfragetext Daten mit der folgenden Struktur ein:

{
  "startDate": string,
  "endDate": string,
  "dimensions": [
    string
  ],
  "type": string,
  "dimensionFilterGroups": [
    {
      "groupType": string,
      "filters": [
        {
          "dimension": string,
          "operator": string,
          "expression": string
        }
      ]
    }
  ],
  "aggregationType": string,
  "rowLimit": integer,
  "startRow": integer
}

Name der Eigenschaft	Wert	Beschreibung
`startDate`	`string`	[Erforderlich] Das Startdatum des angeforderten Zeitraums im Format JJJJ-MM-TT in PT-Zeit (UTC–7:00/8:00). Muss kleiner oder gleich dem Enddatum sein. Dieser Wert ist im Bereich enthalten.
`endDate`	`string`	[Erforderlich] Enddatum des angeforderten Zeitraums im Format JJJJ-MM-TT in der Zeitzone PT (UTC−7:00/8:00). Muss größer oder gleich dem Startdatum sein. Dieser Wert ist im Bereich enthalten.
`dimensions[]`	`list`	[Optional] Null oder mehr Dimensionen, nach denen Ergebnisse gruppiert werden sollen. Die Ergebnisse werden in der Reihenfolge gruppiert, in der Sie diese Dimensionen angeben. Sie können in `dimensionFilterGroups[].filters[].dimension` jeden Dimensionsnamen sowie „Datum“ verwenden. Die Werte der Gruppierungsdimension werden kombiniert, um einen eindeutigen Schlüssel für jede Ergebniszeile zu erstellen. Wenn keine Dimensionen angegeben werden, werden alle Werte in einer einzigen Zeile zusammengefasst. Die Anzahl der Dimensionen, nach denen Sie gruppieren können, ist unbegrenzt. Sie können jedoch nicht zweimal nach derselben Dimension gruppieren. Beispiel: [Land, Gerät]
`searchType`	`string`	Verworfen, verwenden Sie stattdessen `type`.
`type`	`string`	[Optional] Filtern Sie die Ergebnisse nach dem folgenden Typ: „`discover`“: Discover-Ergebnisse „`googleNews`“: Ergebnisse von news.google.com und der Google News App für Android und iOS. Ergebnisse vom Tab „News“ in der Google Suche sind nicht enthalten. „`news`“: Suchergebnisse vom Tab „News“ in der Google Suche. „`image`“: Suchergebnisse vom Tab „Bilder“ in der Google Suche. „`video`“: Videosuchergebnisse „`web`“: [Standard] Filtert Ergebnisse auf den kombinierten Tab „Alle“ in der Google Suche. Ergebnisse aus Discover oder Google News sind nicht enthalten.
`dimensionFilterGroups[]`	`list`	[Optional] Null oder mehr Filtergruppen, die auf die Werte der Dimensionsgruppierung angewendet werden sollen. Alle Filtergruppen müssen übereinstimmen, damit eine Zeile in der Antwort zurückgegeben wird. Innerhalb einer einzelnen Filtergruppe können Sie angeben, ob alle Filter übereinstimmen müssen oder mindestens einer.
`dimensionFilterGroups[].groupType`	`string`	Gibt an, ob alle Filter in dieser Gruppe „true“ („and“) oder mindestens „true“ zurückgeben müssen (noch nicht unterstützt). Zulässige Werte sind: „`and`“: Alle Filter in der Gruppe müssen „wahr“ zurückgeben, damit die Filtergruppe wahr ist.
`dimensionFilterGroups[].filters[]`	`list`	[Optional] Null oder mehr Filter, die anhand der Zeile getestet werden sollen. Jeder Filter besteht aus einem Dimensionsnamen, einem Operator und einem Wert. Maximale Länge: 4.096 Zeichen. Beispiele: country equals FRA query contains mobile use device notContains tablet
`dimensionFilterGroups[].filters[].dimension`	`string`	Die Dimension, auf die sich dieser Filter bezieht. Sie können nach jeder hier aufgeführten Dimension filtern, auch wenn Sie nicht nach dieser Dimension gruppieren. Zulässige Werte sind: "`country`": Nach dem angegebenen Land gemäß dem aus drei Buchstaben bestehenden Ländercode (ISO 3166-1 alpha-3) filtern „`device`“: Ergebnisse nach dem angegebenen Gerätetyp filtern. Unterstützte Werte: DESKTOP MOBIL TABLET „`page`“: Filtert nach dem angegebenen URI-String. "`query`": Filtert nach dem angegebenen Abfragestring. „`searchAppearance`“: Filtern nach einem bestimmten Suchergebnis-Spezialformat. Eine Liste der verfügbaren Werte erhalten Sie, wenn Sie eine Abfrage ausführen, die nach „searchAppearance“ gruppiert ist. Eine vollständige Liste der Werte und Beschreibungen finden Sie auch in der Hilfedokumentation.
`dimensionFilterGroups[].filters[].operator`	`string`	[Optional] Gibt an, ob der angegebene Wert mit dem Dimensionswert für die Zeile übereinstimmen muss oder nicht. Zulässige Werte sind: „`contains`“: Der Zeilenwert muss entweder den Ausdruck enthalten oder mit ihm übereinstimmen (ohne Berücksichtigung der Groß- und Kleinschreibung). „`equals`“: [Standard] Der Ausdruck muss genau mit dem Zeilenwert übereinstimmen. Bei Seiten- und Abfragedimensionen wird zwischen Groß- und Kleinschreibung unterschieden. "`notContains`": Der Zeilenwert darf den Ausdruck nicht als Teilstring oder als vollständige Übereinstimmung (Groß- und Kleinschreibung nicht berücksichtigen) enthalten. "`notEquals`": Der Ausdruck darf nicht genau mit dem Zeilenwert übereinstimmen (bei den Seiten- und Abfragedimensionen wird zwischen Groß- und Kleinschreibung unterschieden). „`includingRegex`“: Ein regulärer Ausdruck der RE2-Syntax, der abgeglichen werden muss. „`excludingRegex`“: Ein regulärer Ausdruck mit RE2-Syntax, der nicht abgeglichen werden darf.
`dimensionFilterGroups[].filters[].expression`	`string`	Der Wert für den Filter, der je nach Operator übereinstimmt oder ausgeschlossen werden soll.
`aggregationType`	`string`	[Optional] Wie Daten zusammengefasst werden. Bei der Zusammenfassung nach Property werden alle Daten für dieselbe Property zusammengefasst. Bei der Zusammenfassung nach Seite werden alle Daten nach kanonischem URI zusammengefasst. Wenn Sie nach Seite filtern oder gruppieren, wählen Sie „Automatisch“ aus. Andernfalls können Sie die Daten entweder nach Property oder nach Seite zusammenfassen, je nachdem, wie sie berechnet werden sollen. In der Hilfe erfahren Sie, wie sich die Berechnung von Daten nach Website und nach Seite unterscheidet. Hinweis:Wenn Sie nach Seite gruppieren oder filtern, können Sie nicht nach Property aggregieren. Wenn Sie einen anderen Wert als „auto“ angeben, entspricht der Aggregationstyp im Ergebnis dem angeforderten Typ. Wenn Sie einen ungültigen Typ anfordern, wird ein Fehler ausgegeben. Die API ändert den Aggregationstyp niemals, wenn der angeforderte Typ ungültig ist. Zulässige Werte sind: „`auto`“: [Standard] Der Dienst entscheidet über den geeigneten Aggregationstyp. „`byNewsShowcasePanel`“: Werte nach News Showcase-Bereich aggregieren Dieser muss in Kombination mit dem Filter `NEWS_SHOWCASE` `searchAppearance` und entweder `type=discover` oder `type=googleNews` verwendet werden. Wenn Sie nach Seite gruppieren, nach Seite filtern oder nach einer anderen `searchAppearance` filtern, können Sie nicht nach `byNewsShowcasePanel` aggregieren. „`byPage`“: Werte nach URI zusammenfassen. „`byProperty`“: Werte nach Property zusammenfassen. Nicht unterstützt für `type=discover` oder `type=googleNews`
`rowLimit`	`integer`	[Optional; gültiger Bereich: 1–25.000; Standardwert: 1.000] Die maximale Anzahl der Zeilen, die zurückgegeben werden sollen. Verwenden Sie den Offset von `startRow`, um durch die Ergebnisse zu blättern.
`startRow`	`integer`	[Optional; Standardwert: 0] Der nullbasierte Index der ersten Zeile in der Antwort. Muss eine nicht negative Zahl sein. Wenn `startRow` die Anzahl der Ergebnisse für die Abfrage überschreitet, ist die Antwort erfolgreich, enthält aber keine Zeilen.
`dataState`	`string`	[Optional] Wenn „alle“ (groß- und kleinschreibungsempfindlich) ausgewählt ist, enthalten die Daten aktuelle Daten. Wenn „final“ (ohne Berücksichtigung der Groß- und Kleinschreibung) oder dieser Parameter weggelassen wird, enthalten die zurückgegebenen Daten nur endgültige Daten.

Antwort

Die Ergebnisse werden nach den in der Anfrage angegebenen Dimensionen gruppiert. Alle Werte mit denselben Dimensionswerten werden in einer einzigen Zeile zusammengefasst. Wenn Sie beispielsweise nach der Dimension „Land“ gruppieren, werden alle Ergebnisse für „usa“ zusammengefasst, alle Ergebnisse für „mdv“ usw. Wenn Sie nach Land und Gerät gruppiert haben, werden alle Ergebnisse für „Deutschland, Tablet“ und alle Ergebnisse für „Deutschland, Mobilgerät“ gruppiert usw. Weitere Informationen dazu, wie Klicks, Impressionen usw. berechnet werden und was sie bedeuten, finden Sie in der Dokumentation zum Bericht „Suchanalyse“.

Die Ergebnisse werden in absteigender Reihenfolge nach Klickanzahl sortiert, sofern Sie nicht nach Datum gruppieren. In diesem Fall werden sie in aufsteigender Reihenfolge sortiert (älteste zuerst, neueste zuletzt). Wenn zwei Zeilen gleich sind, ist die Sortierreihenfolge beliebig.

Die maximale Anzahl der zurückzugebenden Werte finden Sie in der Anfrage unter der Property rowLimit.

{
  "rows": [
    {
      "keys": [
        string
      ],
      "clicks": double,
      "impressions": double,
      "ctr": double,
      "position": double
    }
  ],
  "responseAggregationType": string
}

Property-Name	Wert	Beschreibung
`rows[]`	`list`	Eine Liste von Zeilen, die nach den Schlüsselwerten in der in der Abfrage angegebenen Reihenfolge gruppiert sind.
`rows[].keys[]`	`list`	Eine Liste der Dimensionswerte für diese Zeile, gruppiert nach den Dimensionen in der Anfrage und in der in der Anfrage angegebenen Reihenfolge.
`rows[].clicks`	`double`	Klicken Sie für die Zeile auf „Anzahl“.
`rows[].impressions`	`double`	Impressionszahl für die Zeile.
`rows[].ctr`	`double`	Die Klickrate (Click-through-Rate, CTR) für die Zeile. Die Werte reichen von 0 bis einschließlich 1.0.
`rows[].position`	`double`	Die durchschnittliche Position in den Suchergebnissen.
`responseAggregationType`	`string`	Wie die Ergebnisse zusammengefasst wurden. In der Hilfe erfahren Sie, wie Daten nach Website und nach Seite unterschiedlich berechnet werden. Zulässige Werte sind: „`auto`“ „`byPage`“: Die Ergebnisse wurden nach Seite zusammengefasst. „`byProperty`“: Die Ergebnisse wurden nach Property zusammengefasst.

Testen!

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen.