Invoca la API

En este documento, se describe cómo usar la API de verificación del sitio de Google.

Invoca la API

Formato de la solicitud

La mayoría de las operaciones de verificación del sitio compatibles se asignan directamente a los verbos HTTP de REST (GET, POST, PUT, DELETE), como se describe en las operaciones de la API de verificación de sitio de Google.

El formato específico para los URI de Google Site Verification API es el siguiente:

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

En el ejemplo anterior, resourceID es el identificador de un recurso web, parameters es cualquier parámetro que se aplica a la consulta. Los parámetros reales que se usan varían según la operación que se realice. Además, si usas OAuth 2.0, debes configurar access_token en estos parámetros.

Las consultas de lista no requieren un resourceID, por lo que el formato es el siguiente:

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

Puedes realizar llamadas a la operación getToken por su propio URI único. El formato de una llamada a getToken es el siguiente:

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

Formato de los datos

La API de verificación del sitio de Google muestra datos en formato JSON.

JSON (JavaScript Object Notation) es un formato de datos común y, también, independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarias. Para obtener más información, visita json.org.

Resumen de operaciones

Puedes invocar seis métodos diferentes sobre colecciones y recursos en la API de Google Site Verification, como se describe en la siguiente tabla. Las URL de la API están relacionadas con https://www.googleapis.com/siteVerification/v1.

Operación Descripción URL y sintaxis
list

Enumera todos los recursos dentro de la colección del usuario autenticado.

GET /webResource

Consulte el ejemplo de solicitud de lista.

insertar

Verifica un sitio o dominio. Si se realiza correctamente, inserta un nuevo recurso web en la colección del usuario.

Cuerpo de la solicitud: Consulta Recurso web.

Parámetro de consulta: verificationMethod. Es el método de verificación que se usa para esta solicitud. Valores posibles: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

Consulta el ejemplo de solicitud insert.

obtener

Obtiene los datos más recientes de un recurso web específico.

GET /webResource/resourceID

Ver ejemplo de solicitud get

actualizar

Modifica la lista de propietarios de un recurso específico.

Cuerpo de la solicitud: Consulta Recurso web.

Notas:

  • No se puede quitar el usuario autenticado de la lista de propietarios mediante update. En su lugar, usa delete.
  • Puedes eliminar de la lista de propietarios a cualquier usuario que no tenga un token de verificación en el sitio.

PUT /webResource/resourceID

Consulte el ejemplo de solicitud de actualización.

borrar

Elimina un recurso de la colección del usuario (se anula la verificación de que el sitio pertenece al usuario).

Notas:

  • Debes quitar del sitio o dominio todos los tokens de verificación del usuario autenticado antes de llamar a delete. Si todavía hay tokens, se muestra un error HTTP 400 (Solicitud incorrecta).
  • La eliminación solo afecta los datos de propiedad del usuario autenticado. Todos los demás usuarios, ya sea que se hayan delegado o se hayan verificado de forma independiente, conservarán la propiedad después de su eliminación.

DELETE /webResource/resourceID

Consulta el ejemplo de solicitud delete.

getToken

Obtiene el token de verificación para colocar en el sitio web del usuario autenticado.

Cuerpo de la solicitud:

  • identifier: La URL del sitio o el nombre del dominio.
  • type: El tipo de recurso que se verificará. Valores posibles: SITE, INET_DOMAIN.
  • verificationMethod: Es el método que se usará para verificar tu sitio. Valores posibles: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /token

Consulta el ejemplo de solicitud getToken.

Ejemplos de llamadas a la API

En esta sección, se supone que tú (el desarrollador) también eres el usuario autenticado, como es el caso cuando pruebas la API por primera vez con tus propios datos de prueba.

Verificar un sitio nuevo

Para verificar un sitio, haz lo siguiente:

  1. Primero, solicita un token de verificación mediante una llamada a getToken.
  2. Coloque el token en su sitio con el método que elija.
  3. Pídele a Google que verifique que el sitio es tuyo mediante la operación insert.

getToken (requiere autorización)

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

Solicitud:

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

Respuesta:

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

Insertar (requiere autorización)

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

Solicitud:

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

Respuesta:

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

Recuperar información para recursos web verificados

Para recuperar la lista completa de sus sitios y dominios verificados, llame a list. Puedes recuperar información para un solo recurso web si llamas a get.

Lista (requiere autorización)

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

Solicitud:

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

Respuesta:

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

Obtener (requiere autorización)

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

Solicitud:

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

Respuesta:

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

Modificar información de verificación

Para delegar y revocar la propiedad, puedes llamar a update. Puedes quitarte la propiedad llamando a delete.

Actualizar (requiere autorización)

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

Solicitud:

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

Respuesta:

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

Borrar (requiere autorización)

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

Solicitud:

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

Respuesta:

Código de estado HTTP 204 (sin contenido) que indica que la prueba se realizó con éxito