Wywoływanie interfejsu API

Ten dokument opisuje sposób korzystania z interfejsu Google Site Verification API.

Wywoływanie interfejsu API

Format żądania

Większość obsługiwanych operacji weryfikacji witryny jest mapowana bezpośrednio na czasowniki HTTP REST (GET, POST, PUT, DELETE), zgodnie z opisem w operacjach interfejsu Google Site Verification API.

Identyfikatory URI Google Site Verification API mają następujący format:

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

gdzie resourceID to identyfikator zasobu internetowego, a parameters to dowolne parametry stosowane do zapytania. Używane parametry różnią się w zależności od wykonywanej operacji. Poza tym, jeśli korzystasz z protokołu OAuth 2.0, musisz skonfigurować w tych parametrach parametr access_token.

Zapytania wg listy nie wymagają identyfikatora resourceID, więc ich format jest następujący:

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

Możesz wywoływać operację getToken za pomocą własnego unikalnego identyfikatora URI. Format wywołania getToken to:

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

Format danych

Interfejs Google Site Verification API zwraca dane w formacie JSON.

JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który w prosty sposób przedstawia dowolne struktury danych w formie tekstowej. Więcej informacji znajdziesz na stronie json.org.

Podsumowanie operacji

W interfejsie Google Site Verification API możesz wywoływać 6 różnych metod na zbiorach i zasobach, zgodnie z opisem w poniższej tabeli. Adresy URL interfejsu API są względne wobec elementu https://www.googleapis.com/siteVerification/v1.

Operacja Opis Adres URL i składnia
list

Wyświetla listę wszystkich zasobów w kolekcji uwierzytelnionego użytkownika.

GET /webResource

Zobacz przykładową prośbę o listę.
wstaw

Weryfikuje witrynę lub domenę. Jeśli operacja się uda, wstawi nowy zasób internetowy do kolekcji użytkownika.

Treść żądania: patrz Zasób internetowy.

Parametr zapytania: verificationMethod. Metoda weryfikacji, której należy użyć w przypadku tego żądania. Możliwe wartości: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

Zobacz przykładowe wstawianie.
pobierz

Pobiera najnowsze dane dotyczące określonego zasobu internetowego.

GET /webResource/resourceID

Zobacz przykładowe żądanie get
zaktualizuj

Modyfikuje listę właścicieli określonego zasobu.

Treść żądania: patrz Zasób internetowy.

Uwagi:

  • Przy użyciu polecenia update nie możesz usunąć uwierzytelnionego użytkownika z listy właścicieli. Zamiast tego użyj klawisza delete.
  • Możesz usunąć z listy właścicieli każdego użytkownika, który nie ma tokena weryfikacyjnego w witrynie.

PUT /webResource/resourceID

Zobacz przykładowe zaktualizowanie.
usuń

Usuwa zasób z kolekcji użytkownika (uniemożliwia zweryfikowanie, że witryna należy do użytkownika).

Uwagi:

  • Przed wywołaniem funkcji delete musisz usunąć z witryny lub domeny wszystkie tokeny weryfikacyjne uwierzytelnionego użytkownika. Jeśli tokeny nadal istnieją, zwracany jest błąd HTTP 400 (Nieprawidłowe żądanie).
  • Usunięcie wpływa tylko na dane własności w przypadku uwierzytelnionego użytkownika. Wszyscy pozostali użytkownicy, niezależnie od tego, czy zostali wyznaczeni lub zweryfikowani niezależnie, zachowują prawa własności po usunięciu konta.

DELETE /webResource/resourceID

Zobacz przykładową prośbę o usunięcie.
getToken,

Pobiera token weryfikacyjny do umieszczenia w witrynie uwierzytelnionego użytkownika.

Treść żądania:

  • identifier: adres URL witryny lub nazwa domeny.
  • type: typ zasobu do zweryfikowania. Możliwe wartości: SITE oraz INET_DOMAIN.
  • verificationMethod: metoda, której należy użyć do weryfikacji witryny. Możliwe wartości: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /token

Zobacz przykładowe żądanie getToken.

Przykładowe wywołania interfejsu API

W tej sekcji zakładamy, że Ty (deweloper) jesteś też uwierzytelnionym użytkownikiem, tak jak w przypadku pierwszego wypróbowania interfejsu API z własnymi danymi testowymi.

Zweryfikuj nową witrynę

Aby zweryfikować witrynę,

  1. Najpierw poproś o token weryfikacyjny, wywołując metodę getToken.
  2. Umieść token w witrynie za pomocą wybranej metody.
  3. Poproś Google o zweryfikowanie, czy witryna należy do Ciebie, używając operacji insert.

getToken (wymaga autoryzacji),

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

Prośba:

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"
  }
}

Odpowiedź:

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

Wstaw (wymaga autoryzacji)

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

Prośba:

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"
  }
}

Odpowiedź:

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

Pobieranie informacji o zweryfikowanych zasobach internetowych

Pełną listę zweryfikowanych witryn i domen możesz pobrać, wywołując list. Aby pobrać informacje dla pojedynczego zasobu internetowego, wywołaj get.

Lista (wymaga autoryzacji)

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

Prośba:

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

Odpowiedź:

{
  "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"
      }
    }
  ]
}

Pobierz (wymaga autoryzacji)

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

Prośba:

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

Odpowiedź:

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

Zmienianie informacji weryfikacyjnych

Prawo własności możesz przekazać i anulować, wywołując update. Możesz usunąć własność dla siebie, wywołując metodę delete.

Aktualizacja (wymaga autoryzacji)

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

Prośba:

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"
  }
}

Odpowiedź:

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

Usuń (wymaga autoryzacji)

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

Prośba:

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

Odpowiedź:

Kod stanu HTTP 204 (brak treści) wskazujący powodzenie.