Fazer solicitações diretas

Incentivamos você a usar as bibliotecas de cliente e amostras para sua implementação. No entanto, se sua integração com a API tiver necessidades especiais, como usar um idioma não compatível, faça solicitações diretas, conforme descrito abaixo.

Estilo de chamada

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 da seguinte forma:

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 AdSense Management

As operações aceitas são mapeadas diretamente para verbos HTTP REST, conforme descrito em Operações da API AdSense Management.

O formato específico para URIs da API de gerenciamento do Google AdSense é:

https://adsense.googleapis.com/v2/resourceID?parameters

em que resourceID é o identificador de um cliente de anúncios, bloco de anúncios, canal de URL, critério personalizado ou conjunto de relatórios, e parameters são parâmetros a serem aplicados à consulta.

O formato das extensões de caminho resourceID permite identificar o recurso em operação no momento, por exemplo:

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

O conjunto completo de URIs usados para cada operação aceita na API é resumido no documento Referência da API AdSense Management.

Veja alguns exemplos de como isso funciona na API AdSense Management.

Listar clientes de anúncios:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

Listar blocos de anúncios no cliente de anúncios ca-pub-1234567890123456:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

Formato de dados

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).

Como autorizar solicitações

O Google AdSense não oferece suporte a contas de serviço. Em vez disso, use o fluxo de aplicativos instalados.

Todas as solicitações que seu aplicativo envia para a API AdSense Management devem incluir um token de autorização. O token também identifica o aplicativo para o Google.

Sobre os protocolos de autorização

O aplicativo deve obrigatoriamente usar o OAuth 2.0 para autorizar solicitações. Não há outros protocolos de autorização compatíveis. Se o aplicativo usa o Fazer login com o Google, alguns aspectos da autorização são administrados para você.

Autorizar solicitações com OAuth 2.0

Todas as solicitações para a API de gerenciamento do Google AdSense devem ser autorizadas por um usuário autenticado.

Esse processo é facilitado com um ID do cliente OAuth.

Gerar um ID do cliente OAuth

Ou crie uma na página Credenciais.

Os detalhes do processo de autorização ou “fluxo” para o OAuth 2.0 variam um pouco, dependendo do tipo de aplicativo que você está criando. O processo geral a seguir se aplica a todos os tipos de aplicativo:

  1. Quando seu aplicativo precisar de acesso aos dados do usuário, ele solicitará ao Google um determinado escopo do acesso.
  2. O Google exibe uma tela de consentimento ao usuário, pedindo para que o aplicativo seja autorizado a solicitar alguns dos dados dele.
  3. Se o usuário aprovar, o Google fornecerá ao aplicativo um token de acesso de curta duração.
  4. O aplicativo solicita dados de usuário, anexando o token de acesso à solicitação.
  5. Se o Google determinar que a solicitação e o token são válidos, ele retornará os dados solicitados.

Alguns fluxos incluem etapas adicionais, como atualizar tokens para adquirir novos tokens de acesso. Para mais informações sobre fluxos de vários tipos de aplicativos, acesse a documentação OAuth 2.0 do Google.

Veja as informações de escopo do OAuth 2.0 para a API AdSense Management:

Escopo Significado
https://www.googleapis.com/auth/adsense Acesso de leitura/gravação aos dados do Google AdSense.
https://www.googleapis.com/auth/adsense.readonly Acesso somente leitura aos dados do Google AdSense.

Para solicitar acesso usando o OAuth 2.0, seu aplicativo precisa de informações do escopo, bem como informações fornecidas pelo Google durante o registro do aplicativo, como o ID e a chave secreta do cliente.

Dica: as bibliotecas cliente de APIs do Google cuidam de parte do processo de autorização para você. Elas estão disponíveis para uma série de linguagens de programação. Acesse a página de bibliotecas e exemplos para mais detalhes.

Como fazer uma solicitação

A etapa final é fazer a solicitação de API. Consulte a documentação de referência para ver informações específicas.