Getters de serviço e tipo

A busca de referências para todas as várias classes proto necessárias para usar a API em Python pode ser detalhada e exige que você tenha um entendimento intrínseco da API ou alterne o contexto com frequência para fazer referência aos protos ou à documentação.

Os métodos get_service e get_type do cliente

Esses dois métodos de getter permitem que você recupere qualquer serviço ou objeto de 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 abaixo do diretório de versão é gerado. Portanto, é uma prática recomendada usar esses métodos em vez de importar os objetos diretamente, caso a estrutura do código-base 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 v18 version of GoogleAdsService will
# be returned.
client = GoogleAdsClient.load_from_storage(version="v18")
googleads_service = client.get_service("GoogleAdsService")

Confira um exemplo de como usar o método get_type para recuperar uma instância Campaign.

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage(version="v18")
campaign = client.get_type("Campaign")

Enums

Embora seja possível usar o método get_type para extrair enumerações, cada instância GoogleAdsClient também tem um atributo enums que carrega enumerações dinamicamente usando o mesmo mecanismo do método get_type. Essa interface tem como objetivo ser mais simples e fácil de ler do que usar get_type:

client = GoogleAdsClient.load_from_storage(version=v18)

campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED

Os campos de objeto proto que são tipos enumerados são representados em Python pelo tipo enum nativo. Isso significa que você pode ler facilmente o valor do membro. Como trabalhar 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 os tipos enumerados é diferente dependendo se a configuração use_proto_plus está definida como true ou false. Para saber mais 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 v18 seja a versão mais recente, as versões anteriores ainda estão acessíveis até a desativação. A biblioteca vai incluir classes de protomensagens separadas que correspondem a cada versão ativa da API. Para acessar uma classe de mensagens 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/v18/")
# The Campaign instance will be from the v18 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 v18 version of the GoogleAdsService.
googleads_service = client.get_service(
    "GoogleAdsService", version="v18")

client = GoogleAdsService.load_from_storage(version="v18")
# This will load the v16 version of a Campaign.
campaign = client.get_type("Campaign", version="v16")

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 da Referência da API.