Messages Protobuf

Avec le paramètre de configuration use_proto_plus, vous pouvez spécifier si la bibliothèque doit renvoyer des messages proto-plus ou des messages protobuf. Pour savoir comment définir ce paramètre, consultez la documentation de configuration.

Cette section décrit les conséquences sur les performances du choix des types de messages à utiliser. Nous vous recommandons donc de lire et de comprendre les options afin de prendre une décision éclairée.

Messages Proto-plus par rapport aux messages protobuf

Le pipeline du générateur de code intègre proto-plus afin d'améliorer l'ergonomie de l'interface de message protobuf en les faisant se comporter davantage comme des objets Python natifs. Toutefois, cela signifie que l'utilisation de proto-plus entraîne une surcharge des performances.

Performances de proto-plus

L'un des principaux avantages de proto-plus est qu'il convertit les messages de tampons de protocole et les types connus en types Python natifs via un processus appelé marshaling.

Le marshaling se produit lorsqu'un champ est consulté sur une instance de message proto-plus, en particulier lorsqu'un champ est lu ou défini, par exemple dans une définition de tampon de protocole:

syntax = "proto3";

message Dog {
  string name = 1;
}

Lorsque cette définition est convertie en classe proto-plus, elle se présente comme suit :

import proto

class Dog(proto.Message):
    name = proto.Field(proto.STRING, number=1)

Vous pouvez ensuite initialiser la classe Dog et accéder à son champ name comme vous le feriez pour n'importe quel autre objet Python :

dog = Dog()
dog.name = "Scruffy"
print(dog.name)

Lors de la lecture et de la définition du champ name, la valeur est convertie d'un type str Python natif en type string afin d'être compatible avec l'environnement d'exécution du tampon de protocole.

D'après nos analyses de performances, nous avons déterminé que le temps passé à effectuer ces conversions a un impact suffisamment important sur les performances pour que les utilisateurs puissent décider, en fonction de leurs besoins, d'utiliser ou non des messages de tampon de protocole.

Cas d'utilisation des messages proto-plus et protobuf

Cas d'utilisation des messages Proto-plus
Proto-plus offre un certain nombre d'améliorations ergonomiques par rapport aux messages protobuf. Il est donc idéal pour écrire du code lisible et facile à maintenir. Étant donné qu'ils exposent des objets Python natifs, ils sont plus faciles à utiliser et à comprendre.
Cas d'utilisation des messages Protobuf
Utilisez des protobufs pour les cas d'utilisation sensibles aux performances, en particulier dans les applications qui doivent traiter rapidement de grands rapports ou qui créent des requêtes de modification avec un grand nombre d'opérations, par exemple avec BatchJobService ou OfflineUserDataJobService.

Modifier dynamiquement les types de messages

Après avoir sélectionné le type de message approprié pour votre application, vous constaterez peut-être que vous devez utiliser l'autre type pour un workflow spécifique. Dans ce cas, il est facile de passer de manière dynamique d'un type à l'autre à l'aide des utilitaires proposés par la bibliothèque cliente. Utiliser la même classe de message Dog que ci-dessus:

from google.ads.googleads import util

# Proto-plus message type
dog = Dog()

# Protobuf message type
dog = util.convert_proto_plus_to_protobuf(dog)

# Back to proto-plus message type
dog = util.convert_protobuf_to_proto_plus(dog)

Différences entre les interfaces de message Protobuf

L'interface proto-plus est documentée en détail, mais nous allons ici mettre en évidence certaines différences clés qui affectent les cas d'utilisation courants de la bibliothèque cliente Google Ads.

Sérialisation des octets

Messages Proto-plus
serialized = type(campaign).serialize(campaign)
deserialized = type(campaign).deserialize(serialized)
Messages Protobuf
serialized = campaign.SerializeToString()
deserialized = campaign.FromString(serialized)

Sérialisation JSON

Messages proto-plus
serialized = type(campaign).to_json(campaign)
deserialized = type(campaign).from_json(serialized)
Messages Protobuf
from google.protobuf.json_format import MessageToJson, Parse

serialized = MessageToJson(campaign)
deserialized = Parse(serialized, campaign)

Masques de champ

La méthode d'assistance de masque de champ fournie par api-core est conçue pour utiliser des instances de message protobuf. Par conséquent, lorsque vous utilisez des messages proto-plus, convertissez-les en messages protobuf pour utiliser l'aide :

Messages Proto-plus
from google.api_core.protobuf_helpers import field_mask

campaign = client.get_type("Campaign")
protobuf_campaign = util.convert_proto_plus_to_protobuf(campaign)
mask = field_mask(None, protobuf_campaign)
Messages Protobuf
from google.api_core.protobuf_helpers import field_mask

campaign = client.get_type("Campaign")
mask = field_mask(None, campaign)

Enums

Les énumérations exposées par les messages proto-plus sont des instances du type natif enum de Python et héritent donc d'un certain nombre de méthodes pratiques.

Récupération du type d'énumération

Lorsque vous utilisez la méthode GoogleAdsClient.get_type pour récupérer des énumérations, les messages renvoyés sont légèrement différents selon que vous utilisez des messages proto-plus ou protobuf. Exemple :

Messages Proto-plus
val = client.get_type("CampaignStatusEnum").CampaignStatus.PAUSED
Messages Protobuf
val = client.get_type("CampaignStatusEnum").PAUSED

Pour simplifier la récupération des énumérations, il existe un attribut pratique sur les instances GoogleAdsClient ayant une interface cohérente, quel que soit le type de message que vous utilisez:

val = client.enums.CampaignStatusEnum.PAUSED

Récupération des valeurs d'énumération

