Começar a usar a API Ads Data Hub

Neste guia, explicamos como começar a criar aplicativos que usam a API REST do Ads Data Hub para interagir com o ADH. Com essa API, você tem acesso aos clientes do Ads Data Hub associados à sua Conta do Google e pode criar/executar consultas.

Configuração

Você precisa seguir algumas etapas antes de usar a API Ads Data Hub:

  1. Verifique se o usuário que ativou a API recebeu a permissão serviceusage.services.enable no projeto do Google Cloud. O usuário com permissão serviceusage.services.enable também precisa estar na lista para acessar a API.
  2. Ative a API Ads Data Hub no projeto do Google Cloud em que as credenciais do cliente ou a conta de serviço foram criadas. Para ativar a API Ads Data Hub em um projeto usando o console:
    1. Acesse a biblioteca de APIs do console do Cloud.
    2. Selecione o projeto que você quer usar na lista.
    3. Pesquise "API Ads Data Hub".
    4. Na página da API, clique em ATIVAR.
  3. Gerencie as permissões:
    1. A conta de serviço ou o endereço de e-mail usado para criar as credenciais precisa ser adicionado ao Ads Data Hub com as permissões apropriadas. Para a conta de serviço, é o endereço de e-mail dela. Para OAuth, é o endereço de e-mail do usuário. Assim, a conta de serviço ou a conta do usuário final tem permissão para executar consultas no Ads Data Hub.
  4. (Recomendado) Instale uma biblioteca de cliente das APIs do Google:
    1. As bibliotecas de cliente das APIs do Google estão disponíveis em várias linguagens conhecidas e permitem que você trabalhe com muitas APIs do Google. Embora não seja obrigatório, as bibliotecas reduzem a quantidade de código que você precisa escrever e simplificam a configuração da autenticação.
Biblioteca de cliente Exemplos do Ads Data Hub
Biblioteca de cliente das APIs do Google para Java Java
Biblioteca de cliente das APIs do Google para Python

Autenticar e autorizar

A API Ads Data Hub pode acessar e alterar dados na sua conta de cliente do Ads Data Hub. Portanto, ela precisa verificar se você é um usuário autorizado. Antes de usar a API, é preciso seguir um fluxo de autorização, que fornece as permissões necessárias para interagir com ela. É possível autenticar usando o OAuth 2.0 ou uma conta de serviço.

Configuração da conta de serviço

  1. Acesse o Console de APIs do Google e navegue até seu projeto de administrador.
  2. Verifique se a API Ads Data Hub está ativada para seu projeto em APIs e serviços.
    1. Se não estiver, clique em + Ativar APIs e serviços e habilite a API.
  3. No menu de navegação à esquerda, clique em IAM e administrador > Contas de serviço.
    1. Crie uma conta de serviço.
  4. Clique no menu de três pontos () em "Ações" e, depois, em Gerenciar chaves.
    1. Selecione Adicionar chave > Criar nova chave.
    2. Depois de escolher "JSON", clique em Criar.
  5. Adicione o endereço de e-mail da conta de serviço como um usuário na sua conta do Ads Data Hub.

Enviar um exemplo de solicitação

#!/usr/bin/env python3

"""This sample shows how to retrieve all accounts associated with the user.
"""
import json
from google.oauth2.service_account import Credentials
from googleapiclient.discovery import build

SCOPES = ['https://www.googleapis.com/auth/adsdatahub']
DISCOVERY_URL = 'https://adsdatahub.googleapis.com/$discovery/rest?version=v1'
creds = Credentials.from_service_account_file(
    'service-account.json').with_scopes(SCOPES)
developer_key = 'YOUR_DEVELOPER_KEY'  # Replace with your developer key.
service = build('AdsDataHub', 'v1', credentials=creds,
                developerKey=developer_key, discoveryServiceUrl=DISCOVERY_URL)

# Replace with your customer ID.
customer_name = input('Customer name (e.g. "customers/123"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=customer_name).execute()
print(json.dumps(queries, sort_keys=True, indent=4))

Próximas etapas

  • Confira exemplos de consultas no Ads Data Hub que você pode criar e executar com a API REST do Ads Data Hub.
  • Faça testes com os exemplos para conhecer melhor a API e personalizar como quiser. Depois:
  • Se tiver dúvidas ou feedback sobre a API, procure o suporte do ADH.
Anterior
Configurar sua conta
Próxima
Usar a interface da Web