Visão geral

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

Requisitos

A biblioteca requer o Python 3.8 ou mais recente.

Pré-requisitos

Antes de instalar a biblioteca, você vai precisar de um token de desenvolvedor e um ID de cliente. As instruções sobre como fazer isso estão descritas na seção de pré-requisitos. Você vai gerar os outros tokens OAuth2 necessários nas etapas posteriores.

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

A biblioteca de cliente do Python mantém a 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 status "recurso" ou "pré-lançamento".

Ao adotar novas versões do ambiente de execução do Python, nosso objetivo é lançar uma nova versão da biblioteca de cliente do Python compatível com o ambiente de execução mais recente até o fim do trimestre seguinte ao lançamento. Por exemplo, se um novo ambiente de execução for lançado em outubro, uma versão compatível da biblioteca de cliente do Python vai estar disponível até o final de março do ano seguinte.

Os ambientes de execução do Python que atingiram o fim da vida útil (EOL) não são compatíveis após a data de EOL na seção Versões sem suporte de python.org.

Podemos lançar uma versão da biblioteca de cliente do Python que seja incompatível com runtimes do Python sem suporte a qualquer momento após o fim da vida útil.

Para dependências (especificamente, qualquer pacote mantido pelo Google que seja listado como obrigatório pela biblioteca de cliente Python), vamos manter a compatibilidade com pacotes mantidos pelo Google e considerados "compatíveis" de acordo com a Política de mudanças incompatíveis 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

Siga as instruções na nossa documentação de instalação para instalar a biblioteca do PyPi e volte a esta página.

Configuração

Depois de instalar a biblioteca, você precisará configurar uma configuração para ela. Há várias maneiras de configurar a biblioteca, que estão descritas na documentação de configuração.

Autenticação

Depois de escolher um tipo de configuração, gere os tokens OAuth2 restantes necessários para fazer solicitações à API. Há vários fluxos OAuth2 compatíveis, que estão documentados na lista abaixo. Para mais detalhes sobre as diferenças entre os fluxos e ajuda para decidir qual é o melhor para seu aplicativo, consulte nossa documentação do OAuth.

Como fazer uma solicitação de API

Depois de incorporar os tokens OAuth2 à sua configuração, você estará pronto para fazer uma solicitação de API. Consulte o exemplo de receber campanhas para uma maneira simples de testar se a biblioteca está configurada corretamente para fazer solicitações de API.

Para executar a amostra get_campaigns.py, no diretório raiz da biblioteca de cliente googleads-python instalada localmente, execute o seguinte comando:

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

Outros recursos

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