Neste documento, descrevemos o que você precisa fazer antes de escrever seu primeiro aplicativo cliente.
Criar uma Conta do Google
Você precisa de uma Conta do Google para usar esta API. Sua conta precisa ter a permissão adequada do Search Console em uma determinada propriedade para chamar o método nela. Por exemplo, para executar searchAnalytics.query, é necessário ter permissões de leitura nessa propriedade.
Testar o Google Search Console
Esta documentação da API pressupõe que você já usou o Google Search Console e que conhece os conceitos de programação e formatos de dados da Web.
Se você ainda não usou o Google Search Console, teste a interface do usuário antes de começar a codificar. Cada API representa a funcionalidade de um relatório no Search Console. Leia a documentação do relatório equivalente antes de usar uma API para entender os dados recebidos.
Crie um projeto e credenciais para seu cliente
Antes de enviar solicitações ao Google Search Console, informe ao Google sobre seu cliente e ative o acesso à API. Para isso, use o Console de APIs do Google para criar um projeto, que é uma coleção nomeada de configurações e informações de acesso à API, e registre seu aplicativo.
Todas as APIs do Search Console, exceto a API Testing Tools, exigem credenciais OAuth2. Os guias de início rápido para Python e Java fornecem detalhes sobre como criar um projeto e receber credenciais para seu cliente.
Noções básicas sobre o REST
Há duas maneiras de chamar a API:
- Enviar solicitações HTTP e analisar as respostas.
- Usar bibliotecas de cliente.
Se você não quer usar as bibliotecas de cliente, precisa entender os fundamentos da REST.
Fundamentos do REST
REST é um estilo de arquitetura de software que fornece uma abordagem conveniente e consistente para solicitar e modificar dados.
O termo REST é a sigla de "Representational State Transfer". No contexto das APIs do Google, ele se refere ao uso de verbos HTTP para recuperar e modificar representações de dados armazenados pelo Google.
Em um sistema RESTful, os recursos são mantidos em um armazenamento de dados. Um cliente envia uma solicitação para que uma ação específica seja executada no servidor, como a criação, recuperação, atualização ou exclusão de um recurso. Essa ação é executada e uma resposta é enviada, geralmente no formato de uma representação do recurso especificado.
Nas APIs RESTful do Google, o cliente especifica uma ação usando um verbo HTTP, como POST, GET, PUT ou DELETE. Ele especifica um recurso por um URI globalmente exclusivo no seguinte formato:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Como todos os recursos da API têm URIs exclusivos acessíveis por HTTP, a REST permite o armazenamento em cache dos dados e é otimizada para funcionar na infraestrutura distribuída da Web.
As definições de método (em inglês) encontradas na documentação dos padrões HTTP 1.1 podem ser úteis. Nelas estão incluídas as especificações GET, POST, PUT e DELETE.
REST na API Google Search Console
As operações da API Google Search Console são mapeadas diretamente para os verbos HTTP REST.
O formato da maioria dos URIs da API Google Search Console é parecido com este:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
O conjunto completo de URIs e verbos usados para cada método é mostrado na visão geral da Referência da API Google Search Console.
Noções básicas sobre o JSON
A API Google Search Console retorna dados no formato JSON.
JSON (JavaScript Object Notation) é um formato de dados comum e independente de linguagem que oferece uma representação de texto simples das estruturas de dados arbitrárias. Para mais informações, acesse json.org (em inglês).