Utilitaire de recherche

Pour récupérer des références aux classes proto lorsque vous utilisez l'API, vous devez soit avoir une compréhension intrinsèque de l'API, soit consulter fréquemment la documentation de référence proto pour connaître le chemin d'espace de noms exact.

ProtoLookupUtil

Les méthodes utilitaires de recherche sur GoogleAdsClient (basées sur Factories et ServiceLookup, qui remplacent l'ancienne classe ProtoLookupUtil) vous permettent de rechercher et de créer des instances de services, d'opérations, d'énumérations et de ressources sans avoir à suivre les numéros de version de l'API ni les espaces de noms des modules. Par défaut, ces méthodes utilisent la version d'API la plus élevée prise en charge par votre gem installé (V25 dans la dernière version, où les versions d'API mineures telles que v25.1 utilisent leur module de version majeure V25). Vous pouvez également spécifier un préfixe de version explicite (tel que v25) dans l'appel de recherche.

Sans l'utilitaire de recherche, vous instanciez une ressource de campagne directement à partir de son espace de noms versionné :

campaign =
  Google::Ads::GoogleAds::V25::Resources::Campaign.new

Avec les méthodes de recherche de client, vous pouvez instancier la ressource directement à partir du client :

campaign = client.resource.campaign

Lors de la récupération d'une ressource, d'un service ou d'une opération, une instance de cette entité est renvoyée :

# Instantiate an operation
operation = client.operation.campaign

Recherche de services

Utilisez la méthode client.service pour récupérer les clients de service, même si vous n'utilisez pas cet utilitaire pour d'autres entités. client.service configure automatiquement vos identifiants d'authentification et vos paramètres de transport sur le client de service renvoyé :

campaign_service = client.service.campaign

Recherche d'énumération

Pour les champs d'énumération dans les messages protobuf, attribuez directement un symbole Ruby au lieu de rechercher le module d'énumération :

campaign.status = :PAUSED

Pour inspecter ou parcourir tous les symboles valides d'une énumération au moment de l'exécution, utilisez client.enum, qui renvoie le Google::Protobuf::EnumDescriptor pour cette énumération :

status_enum = client.enum.campaign_status
status_enum.each { |status| p status }