Finalización de código en el IDE

Los IDE, como VS Code y PyCharm, ofrecen finalización de código integrada para el lenguaje Python.

La biblioteca google-ads-python genera clases de mensajes de protobuf de forma dinámica en el entorno de ejecución con métodos get en la clase GoogleAdsClient, lo que puede inhibir las funciones de finalización de código del IDE que dependen del análisis estático del código fuente.

Para mejorar la compatibilidad con las herramientas de finalización de código que se basan en el análisis estático, puedes hacer lo siguiente:

  1. Usa anotaciones de tipo con métodos get dinámicos (recomendado).
  2. Importa clases de mensajes de protobuf y clientes de servicio directamente.

Importaciones dinámicas con sugerencias de tipo

El uso de importaciones dinámicas garantiza que tu código siga siendo resiliente en las actualizaciones de la biblioteca. Agregar anotaciones de tipo habilita la finalización de código del IDE sin perder los beneficios de la inicialización 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")

Importaciones directas

También puedes importar clases de mensajes de protobuf directamente. Este enfoque habilita la finalización de código del IDE de forma inmediata, sin usar métodos get:

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()

Desventajas de las importaciones directas

Si bien importar directamente las clases generadas ayuda a completar el código, también presenta algunas desventajas:

  1. Más difícil de ubicar: No siempre es obvio en qué módulo se encuentra una clase determinada, por lo que puede ser difícil encontrar la ruta de importación correcta.
  2. Inestabilidad en las actualizaciones: La estructura de directorios de las clases generadas puede cambiar con las versiones nuevas de la biblioteca cliente. Si importas clases directamente, es posible que tu código se rompa cuando actualices, mientras que el código que usa métodos get no se verá afectado por estos tipos de cambios.
  3. Se requiere inicialización manual: El método get_service inicializa los servicios con autenticación, configuración de transporte e interceptores de gRPC (que adjuntan encabezados como login-customer-id y linked-customer-id, controlan el registro y unen los errores en GoogleAdsException) antes de devolverlos. Si importas y creas instancias de servicios directamente, se omiten esos interceptores y debes configurar las credenciales y los canales de transporte de forma manual:

    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,
    )