La récupération de références à toutes les différentes classes de proto requises pour utiliser l'API en Python peut être longue et nécessiter une compréhension intrinsèque de l'API ou des changements de contexte fréquents pour référencer les protos ou la documentation.
Les méthodes get_service et get_type du client
Ces deux méthodes de getter vous permettent de récupérer n'importe quel service ou objet de type dans l'API. La méthode get_service permet de récupérer des clients de service. get_type est utilisé pour tout autre objet. Les classes de client de service sont définies dans le code sous le chemin de version google/ads/googleads/v*/services/services/, et tous les types sont définis sous les différentes catégories d'objets, google/ads/googleads/v*/common|enums|errors|resources|services/types/.
Tout le code sous le répertoire de version est généré. Il est donc recommandé d'utiliser ces méthodes plutôt que d'importer directement les objets, au cas où la structure du codebase changerait.
Voici un exemple d'utilisation de la méthode get_service pour récupérer une instance du client 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")
Voici un exemple d'utilisation de la méthode get_type pour récupérer une instance Campaign.
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage(version="v18")
campaign = client.get_type("Campaign")
Enums
Bien que vous puissiez utiliser la méthode get_type pour récupérer des énumérations, chaque instance GoogleAdsClient possède également un attribut enums qui charge dynamiquement des énumérations à l'aide du même mécanisme que la méthode get_type. Cette interface est conçue pour être plus simple et plus facile à lire que l'utilisation de get_type:
client = GoogleAdsClient.load_from_storage(version=v18)
campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
Les champs d'objet Proto qui sont des énumérations sont représentés en Python par le type natif enum. Cela signifie que vous pouvez facilement lire la valeur du membre. Utilisation de l'instance campaign de l'exemple précédent dans un repl Python:
>>> print(campaign.status)
CampaignStatus.PAUSED
>>> type(campaign.status)
<enum 'CampaignStatus'>
>>> print(campaign.status.value)
3
Il est parfois utile de connaître le nom du champ qui correspond à la valeur d'énumération, comme indiqué ci-dessus. Vous pouvez accéder à ces informations à l'aide de l'attribut name:
>>> print(campaign.status.name)
'PAUSED'
>>> type(campaign.status.name)
<class 'str'>
L'interaction avec les énumérations varie selon que la configuration use_proto_plus est définie sur true ou false. Pour en savoir plus sur les deux interfaces, consultez la documentation sur les messages protobuf.
Gestion des versions
Plusieurs versions de l'API sont gérées en même temps. Bien que v18 soit la dernière version, les versions antérieures restent accessibles jusqu'à leur abandon. La bibliothèque comprendra des classes de messages proto distinctes qui correspondent à chaque version d'API active. Pour accéder à une classe de messages pour une version spécifique, fournissez le paramètre de mot clé version lors de l'initialisation d'un client afin qu'il renvoie toujours une instance de cette version donnée:
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")
Il est également possible de spécifier la version lors de l'appel des méthodes get_service et get_type. Cette opération remplace la version fournie lors de l'initialisation du client:
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 aucun paramètre de mot clé version n'est fourni, la bibliothèque utilise par défaut la dernière version. Vous trouverez une liste à jour des dernières versions et des autres versions disponibles dans la section de navigation de gauche de la documentation de référence de l'API.