Richiamare l'API

Questo documento descrive come utilizzare l'API Google Site Verification.

Richiamo dell'API

Formato della richiesta

La maggior parte delle operazioni di verifica del sito supportate mappa direttamente ai verbi HTTP REST (GET, POST, PUT, DELETE), come descritto in Operazioni dell'API Google Site Verification.

Il formato specifico degli URI dell'API Google Site Verification è:

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

dove resourceID è l'identificatore di una risorsa web, parameters sono eventuali parametri da applicare alla query. I parametri effettivi utilizzati variano a seconda dell'operazione che stai eseguendo. Inoltre, se utilizzi OAuth 2.0, devi impostare access_token in questi parametri.

Le query dell'elenco non richiedono un resourceID, perciò il formato è:

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

Puoi effettuare chiamate all'operazione getToken tramite il suo URI univoco. Il formato di una chiamata a getToken è:

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

Formato dei dati

L'API Google Site Verification restituisce i dati in formato JSON.

JSON (JavaScript Object Notation) è un formato di dati comune, indipendente dal linguaggio, che fornisce una semplice rappresentazione testuale di strutture di dati arbitrarie. Per ulteriori informazioni, visita il sito json.org.

Riepilogo operazioni

Puoi richiamare sei diversi metodi per raccolte e risorse nell'API Google Site Verification, come descritto nella tabella che segue. Gli URL delle API sono relativi a https://www.googleapis.com/siteVerification/v1.

Operazione Descrizione URL e sintassi
list

Elenca tutte le risorse all'interno della raccolta dell'utente autenticato.

GET /webResource

Vedi esempio di richiesta di elenco.

inserisci

Verifica un sito o un dominio. In caso di esito positivo, inserisce una nuova risorsa web nella raccolta dell'utente.

Corpo della richiesta: consulta Risorsa web.

Parametro di ricerca: verificationMethod. Il metodo di verifica da utilizzare per questa richiesta. Valori possibili: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

Vedi un esempio di richiesta di inserimento.

trova

Recupera i dati più recenti per una risorsa web specifica.

GET /webResource/resourceID

Vedi esempio di richiesta get

aggiorna

Modifica l'elenco dei proprietari di una risorsa specifica.

Corpo della richiesta: consulta Risorsa web.

Note:

  • Non puoi rimuovere l'utente autenticato dall'elenco dei proprietari utilizzando update. Usa invece il comando elimina.
  • Puoi rimuovere dall'elenco dei proprietari qualsiasi utente che non dispone di un token di verifica sul sito.

PUT /webResource/resourceID

Vedi esempio di richiesta di aggiornamento.

elimina

Rimuove una risorsa dalla raccolta dell'utente (verifica che il sito appartiene all'utente).

Note:

  • Prima di chiamare delete, devi rimuovere tutti i token di verifica dell'utente autenticato dal sito o dal dominio. Se esistono ancora token, viene restituito un errore HTTP 400 (richiesta non valida).
  • L'eliminazione interessa solo i dati sulla proprietà dell'utente autenticato. Tutti gli altri utenti, delegati o verificati in modo indipendente, mantengono la proprietà dopo l'eliminazione.

DELETE /webResource/resourceID

Vedi un esempio di richiesta di eliminazione.

getToken

Ottiene il token di verifica da inserire nel sito web dell'utente autenticato.

Corpo della richiesta:

  • identifier: l'URL del sito o il nome di dominio.
  • type: tipo di risorsa da verificare. Valori possibili: SITE, INET_DOMAIN.
  • verificationMethod: il metodo da utilizzare per la verifica del sito. Valori possibili: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /token

Vedi esempio di richiesta getToken.

Chiamate API di esempio

Questa sezione presuppone che tu (lo sviluppatore) sia anche l'utente autenticato, come nel caso in cui tu provi per la prima volta l'API con i tuoi dati di test.

Verifica un nuovo sito

Per verificare un sito:

  1. Richiedi innanzitutto un token di verifica chiamando getToken.
  2. Inserisci il token sul tuo sito utilizzando il metodo che preferisci.
  3. Chiedi a Google di verificare che il sito sia tuo utilizzando l'operazione insert.

getToken (richiede l'autorizzazione)

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

Richiesta:

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

Risposta:

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

Inserisci (richiede l'autorizzazione)

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

Richiesta:

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

Risposta:

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

Recuperare informazioni per risorse web verificate

Puoi recuperare l'elenco completo dei tuoi siti e domini verificati richiamando list. Puoi recuperare le informazioni per una singola risorsa web chiamando get.

Elenco (richiede l'autorizzazione)

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

Richiesta:

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

Risposta:

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

Ottieni (richiede l'autorizzazione)

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

Richiesta:

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

Risposta:

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

Modifica delle informazioni per la verifica

Puoi delegare e revocare la proprietà chiamando update. Puoi rimuovere la proprietà per te stesso chiamando il comando delete.

Aggiorna (richiede l'autorizzazione)

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

Richiesta:

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

Risposta:

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

Elimina (richiede l'autorizzazione)

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

Richiesta:

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

Risposta:

Codice di stato HTTP 204 (Nessun contenuto), che indica l'esito positivo.