API aufrufen

API aufrufen

Anfrageformat

Die meisten unterstützten Vorgänge zur Websiteüberprüfung lassen sich direkt den REST-HTTP-Verben (GET, POST, PUT, DELETE) zuordnen, wie unter Google Site Verification API-Vorgänge beschrieben.

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

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

Dabei ist resourceID die ID für eine Webressource, parameters alle Parameter, die auf die Abfrage angewendet werden können. Welche Parameter Sie tatsächlich verwenden, hängt davon ab, welchen Vorgang Sie durchführen. Wenn Sie OAuth 2.0 verwenden, sollten Sie in diesen Parametern außerdem access_token festlegen.

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

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

Sie können den Vorgang getToken über seinen eigenen eindeutigen URI aufrufen. Das Format für den Aufruf von getToken lautet:

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 des Vorgangs

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

Beispiele für API-Aufrufe

In diesem Abschnitt wird davon ausgegangen, dass Sie (der Entwickler) auch der authentifizierte Nutzer sind, wie dies der Fall wäre, wenn Sie die API zum ersten Mal mit Ihren eigenen Testdaten testen.

Neue Website bestätigen

So bestätigen Sie eine Website:

1. Fordern Sie zuerst durch Aufrufen von getToken ein Bestätigungstoken an.
2. Platzieren Sie das Token mit einer beliebigen Methode auf Ihrer Website.
3. Bitten Sie Google, mithilfe der Operation insert zu bestätigen, dass es sich um Ihre Website handelt.

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 zu verifizierten Webressourcen abrufen

Sie können die vollständige Liste Ihrer bestätigten Websites und Domains abrufen, indem Sie list aufrufen. Sie können Informationen zu einer einzelnen Webressource abrufen, indem Sie get aufrufen.

Liste (erfordert Autorisierung)

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 (erfordert Autorisierung)

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 (Kein Inhalt), der eine erfolgreiche Ausführung anzeigt.