Comece a usar a API Ads Data Hub

Este guia explica como começar a escrever aplicações que usam a API REST do Ads Data Hub para interagir com o Ads Data Hub. A API REST do Ads Data Hub permite ver os clientes do Ads Data Hub associados à sua Conta Google, criar consultas e executar consultas.

Configuração

Precisa de concluir alguns passos antes de usar a API Ads Data Hub:

  1. Certifique-se de que é concedida ao utilizador que ativa a API a autorização serviceusage.services.enable no projeto do Google Cloud. O utilizador com a autorização serviceusage.services.enable também tem de ser adicionado à lista de autorizações para aceder à API.
  2. Ative a API Ads Data Hub no projeto do Google Cloud em que foram criadas as credenciais de cliente ou a conta de serviço. Para ativar a API Ads Data Hub para um projeto através da consola:
    1. Aceda à Biblioteca de APIs da Cloud Console.
    2. Selecione o projeto que quer usar na lista de projetos.
    3. Pesquise "API Ads Data Hub".
    4. Na página da API, clique em ATIVAR.
  3. Faça a gestão de autorizações:
    1. O endereço de email ou a conta de serviço usada para criar as credenciais têm de ser adicionados ao Ads Data Hub com as autorizações adequadas. Para uma conta de serviço, trata-se do endereço de email da conta de serviço. Para OAuth, trata-se do endereço de email do utilizador. Isto garante que a conta de serviço ou a conta do utilizador final tem autorização para executar consultas no Ads Data Hub.
  4. (Recomendado) Instale uma biblioteca cliente de APIs Google:
    1. As bibliotecas cliente de APIs Google estão disponíveis em várias linguagens populares e permitem trabalhar com muitas APIs Google. Embora não sejam necessárias, as bibliotecas cliente reduzem a quantidade de código que tem de escrever e simplificam a configuração da autenticação.
Biblioteca cliente Amostras do Ads Data Hub
Biblioteca cliente de APIs Google para Java Java
Biblioteca cliente de APIs Google para Python

Autentique e autorize

A API Ads Data Hub pode aceder aos dados da conta de cliente do Ads Data Hub e alterá-los, pelo que precisa de confirmar se é um utilizador autorizado. Por este motivo, antes de começar a interagir com a API Ads Data Hub, precisa de passar por um fluxo de autorização. Um fluxo de autorização dá as autorizações necessárias para interagir com a API. Pode autenticar através de OAuth 2.0 ou de uma conta de serviço.

Configuração da conta de serviço

  1. Aceda à API Console (Google) e navegue para o projeto do administrador.
  2. Confirme se a API Ads Data Hub está ativada para o projeto em APIs e serviços.
    1. Se não estiver ativada, clique em + Ativar APIs e serviços e ative a API Ads Data Hub.
  3. No menu de navegação à esquerda, clique em IAM e administrador > Contas de serviço.
    1. Se ainda não o tiver feito, crie uma conta de serviço.
  4. Clique no menu de 3 pontos () em "Ações" e, em seguida, clique em Gerir chaves.
    1. Clique em Adicionar chave > Criar nova chave
    2. Depois de garantir que "JSON" está selecionado, clique em Criar.
  5. Adicione o endereço de email da conta de serviço como utilizador na conta do Ads Data Hub.

Envie um pedido de amostra

#!/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))

Passos seguintes

  • Veja as consultas de amostra no Ads Data Hub para obter exemplos de consultas que pode criar e executar com a API REST do Ads Data Hub.
  • Expanda as amostras para se familiarizar com a API e personalize-a de acordo com o seu exemplo de utilização. Depois, tente o seguinte:
  • Contacte o apoio técnico do ADH se tiver dúvidas ou feedback acerca da API.