Buscar referências a todas as várias classes proto necessárias para usar a API no Python pode ser detalhado e exige que você tenha um entendimento intrínseco da API ou que alterne o contexto com frequência para referenciar os protos ou a documentação.
Métodos get_service e get_type do cliente
Esses dois métodos getter permitem recuperar qualquer objeto de serviço ou tipo na API. O método get_service é usado para recuperar clientes de serviço. get_type
é usado para qualquer outro objeto. As classes de cliente de serviço são definidas no código no caminho da versão google/ads/googleads/v*/services/services/, e todos os tipos são definidos nas várias categorias de objetos, google/ads/googleads/v*/common|enums|errors|resources|services/types/.
Todo o código no diretório de versão é gerado. Portanto, é recomendável usar esses métodos em vez de importar os objetos diretamente, caso a estrutura da base de código mude.
Confira um exemplo de como usar o método get_service para recuperar uma instância
do cliente GoogleAdsService.
from google.ads.googleads.client import GoogleAdsClient
# "load_from_storage" loads your API credentials from disk so they
# can be used for service initialization. Providing the optional `version`
# parameter means that the v25 version of GoogleAdsService will
# be returned.
client = GoogleAdsClient.load_from_storage(version="v25")
googleads_service = client.get_service("GoogleAdsService")
Confira um exemplo de como usar o get_type método para recuperar uma
Campaign instância.
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage(version="v25")
campaign = client.get_type("Campaign")
Tipos enumerados
Embora seja possível usar o método get_type para recuperar tipos enumerados, cada instância GoogleAdsClient também tem um atributo enums que carrega dinamicamente os tipos enumerados usando o mesmo mecanismo do método get_type. Essa interface é mais simples e fácil de ler do que usar get_type:
client = GoogleAdsClient.load_from_storage(version=v25)
campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
Os campos de objeto proto que são tipos enumerados são representados no Python pelo tipo enumerado nativo
enumerado. Isso significa que você pode ler facilmente o valor do membro. Trabalhando com a instância campaign do exemplo anterior em um repl do Python:
>>> print(campaign.status)
CampaignStatus.PAUSED
>>> type(campaign.status)
<enum 'CampaignStatus'>
>>> print(campaign.status.value)
3
Às vezes, é útil saber o nome do campo que corresponde ao valor do tipo enumerado, conforme mostrado acima. Você pode acessar essas informações usando o atributo name:
>>> print(campaign.status.name)
'PAUSED'
>>> type(campaign.status.name)
<class 'str'>
A interação com tipos enumerados é diferente dependendo se a
use_proto_plus
configuração está definida como true ou false. Para mais detalhes sobre as duas interfaces, consulte
a documentação de mensagens protobuf.
Controle de versões
Várias versões da API são mantidas ao mesmo tempo. Embora v25 possa ser a versão mais recente, as versões anteriores ainda estão acessíveis até serem desativadas. A biblioteca vai incluir classes de mensagens proto separadas que correspondem a cada versão ativa da API. Para acessar uma classe de mensagem de uma versão específica, forneça o parâmetro de palavra-chave version ao inicializar um cliente para que ele sempre retorne a instância dessa versão:
client = GoogleAdsService.load_from_storage(version="/google-ads/api/reference/rpc/v25/")
# The Campaign instance will be from the v25 version of the API.
campaign = client.get_type("Campaign")
Também é possível especificar a versão ao chamar os métodos get_service e get_type. Isso vai substituir a versão fornecida ao inicializar o cliente:
client = GoogleAdsService.load_from_storage()
# This will load the v25 version of the GoogleAdsService.
googleads_service = client.get_service(
"GoogleAdsService", version="v25")
client = GoogleAdsService.load_from_storage(version="v25")
# This will load the v23 version of a Campaign.
campaign = client.get_type("Campaign", version="v23")
Se nenhum parâmetro de palavra-chave version for fornecido, a biblioteca vai usar a versão mais recente por padrão. Uma lista atualizada das versões mais recentes e outras disponíveis
pode ser encontrada na seção de navegação à esquerda da
documentação de referência da API.