Recuperar referencias a todas las clases de protos necesarias para usar la API en Python puede ser detallado y requiere que tengas una comprensión intrínseca de la API o que cambies de contexto con frecuencia para hacer referencia a los protos o la documentación.
Los métodos get_service y get_type del cliente
Estos dos métodos de get te permiten recuperar cualquier servicio o objeto de tipo en la API. El método get_service se usa para recuperar clientes de servicio. get_type se usa para cualquier otro objeto. Las clases de cliente de servicio se definen en el código en la ruta de acceso a la versión google/ads/googleads/v*/services/services/, y todos los tipos se definen en las diversas categorías de objetos, google/ads/googleads/v*/common|enums|errors|resources|services/types/.
Se genera todo el código debajo del directorio de versión, por lo que se recomienda usar estos métodos en lugar de importar los objetos directamente, en caso de que cambie la estructura de la base de código.
A continuación, se muestra un ejemplo de cómo usar el método get_service para recuperar una instancia del 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")
Este es un ejemplo de cómo usar el método get_type para recuperar una instancia de Campaign.
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage(version="v18")
campaign = client.get_type("Campaign")
Enumeraciones
Si bien puedes usar el método get_type para recuperar enums, cada instancia de GoogleAdsClient también tiene un atributo enums que carga enums de forma dinámica con el mismo mecanismo que el método get_type. El objetivo de esta interfaz es ser más simple y fácil de leer que usar get_type:
client = GoogleAdsClient.load_from_storage(version=v18)
campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
Los campos de objetos proto que son enums se representan en Python con el tipo nativo enum. Eso significa que puedes
leer fácilmente el valor del miembro. Trabajar con la instancia de campaign del ejemplo anterior en una repl de Python:
>>> print(campaign.status)
CampaignStatus.PAUSED
>>> type(campaign.status)
<enum 'CampaignStatus'>
>>> print(campaign.status.value)
3
A veces, es útil conocer el nombre del campo que corresponde al valor de enumeración, como se muestra arriba. Puedes acceder a esta información con el atributo name:
>>> print(campaign.status.name)
'PAUSED'
>>> type(campaign.status.name)
<class 'str'>
La interacción con las enums es diferente según si tienes la configuración de use_proto_plus establecida en true o false. Para obtener detalles sobre las dos interfaces, consulta la documentación de los mensajes de protobuf.
Control de versiones
Se mantienen varias versiones de la API al mismo tiempo. Si bien
v18 puede ser la versión más reciente, se puede acceder
a las versiones anteriores hasta que se desactiven. La biblioteca incluirá clases de mensajes proto separadas que correspondan a cada versión activa de la API. Para acceder a una clase de mensaje para una versión específica, proporciona el parámetro de palabra clave version cuando inicialices un cliente para que siempre devuelva la instancia de esa versión determinada:
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")
También es posible especificar la versión cuando se llama a los métodos get_service y get_type. De esta manera, se anulará la versión proporcionada cuando se inicialice el 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")
Si no se proporciona ningún parámetro de palabra clave version, la biblioteca usará la versión más reciente de forma predeterminada. Puedes encontrar una lista actualizada de las versiones más recientes y otras disponibles en la sección de navegación de la izquierda de la documentación de la Referencia de la API.