Prerequisites

En este documento, se describen las acciones que debes realizar antes de escribir tu primera aplicación cliente.

Crea una Cuenta de Google

Necesitas una cuenta de Google para usar esta API. Tu cuenta debe tener el permiso adecuado de Search Console en una propiedad determinada para llamar a ese método en esa propiedad. Por ejemplo, para ejecutar searchAnalytics.query necesitas permisos de lectura en esa propiedad.

Probar Google Search Console

En la documentación de esta API, se supone que usaste Google Search Console y que conoces los conceptos de programación web y los formatos de datos web.

Si aún no utilizó Google Search Console, pruebe la interfaz de usuario antes de comenzar a programar. Cada API representa la funcionalidad de un informe en Search Console. Debes leer la documentación del informe equivalente antes de usar una API para comprender los datos que recibes.

Crea un proyecto y credenciales para tu cliente

Antes de poder enviar solicitudes a Google Search Console, debes informarle a Google sobre tu cliente y activar el acceso a la API. Para ello, usa la Consola de API de Google a fin de crear un proyecto (una colección determinada de configuraciones y datos de acceso a la API) y registrar la aplicación.

Todas las API de Search Console, excepto la API de Testing Tools, requieren credenciales de OAuth2. Las guías de inicio rápido de Python y Java proporcionan detalles sobre cómo crear un proyecto y obtener credenciales para tu cliente.

Comprende los aspectos básicos de REST

Existen dos maneras de invocar la API:

Si decides no usar bibliotecas cliente, deberás comprender los aspectos básicos de REST.

Conceptos básicos de REST

REST es un estilo de arquitectura de software que proporciona un enfoque conveniente y coherente para solicitar y modificar datos.

El término REST es el acrónimo en inglés de "Transferencia de estado representacional". En el contexto de las API de Google, se refiere al uso de verbos HTTP para recuperar y modificar representaciones de los datos que almacena Google.

En un sistema RESTful, los recursos se almacenan en un almacén de datos; un cliente envía una solicitud para que el servidor ejecute una acción en particular (como crear, recuperar, actualizar o borrar un recurso) y el servidor ejecuta la acción y envía una respuesta que, por lo general, es una representación del recurso especificado.

En las API de RESTful de Google, el cliente especifica una acción con un verbo HTTP como POST, GET, PUT o DELETE. Especifica un recurso mediante un URI único a nivel global de la siguiente forma:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Dado que todos los recursos de API tienen URI únicos accesibles a través de HTTP, REST permite el almacenamiento de datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.

Puedes encontrar las definiciones de métodos en la documentación de estándares del HTTP 1.1, los que incluyen especificaciones para GET, POST, PUT y DELETE.

REST en la API de Google Search Console

Las operaciones de la API de Google Search Console se asignan directamente a los verbos HTTP de REST.

El formato para la mayoría de los URI de la API de Google Search Console es similar al siguiente:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

El conjunto completo de URI y verbos que se usa para cada método se proporcionan en la referencia de la API de Google Search Console.

Comprende los aspectos básicos de JSON

La API de Google Search Console 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.