Il est parfois utile de connaître la valeur ou l'ID de champ d'une énumération donnée. Par exemple, PAUSED sur CampaignStatusEnum correspond à 3:

Messages proto-plus
campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
# To read the value of campaign status
print(campaign.status.value)
Messages Protobuf
campaign = client.get_type("Campaign")
status_enum = client.enums.CampaignStatusEnum
campaign.status = status_enum.PAUSED
# To read the value of campaign status
print(status_enum.CampaignStatus.Value(campaign.status))

Récupération du nom de l'énumération

Il est parfois utile de connaître le nom d'un champ d'énumération. Par exemple, lorsque vous lisez des objets à partir de l'API, vous pouvez souhaiter connaître l'état de la campagne auquel l'entier 3 correspond :

Messages Proto-plus
campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
# To read the name of campaign status
print(campaign.status.name)
Messages Protobuf
campaign = client.get_type("Campaign")
status_enum = client.enums.CampaignStatusEnum
# Sets the campaign status to the int value for PAUSED
campaign.status = status_enum.PAUSED
# To read the name of campaign status
status_enum.CampaignStatus.Name(campaign.status)

Champs répétés

Comme décrit dans les documents proto-plus, les champs répétés sont généralement équivalents à des listes typées, ce qui signifie qu'ils se comportent presque de manière identique à un list.

Ajouter des valeurs à des champs scalaires répétés

Lorsque vous ajoutez des valeurs à des champs répétés de type scalaire, par exemple des champs string ou int64, l'interface est la même, quel que soit le type de message:

Messages Proto-plus
ad.final_urls.append("https://www.example.com")
Messages Protobuf
ad.final_urls.append("https://www.example.com")

Cela inclut également toutes les autres méthodes list courantes, par exemple extend :

Messages Proto-plus
ad.final_urls.extend(["https://www.example.com", "https://www.example.com/2"])
Messages Protobuf
ad.final_urls.extend(["https://www.example.com", "https://www.example.com/2"])

Ajouter des types de message aux champs répétés

Si le champ répété n'est pas de type scalaire, le comportement lors de son ajout à des champs répétés est légèrement différent:

Messages Proto-plus
frequency_cap = client.get_type("FrequencyCapEntry")
frequency_cap.cap = 100
campaign.frequency_caps.append(frequency_cap)
Messages Protobuf
# The add method initializes a message and adds it to the repeated field
frequency_cap = campaign.frequency_caps.add()
frequency_cap.cap = 100

Attribuer des champs répétés

Pour les champs répétés scalaires et non scalaires, vous pouvez attribuer des listes au champ de différentes manières :

Messages proto-plus
# In proto-plus it's possible to use assignment.
urls = ["https://www.example.com"]
ad.final_urls = urls
Messages Protobuf
# Protobuf messages do not allow assignment, but you can replace the
# existing list using slice syntax.
urls = ["https://www.example.com"]
ad.final_urls[:] = urls

Messages vides

Il est parfois utile de savoir si une instance de message contient des informations ou si l'un de ses champs est défini.

Messages Proto-plus
# When using proto-plus messages you can simply check the message for
# truthiness.
is_empty = bool(campaign)
is_empty = not campaign
Messages Protobuf
is_empty = campaign.ByteSize() == 0

Texte du message

Pour les messages proto-plus et protobuf, nous vous recommandons d'utiliser la méthode d'assistance copy_from sur GoogleAdsClient:

client.copy_from(campaign, other_campaign)

Champs du message vides

Le processus pour définir des champs de message vides est le même, quel que soit le type de message que vous utilisez. Il vous suffit de copier un message vide dans le champ en question. Consultez la section Texte du message et le guide sur les champs de message vides. Voici un exemple de paramétrage d'un champ de message vide :

client.copy_from(campaign.manual_cpm, client.get_type("ManualCpm"))

Noms de champs qui sont des mots réservés

Lorsque vous utilisez des messages proto-plus, les noms de champ s'affichent automatiquement avec un trait de soulignement à la fin s'ils sont également un mot réservé en Python. Voici un exemple d'utilisation d'une instance Asset :

asset = client.get_type("Asset")
asset.type_ = client.enums.AssetTypeEnum.IMAGE

La liste complète des noms réservés est créée dans le module gapic generator. Vous pouvez également y accéder de manière programmatique.

Commencez par installer le module:

python -m pip install gapic-generator

Ensuite, dans un REPL ou un script Python:

import gapic.utils
print(gapic.utils.reserved_names.RESERVED_NAMES)

Présence sur le terrain

Étant donné que les champs des instances de message protobuf ont des valeurs par défaut, il n'est pas toujours intuitif de savoir si un champ a été défini ou non.

Messages Proto-plus
# Use the "in" operator.
has_field = "name" in campaign
Messages Protobuf
campaign = client.get_type("Campaign")
# Determines whether "name" is set and not just an empty string.
campaign.HasField("name")

L'interface de classe protobuf Message comporte une méthode HasField qui détermine si le champ d'un message a été défini, même s'il a été défini sur une valeur par défaut.

Méthodes de message Protobuf

L'interface de message protobuf inclut des méthodes pratiques qui ne font pas partie de l'interface proto-plus. Toutefois, il est simple d'y accéder en convertissant un message proto-plus en son homologue protobuf :

# Accessing the ListFields method
protobuf_campaign = util.convert_protobuf_to_proto_plus(campaign)
print(campaign.ListFields())

# Accessing the Clear method
protobuf_campaign = util.convert_protobuf_to_proto_plus(campaign)
print(campaign.Clear())

Outil de suivi des problèmes

Si vous avez des questions sur ces modifications ou si vous rencontrez des problèmes lors de la migration vers la dernière version de la bibliothèque, signalez un problème dans notre outil de suivi.