Wywoływanie interfejsu API

W tym dokumencie opisano sposób korzystania z interfejsu Google Site Verification API.

Wywoływanie interfejsu API

Format żądania

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

Identyfikator URI identyfikatorów URI interfejsu Google Site Verification API to:

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

gdzie resourceID to identyfikator zasobu internetowego, parameters to parametry, które mają zastosowanie do zapytania. Rzeczywiste parametry mogą się różnić w zależności od tego, jaką operację przeprowadzasz. Jeśli używasz protokołu OAuth 2.0, ustaw w tych parametrach parametr access_token.

Zapytania dotyczące list nie wymagają identyfikatora zasobu, więc format:

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

Wywołania operacji getToken możesz wywoływać za pomocą własnego, unikalnego identyfikatora URI. Format wywołania getToken to:

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

Format danych

Interfejs API weryfikacji witryn Google zwraca dane w formacie JSON.

JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który reprezentuje prosty tekst reprezentujący dowolne struktury danych. Więcej informacji znajdziesz na stronie json.org.

Podsumowanie operacji

W interfejsie Google Site Verification API można wywoływać 6 różnych metod dotyczących kolekcji i zasobów, zgodnie z poniższą tabelą. Adresy URL interfejsów API są względne względem https://www.googleapis.com/siteVerification/v1.

Operacja Opis URL i składnia
list

Wyświetla wszystkie zasoby w kolekcji uwierzytelnionego użytkownika.

GET /webResource

Zapoznaj się z przykładowym żądaniem listy.
wstaw

Weryfikacja witryny lub domeny. Jeśli operacja się uda, wstawia nowy zasób internetowy do kolekcji użytkownika.

Treść żądania: zobacz materiał 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

Zapoznaj się z przykładowym żądaniem insert.
pobierz

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

GET /webResource/resourceID

Zobacz przykładowe żądanie Pobierz.
aktualizacja

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

Treść żądania: zobacz materiał internetowy.

Uwagi:

  • Uwierzytelnionego użytkownika nie możesz usunąć z listy właścicieli, używając aktualizacji. Zamiast tego użyj polecenia delete.
  • Możesz usunąć z listy właścicieli dowolnego użytkownika, który nie ma w witrynie tokena weryfikacyjnego.

PUT /webResource/resourceID

Zobacz przykładowe żądanie aktualizacji.
usuń

Usuwa zasób z kolekcji użytkownika (pozwala potwierdzić, że witryna należy do użytkownika).

Uwagi:

  • Zanim wywołasz metodę delete, musisz usunąć wszystkie tokeny weryfikacyjne uwierzytelnionego użytkownika i z witryny lub domeny. Jeśli nadal istnieją, zwracany jest błąd HTTP 400 (nieprawidłowe żądanie).
  • Usunięcie dotyczy tylko danych własności uwierzytelnionego użytkownika. Wszyscy pozostali użytkownicy, niezależnie od tego, czy zostali delegowani, czy zweryfikowani samodzielnie, zachowują własność po usunięciu.

DELETE /webResource/resourceID

Zapoznaj się z przykładowym żądaniem usunięcia.
getToken

Pobiera token weryfikacyjny do witryny uwierzytelnionego użytkownika.

Treść żądania:

  • identifier: adres URL witryny lub nazwa domeny.
  • type: typ zasobu do weryfikacji. Możliwe wartości: SITE, INET_DOMAIN.
  • verificationMethod: metoda używana podczas weryfikowania 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) też jesteś uwierzytelnionym użytkownikiem – tak samo jak podczas pierwszego testowania interfejsu API z własnymi danymi testowymi.

Zweryfikuj nową witrynę

Aby zweryfikować witrynę:

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

getToken (wymaga autoryzacji)

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

Żądanie:

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

Żądanie:

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

Aby pobrać pełną listę zweryfikowanych witryn i domen, wywołaj metodę list. Aby pobrać informacje o pojedynczym zasobie internetowym, wywołaj funkcję get.

Lista (wymaga autoryzacji)

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

Żądanie:

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

Uzyskaj (wymaga autoryzacji)

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

Żądanie:

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

Modyfikowanie informacji weryfikacyjnych

Możesz przekazać lub anulować własność, wywołując update. Możesz usunąć własność dla siebie, dzwoniąc na delete.

Aktualizacja (wymaga autoryzacji)

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

Żądanie:

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

Żądanie:

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), który wskazuje, że witryna się powiodła.