A biblioteca de cliente do 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ê precisará de um token de desenvolvedor e ID do cliente. As instruções sobre como obtê-los estão descritas na pré-requisitos. Você vai gerar os outros tokens OAuth2 necessários nas próximas etapas.
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 "feature" 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 final 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 ficar 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 fim da vida útil na seção Versões sem suporte do 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 término do suporte.
Para dependências, especificamente, qualquer pacote mantido pelo Google que esteja listados conforme necessário pela biblioteca de cliente Python), manteremos a compatibilidade com os pacotes que são mantidos pelo Google e considerados "com suporte" de acordo com a Política de alteração interruptiva do OSS.
Para uma lista completa dos ambientes de execução e dependências compatíveis com o Python, consulte a Dependências.
Instalação
Siga as instruções na nossa instalação para instalar a biblioteca do PyPi e voltar 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 são descritas na nossa documentação de configuração.
Autenticação
Depois de escolher um tipo de configuração, é possível continuar gerando a tokens OAuth2 restantes necessários para fazer solicitações à API. Há vários fluxos OAuth2 com suporte, que estão documentados na lista abaixo. Para saber mais sobre as diferenças entre os fluxos e ajudar a 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 à configuração, você estará pronto para fazer uma solicitação de API. Consulte a Exemplo de get campaigns para uma maneira simples de testar se a biblioteca está configurada de forma adequada para tornar a API solicitações.
Para executar o exemplo 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 fazer uma solicitação de API, use a biblioteca de cliente da seguinte forma: