Visão geral

A biblioteca de cliente do Python está hospedada no GitHub, e o pacote está disponível no PyPI.

Requisitos

A biblioteca é compatível com as versões 3.9 a 3.14 do Python (>=3.9, <3.15; a compatibilidade com o Python 3.14 foi adicionada na versão v28.2.0). Como o Python 3.9 e 3.10 emitem um aviso de descontinuação na importação na versão google-ads v32.0.0 e mais recentes, recomendamos o uso do Python 3.11 ou mais recente.

Pré-requisitos

Antes de continuar com este guia, você precisa do ID de cliente de 10 dígitos da sua conta do Google Ads.

Compatibilidade de ambiente de execução e dependência

A biblioteca de cliente do Python mantém compatibilidade com os ambientes de execução do Python na seção Versões compatíveis publicada pela Python Software Foundation, exceto para versões com o status "recurso" ou "pré-lançamento".

A equipe da API Google Ads pretende adotar novas versões do ambiente de execução do Python assim que forem lançadas e oficialmente compatíveis com a Python Software Foundation.

Os ambientes de execução do Python que chegaram ao fim da vida útil (EOL, na sigla em inglês) não são mais compatíveis após a data de EOL na seção Versões sem suporte de python.org. A compatibilidade com ambientes de execução em EOL não pode ser garantida, já que as versões da biblioteca após uma data de EOL podem interromper a compatibilidade.

Para dependências (especificamente, todos os pacotes mantidos pelo Google que estão listados como obrigatórios pela biblioteca de cliente do Python), a compatibilidade é mantida com pacotes mantidos pelo Google e considerados "compatíveis" de acordo com a Política de alterações interruptivas de OSS do Google.

Para uma lista completa de ambientes de execução e dependências do Python compatíveis, consulte a página Dependências.

Instalação

O guia de instalação descreve todas as maneiras de instalar a biblioteca. A maneira mais simples (e recomendada) de instalar a biblioteca no aplicativo é com pip:

python -m pip install google-ads

Configuração

Depois de instalar a biblioteca, é necessário definir uma configuração para ela. Há várias maneiras de configurar a biblioteca, que são descritas no guia de configuração.

Autenticação

Depois de escolher uma abordagem de configuração, defina sua configuração de autenticação. Para instruções detalhadas, consulte o guia de autenticação da biblioteca de cliente do Python. Para mais informações gerais, consulte a visão geral do OAuth.

Fazer uma solicitação de API

Depois de definir a configuração de autenticação, você poderá fazer uma solicitação de API. Consulte o exemplo get campaigns para testar rapidamente se a biblioteca está configurada corretamente para fazer solicitações de API.

Para executar o exemplo de get_campaigns.py, primeiro clone o repositório google-ads-python. Em seguida, no diretório raiz do repositório clonado, execute o seguinte comando:

python examples/basic_operations/get_campaigns.py -c INSERT_CUSTOMER_ID_HERE

Outros recursos

Depois de fazer uma solicitação de API, prossiga para estes usos da biblioteca de cliente: