Guia de instruções

Nesta página, você verá detalhes sobre como realizar tarefas comuns usando a API.

Como criar usuários

O UserService permite que um usuário com direitos de administrador crie um usuário diretamente na rede dele. Qualquer desenvolvedor pode fazer isso sem que o novo usuário precise se inscrever primeiro. Por exemplo, se você está testando a API pela primeira vez, em vez de realizar todas as chamadas de API como administrador (o padrão para seu endereço de e-mail), é recomendável criar alguns usuários com funções como Vendedor, Coordenador de publicidade ou Anunciante para testar fluxos de trabalho reais.

  1. Crie alguns endereços novos do Gmail, como my.name.dfp.salesperson@gmail.com. Se preferir, registre um endereço que não seja do Gmail como uma nova Conta do Google.
  2. Chame createUsers com esse novo endereço e o Role escolhido.
  3. Você pode fazer a autenticação como esse novo usuário utilizando o OAuth 2.0 para gerar seu token de acesso.

Como buscar o bloco de anúncios raiz

Tanto o AdUnit superior ao qual você pode adicionar nós filhos quanto a profundidade permitida de sua hierarquia dependem do tipo de conta (Small Business ou Premium). A AdUnit superior compatível com a modificação dos nós filhos é chamada de AdUnit raiz efetiva.

Para recuperar a raiz efetiva, chame NetworkService.getCurrentNetwork() e examine o campo effectiveRootAdUnitId no objeto Network retornado.

Observação:tipos diferentes de conta oferecem suporte a diferentes padrões hierárquicos.

Como consultar um objeto

Para pesquisar objetos pelos critérios de pesquisa, use o método getObjectsByStatement() exposto por muitos serviços, em que Object é um tipo de objeto específico. Esse método usa uma consulta PQL, semelhante a uma consulta SQL, porque permite especificar campos para pesquisar (em que os nomes dos campos mapeiam para propriedades no objeto), classificar, limitar e deslocar os resultados da pesquisa. Consulte o Guia da PQL para saber mais sobre PQL e em quais campos do objeto é possível usar filtros.

Como criar um pedido

Para gerar um pedido, basta criar um objeto Order e definir os IDs de anunciante, vendedor e coordenador de publicidade para os usuários apropriados, atribuir um nome exclusivo e chamar createOrders(). O resultado vai incluir o Order recém-criado ou um erro.

Exemplo

Veja o exemplo de código Java para criar um pedido.

Como criar um item de linha

Veja as etapas para criar um novo item de linha:

  1. Crie um novo objeto Order ou use um existente.
  2. Crie um novo objeto LineItem e defina o tipo de rotação, a matriz de tamanho do criativo, as datas de início e término e outras propriedades.
  3. Crie um novo objeto InventoryTargeting e especifique quais objetos Placement ou AdUnit segmentar ou excluir.
  4. Empacote o objeto InventoryTargeting em um novo objeto Targeting e o atribua à propriedade de segmentação do LineItem.
  5. Chame o método de serviço createLineItems() do item de linha com seu novo objeto e examine o resultado para ver se ele foi criado.

Exemplo

Veja o exemplo de código Java para criar um item de linha.

Como gerar um criativo

Diferentes tipos de criativos oferecem suporte a diferentes componentes. Por exemplo, um criativo de imagem aceita um único arquivo de origem para a imagem, e um criativo em Flash é compatível com dois arquivos de recursos subjacentes: um arquivo Flash e um de imagem de backup, caso o arquivo Flash não possa ser veiculado. Para criativos hospedados em sites de terceiros, você só fará o upload de um snippet HTML que faça referência ao arquivo no servidor de terceiros. Consulte sua subclasse Creative específica para saber quais recursos precisam ser enviados por upload para gerar seu criativo.

Exemplo

Veja um exemplo de código Java para gerar um criativo de imagem.

Como modificar um objeto existente

Para modificar um objeto existente, consulte o objeto chamando getObjectsByStatement(), atualize os valores nos objetos retornados e chame updateObjects().

Observação:os objetos atualizados substituem completamente os atuais. Portanto, se você não definir um valor de propriedade no objeto enviado, o objeto salvo vai receber o valor padrão dessa propriedade, não o anterior.

Como alterar o status do objeto

O status do objeto é alterado chamando o método performObjectAction() exposto pelo serviço. Esse método usa dois parâmetros:

  • Uma instância do objeto de ação que descreve o que você quer fazer. Por exemplo, o serviço de pedido expõe várias ações, incluindo ApproveOrders, PauseOrders e ArchiveOrders. Todos os objetos de ação derivam de uma classe de ação básica apropriada para seu serviço.
  • Uma consulta de PQL descrevendo quais objetos mudar. É possível mudar o status de um ou mais objetos por vez especificando uma instrução PQL apropriada.

Como gerar tags de anúncio

Não é possível gerar tags de anúncio usando a API. Em vez disso, é preciso usar o site do Google Ad Manager. Consulte a seção Inclusão de tags da Central de Ajuda para mais informações.

Mais exemplos

Há muito mais exemplos de código na nossa biblioteca de cliente, em várias linguagens de programação diferentes. Consulte a página Bibliotecas de cliente e exemplo de código para acessar um link de exemplos na sua linguagem de programação.