API aufrufen

In diesem Dokument wird die Verwendung der Google Site Verification API beschrieben.

API aufrufen

Anfrageformat

Die meisten unterstützten Website-Überprüfungsvorgänge sind REST-HTTP-Verben (GET, POST, PUT, DELETE) zugeordnet, wie unter Google Site Verification API-Vorgänge beschrieben.

Das spezifische Format für Google Site Verification API-URIs ist:

https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters

Dabei ist resourceID die Kennung für eine Webressource, parameters sind alle Parameter, die auf die Abfrage angewendet werden sollen. Die tatsächlich verwendeten Parameter hängen davon ab, welchen Vorgang Sie ausführen. Wenn Sie OAuth 2.0 verwenden, sollten Sie außerdem in diesen Parametern access_token festlegen.

Für Listenabfragen ist keine resourceID erforderlich. Das Format ist:

https://www.googleapis.com/siteVerification/v1/webResource?parameters

Sie können die getToken-Operation mit einem eigenen eindeutigen URI aufrufen. Das Format für den Aufruf von getToken ist:

https://www.googleapis.com/siteVerification/v1/token?parameters

Datenformat

Die Google Site Verification API gibt Daten im JSON-Format zurück.

JSON (JavaScript Object Notation) ist ein gängiges sprachunabhängiges Datenformat, das eine einfache Textdarstellung beliebiger Datenstrukturen bietet. Weitere Informationen finden Sie unter json.org.

Zusammenfassung der Vorgänge

Sie können in der Google Site Verification API sechs verschiedene Methoden für Sammlungen und Ressourcen aufrufen, wie in der folgenden Tabelle beschrieben. Die API-URLs sind relativ zu https://www.googleapis.com/siteVerification/v1.

Vorgang Beschreibung URL und Syntax
list

Listet alle Ressourcen in der Sammlung des authentifizierten Nutzers auf

GET /webResource

Siehe Beispielanfrage für list.

Einfügen

Bestätigt eine Website oder Domain. Wenn der Vorgang erfolgreich war, wird eine neue Webressource in die Sammlung des Nutzers eingefügt.

Anfragetext: Siehe Webressource

Suchparameter: verificationMethod. Die für diese Anfrage zu verwendende Bestätigungsmethode. Mögliche Werte: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

Siehe Beispiel für eine Anfrage.

Holen Sie sich

Ruft die neuesten Daten für eine bestimmte Webressource ab.

GET /webResource/resourceID

Siehe Beispiel für eine get-Anfrage.

Aktualisieren

Ändert die Liste der Inhaber für eine bestimmte Ressource.

Anfragetext: Siehe Webressource

Hinweise:

  • Der authentifizierte Nutzer kann über update nicht aus der Inhaberliste entfernt werden. Verwenden Sie stattdessen delete.
  • Sie können jeden Nutzer aus der Inhaberliste entfernen, der auf der Website kein Bestätigungstoken hat.

PUT /webResource/resourceID

Siehe Beispielanfrage update.

Delete

Entfernt eine Ressource aus der Sammlung des Nutzers (überprüft, ob die Website dem Nutzer gehört)

Hinweise:

  • Sie müssen zuerst alle Bestätigungstokens des authentifizierten Nutzers von der Website oder Domain entfernen, bevor Sie delete aufrufen. Falls noch Tokens vorhanden sind, wird der Fehler „HTTP 400 (Bad Request)“ zurückgegeben.
  • Das Löschen wirkt sich nur auf Daten zu Eigentumsrechten für den authentifizierten Nutzer aus. Alle anderen Nutzer, ob delegiert oder unabhängig, behalten die Inhaberschaft nach dem Löschen.

DELETE /webResource/resourceID

Beispiel für eine Löschanfrage

getToken

Ruft das Bestätigungstoken ab, das auf der Website des authentifizierten Nutzers platziert werden soll.

Anfragetext:

  • identifier: Die Website-URL oder der Domainname.
  • type: Der Ressourcentyp, der überprüft werden soll. Mögliche Werte: SITE, INET_DOMAIN.
  • verificationMethod: Methode zur Bestätigung Ihrer Website. Mögliche Werte: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /token

Siehe Beispielanfrage für getToken.

Beispiele für API-Aufrufe

In diesem Abschnitt wird davon ausgegangen, dass Sie (der Entwickler) auch der authentifizierte Nutzer sind, was der Fall ist, wenn Sie die API zum ersten Mal mit eigenen Testdaten ausprobieren.

Neue Website bestätigen

So bestätigen Sie eine Website:

  1. Fordern Sie zuerst ein Bestätigungstoken an, indem Sie getToken aufrufen.
  2. Platzieren Sie das Token mit einer beliebigen Methode auf Ihrer Website.
  3. Bitten Sie Google, Ihre Website mithilfe des Vorgangs insert zu bestätigen.

getToken (Autorisierung erforderlich)

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token

Anfrage:

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token
Content-Type: application/json

{
  "verificationMethod": "FILE",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

Antwort

{
  "token": "google12cfc68677988bb4.html",
  "method": "FILE"
}

Einfügen (Autorisierung erforderlich)

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token

Anfrage:

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token
Content-Type: application/json

{
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

Antwort

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Informationen für bestätigte Webressourcen abrufen

Die vollständige Liste Ihrer bestätigten Websites und Domains können Sie durch Aufrufen von list abrufen. Sie können Informationen für eine einzelne Webressource abrufen, indem Sie get aufrufen.

Liste (Autorisierung erforderlich)

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

Anfrage:

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

Antwort

{
  "items": [
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site1",
        "type": "SITE"
      }
    },
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site2",
        "type": "SITE"
      }
    }
  ]
}

Abrufen (Berechtigung erforderlich)

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Anfrage:

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Antwort

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Bestätigungsinformationen ändern

Sie können die Inhaberschaft delegieren und widerrufen, indem Sie update aufrufen. Sie können die Inhaberschaft für sich selbst entfernen, indem Sie delete aufrufen.

Aktualisieren (Autorisierung erforderlich)

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Anfrage:

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Content-Type: application/json

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

Antwort

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Löschen (Autorisierung erforderlich)

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Anfrage:

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Antwort

HTTP 204-Statuscode (No Content), der Erfolg angibt.