Segundo plano

Antes de começar

  1. Peça ao representante da conta para configurar as permissões adequadas para as contas. que seu aplicativo vai acessar.
  2. Se você não conhece os conceitos do Authorized Buyers, acesse a Central de Ajuda do Authorized Buyers e testar a interface do usuário. Se for esperado que seu aplicativo realize lances em tempo real, leia o Documentação do protocolo de RTB.
  3. Acesse o Console de APIs para configurar um novo projeto. Faça login na sua Conta do Google de desenvolvedor ou criar uma conta. Em seguida, será solicitado que você crie um projeto e aprove sobre alguns Termos de Serviço.

Contas de pais e filhos

Se você trabalha em uma estrutura de conta que contém contas pai e filho contas, você poderá trabalhar com mais eficácia se entender como eles interagem. Veja a seguir um breve resumo:

Contas filhas

Um usuário com credenciais que concedem acesso a uma conta filha só pode visualizar e modificar os recursos associados à conta. As contas infantis não podem ver ou modificar recursos que pertencem a outras contas mãe ou filha.

Contas de familiar responsável

Um usuário com credenciais que concedem acesso a uma conta de familiar responsável pode visualizar e modificar os recursos da conta principal, além de todos os contas filhas. Para operações que listam todo um determinado recurso, este usuário receberá uma resposta, incluindo dados para sua conta e todos os seus contas filhas. Para outros tipos de solicitações que segmentam recursos para vagas derivadas, um a conta principal precisará especificar um parâmetro de caminho accountId para a conta filha em vez da própria accountId.

O modelo de dados da API REST

Um recurso é uma entidade individual de dados com um identificador exclusivo. A O recurso "Accounts" representa uma entrada de conta do Authorized Buyers e é a raiz classe de dados para a API de comprador do Ad Exchange. Os métodos da API operam em instâncias Recursos de contas e de coleções de recursos de contas.

Um Accounts Recurso inclui: um ID de conta, informações usadas na correspondência de cookie, locais do bidder, o URL para o qual as solicitações de lance são enviadas e uma solicitação para especificar o máximo de consultas por segundo a serem enviadas pelo Ad Exchange.

Além do recurso de contas e da coleção, a API de comprador do Ad Exchange define as seguintes estruturas de dados:

Local do bidder

Os locais do bidder são estruturas retornadas com os recursos das contas para fornecer o URL para o qual a troca de anúncios deve enviar solicitações de lance, e o número máximo de consultas por segundo que o Ad Exchange deve enviar. Veja um exemplo de um local de proponente, expresso em JSON: 

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

Itens

Os itens fornecem uma lista de contas. Veja um exemplo de itens expressos em JSON: 

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

Operações compatíveis

Você pode invocar três métodos diferentes em coleções e recursos no API de comprador do Ad Exchange, conforme descrito na tabela a seguir. Todas as operações exigem autorização.

Operação Descrição Mapeamentos HTTP REST
list Lista todas as contas que podem ser acessadas pelo usuário usuário. GET em um URI de coleta.
get Recebe um recurso de contas específico. GET em um URI de recurso.
update Atualiza um recurso de contas específico. PUT em um URI de recurso, onde você transmite dados para o recurso atualizado.

Como chamar estilos

REST é um estilo de arquitetura de software que fornece uma abordagem conveniente e consistente para solicitar e modificar dados.

O termo REST é a abreviação de "Representational State Transfer (Transferência de Estado Representacional)". 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, uma ação é especificada no cliente usando um verbo HTTP como POST, GET, PUT ou DELETE. Um recurso é definido por meio de um URI global 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 de comprador do Ad Exchange

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

O formato específico dos URIs da API é:

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

em que resourceID é o identificador de um recurso de contas, e parameters são quaisquer parâmetros a serem aplicados à consulta. Consulte parâmetros de consulta padrão e o documentação de referência para mais detalhes.

O formato das extensões de caminho resourceID permite que você identifique o recurso em que está operando no momento, por exemplo:

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

O conjunto completo de URIs usados para cada operação aceita na API é resumido no documentação de referência.

Veja um exemplo de como isso funciona na API de comprador do Ad Exchange.

Consiga a lista de contas do usuário autenticado:

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

Formato de dados

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