Preenchimento de código do IDE

Ambientes de desenvolvimento integrado como o VS Code e o PyCharm oferecem preenchimento automático de código integrado para a linguagem Python.

A biblioteca google-ads-python gera classes de mensagem protobuf dinamicamente no ambiente de execução usando métodos getter na classe GoogleAdsClient, o que pode inibir os recursos de preenchimento de código do ambiente de desenvolvimento integrado que dependem da análise estática do código-fonte.

Para melhorar a compatibilidade com ferramentas de preenchimento de código que dependem de análise estática, você pode:

  1. Use anotações de tipo com métodos getter dinâmicos (recomendado).
  2. Importe classes de mensagens protobuf e clientes de serviço diretamente.

Importações dinâmicas com dicas de tipo

O uso de importações dinâmicas garante que seu código permaneça resiliente em todas as atualizações da biblioteca. Adicionar anotações de tipo permite o preenchimento automático de código do ambiente de desenvolvimento integrado sem perder os benefícios da inicialização dinâmica:

from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.v26.resources.types.campaign import (
    Campaign,
)

client = GoogleAdsClient.load_from_storage()

# Type hints allow the IDE to provide code completion suggestions while
# retaining dynamic class generation.
campaign: Campaign = client.get_type("Campaign")

Importações diretas

Também é possível importar classes de mensagens protobuf diretamente. Essa abordagem permite o preenchimento automático de código do ambiente de desenvolvimento integrado, sem usar métodos getter:

from google.ads.googleads.v26.resources import Campaign

# The Campaign class is imported directly, enabling the IDE to read the
# class definition and make code completion suggestions.
campaign = Campaign()

Desvantagens das importações diretas

Embora a importação direta de classes geradas ajude no preenchimento de código, ela também apresenta algumas desvantagens:

  1. Mais difícil de localizar: nem sempre é óbvio em qual módulo uma determinada classe está localizada. Por isso, pode ser difícil encontrar o caminho de importação correto.
  2. Frágil em upgrades: a estrutura de diretórios das classes geradas pode mudar com as novas versões da biblioteca de cliente. Se você importar classes diretamente, seu código poderá ser corrompido ao fazer upgrade, enquanto o código que usa métodos getter não será afetado por esses tipos de mudanças.
  3. Inicialização manual necessária: o método get_service inicializa serviços com autenticação, configurações de transporte e interceptadores gRPC (que anexam cabeçalhos como login-customer-id e linked-customer-id, processam a geração de registros e agrupam erros em GoogleAdsException) antes de retorná-los. Se você importar e instanciar serviços diretamente, esses interceptadores serão ignorados, e você precisará configurar as credenciais e os canais de transporte manualmente:

    from google.ads.googleads.v26.services.services import (
        campaign_service as campaign_service_module,
    )
    
    # Dynamic service getter (initializes credentials, transport, and gRPC
    # interceptors automatically).
    campaign_service = client.get_service("CampaignService")
    
    # Direct service client import (requires manual credential and interceptor
    # configuration).
    campaign_service_client = campaign_service_module.CampaignServiceClient(
        credentials=client.credentials,
    )