Sie können die Daten zu den Suchzugriffen mit von Ihnen definierten Filtern und Parametern abfragen. Die Methode gibt null oder mehr Zeilen zurück, gruppiert nach den von Ihnen definierten Zeilenschlüsseln (Dimensionen). Sie müssen einen Zeitraum von einem oder mehreren Tagen definieren.
Wenn das Datum eine der Dimensionen ist, werden alle Tage ohne Daten in der Ergebnisliste weggelassen. Wenn Sie wissen möchten, für welche Tage Daten verfügbar sind, erstellen Sie für den gewünschten Zeitraum eine Abfrage ohne nach Datum gruppierte Filter.
Die Ergebnisse werden absteigend nach der Anzahl der Klicks sortiert. Wenn zwei Zeilen dieselbe Anzahl an Klicks haben, werden sie beliebig sortiert.
Informationen zum Aufrufen dieser Methode finden Sie im Python-Beispiel.
Die API ist durch interne Einschränkungen der Search Console eingeschränkt und garantiert nicht, dass alle Datenzeilen, sondern nur die ersten ausgegeben werden.
Weitere Informationen zu Limits für die Menge der verfügbaren Daten
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"]
}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, wie in der Search Console definiert. 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).
| Umfang |
|---|
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
}
| Property-Name | Wert | Beschreibung | Hinweise |
|---|---|---|---|
startDate |
string |
[Erforderlich] Startdatum des angeforderten Zeitraums im Format JJJJ-MM-TT, in PT time (UTC - 7:00/8:00). Muss vor dem Enddatum liegen oder diesem entsprechen. Dieser Wert ist im Bereich enthalten. | |
endDate |
string |
[Erforderlich] Enddatum des angeforderten Zeitraums im Format JJJJ-MM-TT in PT-Zeit (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 die Ergebnisse gruppiert werden sollen.Die Ergebnisse werden in der Reihenfolge gruppiert, in der Sie diese Dimensionen angeben.Sie können einen beliebigen Dimensionsnamen in dimensionFilterGroups[].filters[].dimension sowie „Datum“ verwenden.Die Werte der Gruppierungsdimension werden kombiniert, um für jede Ergebniszeile einen eindeutigen Schlüssel zu erstellen. Wenn keine Dimensionen angegeben sind, werden alle Werte in einer Zeile zusammengefasst. Es gibt keine Beschränkung für die Anzahl der Dimensionen, nach denen Sie gruppieren können, aber Sie können nicht zweimal nach derselben Dimension gruppieren. Beispiel: [Land, Gerät] | |
searchType |
string |
Eingestellt. Verwende stattdessen type.
|
|
type |
string |
[Optional] Filtern Sie die Ergebnisse nach folgendem Typ:
|
|
dimensionFilterGroups[] |
list |
[Optional] Null oder mehr Gruppen von Filtern, die auf die Werte für die Dimensionsgruppierung angewendet werden sollen. Alle Filtergruppen müssen übereinstimmen, damit in der Antwort eine Zeile zurückgegeben wird. Innerhalb einer Filtergruppe können Sie angeben, ob alle Filter oder mindestens ein Filter übereinstimmen müssen. | |
dimensionFilterGroups[].groupType |
string |
Gibt an, ob alle Filter in dieser Gruppe „true“ („und“) oder mindestens ein Filter „true“ zurückgeben muss (noch nicht unterstützt).
Zulässige Werte sind:
|
|
dimensionFilterGroups[].filters[] |
list |
[Optional] Null oder mehr Filter zum Testen für die Zeile. 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 dieser Filter angewendet wird. Sie können nach jeder hier aufgeführten Dimension filtern, auch wenn Sie nicht nach dieser Dimension gruppieren.
Zulässige Werte sind:
|
|
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:
|
|
dimensionFilterGroups[].filters[].expression |
string |
Der Wert für den Filter, der je nach Operator abgeglichen oder ausgeschlossen werden soll. | |
aggregationType |
string |
[Optional] Wie Daten aggregiert werden. Bei einer Zusammenfassung nach Property werden alle Daten für dieselbe Property zusammengefasst. Bei einer Zusammenfassung nach Seite werden alle Daten nach dem kanonischen URI zusammengefasst. Wenn Sie nach Seite filtern oder gruppieren, wählen Sie die Option „Automatisch“ aus. Andernfalls können Sie je nachdem, wie Ihre Daten berechnet werden sollen, entweder nach Property oder Seite aggregieren. In der Hilfedokumentation erfahren Sie, wie Daten je nach Website oder Seite unterschiedlich berechnet werden. Hinweis:Wenn Sie nach Seite gruppieren oder filtern, können Sie nicht nach Property aggregieren. Wenn Sie einen anderen Wert als „auto“ angeben, stimmt der Zusammenfassungstyp im Ergebnis mit dem angeforderten Typ überein. Wenn Sie einen ungültigen Typ anfordern, erhalten Sie eine Fehlermeldung. Die API ändert den Zusammenfassungstyp nie, wenn der angeforderte Typ ungültig ist. Zulässige Werte sind:
|
|
rowLimit |
integer |
[Optional; Gültiger Bereich ist 1–25.000; Standardwert ist 1.000] Die maximale Anzahl von Zeilen, die zurückgegeben werden sollen. Verwenden Sie den Offset startRow, um durch die Ergebnisse zu blättern. |
|
startRow |
integer |
[Optional; Standardwert ist 0] Nullbasierter 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 eine erfolgreiche Antwort mit null Zeilen. |
|
dataState |
string |
[Optional] Bei der Einstellung „all“ (Groß-/Kleinschreibung wird nicht berücksichtigt) enthalten die Daten aktuelle Daten. Wenn „final“ (Groß-/Kleinschreibung nicht berücksichtigt) oder dieser Parameter weggelassen wird, enthalten die zurückgegebenen Daten nur finalisierte Daten. |
Antwort
Die Ergebnisse werden nach den in der Anfrage angegebenen Dimensionen gruppiert. Alle Werte mit denselben Dimensionswerten werden in einer Zeile zusammengefasst. Wenn Sie beispielsweise nach der Dimension „Land“ gruppieren, werden alle Ergebnisse für „usa“, alle Ergebnisse für „mdv“ gruppiert usw. Wenn Sie nach Land und Gerät gruppiert haben, werden alle Ergebnisse für „usa, Tablet“ und alle Ergebnisse für „usa, mobile“ gruppiert usw. Weitere Informationen zur Berechnung von Klicks, Impressionen usw. finden Sie in der Dokumentation zum Bericht „Suchanalyse“.
Die Ergebnisse werden nach der Anzahl der Klicks in absteigender Reihenfolge sortiert, es sei denn, Sie gruppieren nach Datum. In diesem Fall werden die Ergebnisse nach Datum in aufsteigender Reihenfolge sortiert (älteste zuerst, neueste zuletzt). Bei einem Gleichstand zwischen zwei Zeilen ist die Sortierreihenfolge beliebig.
Die maximale Anzahl der Werte, die zurückgegeben werden können, finden Sie im Attribut rowLimit in der Anfrage.
{
"rows": [
{
"keys": [
string
],
"clicks": double,
"impressions": double,
"ctr": double,
"position": double
}
],
"responseAggregationType": string
}
| Property-Name | Wert | Beschreibung | Hinweise |
|---|---|---|---|
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 |
Anzahl der Klicks für die Zeile. | |
rows[].impressions |
double |
Anzahl an Impressionen für die Zeile. | |
rows[].ctr |
double |
Klickrate (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 aggregiert wurden.In der Hilfe finden Sie Informationen dazu, wie die Daten je nach Website und Seite unterschiedlich berechnet werden.
Zulässige Werte sind:
|
Jetzt testen
Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen.