Mensagens protobuf

Com o parâmetro de configuração use_proto_plus, é possível especificar se você quer que a biblioteca retorne mensagens proto-plus ou mensagens protobuf. Para detalhes sobre como definir esse parâmetro, consulte a documentação de configuração.

Esta seção descreve as implicações de desempenho da escolha dos tipos de mensagens a serem usadas. Por isso, recomendamos que você leia e entenda as opções para tomar uma decisão informada.

Mensagens proto-plus x protobuf

O pipeline do gerador de código integra o proto-plus como uma forma de melhorar a ergonomia da interface de mensagens protobuf, fazendo com que elas se comportem mais como objetos nativos do Python. No entanto, isso significa que o uso do proto-plus introduz uma sobrecarga de desempenho.

Performance do proto-plus

Um dos principais benefícios do proto-plus é que ele converte mensagens protobuf e tipos conhecidos em tipos nativos do Python por um processo chamado marshalização de tipos.

O marshaling ocorre quando um campo é acessado em uma instância de mensagem proto-plus, especificamente quando um campo é lido ou definido, por exemplo, em uma definição protobuf:

syntax = "proto3";

message Dog {
  string name = 1;
}

Quando essa definição é convertida em uma classe proto-plus, ela fica assim:

import proto

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

Em seguida, inicialize a classe Dog e acesse o campo name como faria com qualquer outro objeto Python:

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

Ao ler e definir o campo name, o valor é convertido de um tipo Python str nativo para um tipo string para que seja compatível com o tempo de execução do protobuf.

Com base nas nossas análises de performance, determinamos que o tempo gasto fazendo essas conversões de tipo tem um impacto de performance grande o suficiente para que os usuários decidam, com base nas necessidades deles, se devem ou não usar mensagens protobuf.

Casos de uso para mensagens proto-plus e protobuf

Casos de uso de mensagens proto-plus
O Proto-plus oferece várias melhorias ergonômicas em relação às mensagens protobuf, o que o torna ideal para escrever código legível e fácil de manter. Como eles expõem objetos nativos do Python, são mais fáceis de usar e entender.
Casos de uso de mensagens do Protobuf
Use protobufs em casos de uso sensíveis à performance, principalmente em apps que precisam processar relatórios grandes rapidamente ou que criam solicitações de mutação com um grande número de operações, por exemplo, com BatchJobService ou OfflineUserDataJobService.

Mudança dinâmica de tipos de mensagens

Depois de selecionar o tipo de mensagem adequado para seu app, talvez você precise usar o outro tipo para um fluxo de trabalho específico. Nesse caso, é fácil alternar entre os dois tipos de forma dinâmica usando utilitários oferecidos pela biblioteca de cliente. Usando a mesma classe de mensagem Dog acima:

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)

Diferenças na interface de mensagens Protobuf

A interface proto-plus está documentada em detalhe, mas aqui vamos destacar algumas diferenças importantes que afetam casos de uso comuns da biblioteca de cliente do Google Ads.

Serialização de bytes

Mensagens do proto-plus
serialized = type(campaign).serialize(campaign)
deserialized = type(campaign).deserialize(serialized)
Mensagens protobuf
serialized = campaign.SerializeToString()
deserialized = campaign.FromString(serialized)

Serialização JSON

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

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

Máscaras de campo

O método auxiliar de máscara de campo fornecido por api-core foi projetado para usar instâncias de mensagens protobuf. Portanto, ao usar mensagens proto-plus, converta-as em mensagens protobuf para usar o helper:

Mensagens do 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)
Mensagens protobuf
from google.api_core.protobuf_helpers import field_mask

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

Enums

As enumerações expostas por mensagens proto-plus são instâncias do tipo nativo enum do Python e, portanto, herdam vários métodos convenientes.

Recuperação de tipo de enumeração

Ao usar o método GoogleAdsClient.get_type para recuperar enums, as mensagens retornadas são um pouco diferentes dependendo se você está usando mensagens proto-plus ou protobuf. Exemplo:

Mensagens do proto-plus
val = client.get_type("CampaignStatusEnum").CampaignStatus.PAUSED
Mensagens protobuf
val = client.get_type("CampaignStatusEnum").PAUSED

Para simplificar a recuperação de enums, há um atributo de conveniência em instâncias GoogleAdsClient que tem uma interface consistente, independente do tipo de mensagem que você está usando:

val = client.enums.CampaignStatusEnum.PAUSED

Recuperação de valores de tipo enumerado

Às vezes, é útil saber o valor ou o ID do campo de uma determinada enumeração. Por exemplo, PAUSED em CampaignStatusEnum corresponde a 3:

Mensagens do proto-plus
campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
# To read the value of campaign status
print(campaign.status.value)
Mensagens 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))

Recuperação do nome da enumeração

Às vezes, é útil saber o nome de um campo de enumeração. Por exemplo, ao ler objetos da API, talvez você queira saber a qual status de campanha o int 3 corresponde:

Mensagens proto-plus
campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
# To read the name of campaign status
print(campaign.status.name)
Mensagens 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)

Campos repetidos

Conforme descrito na documentação do proto-plus, os campos repetidos geralmente são equivalentes a listas tipadas, o que significa que eles se comportam quase da mesma forma que um list.

Adicionar valores a campos escalares repetidos

Ao adicionar valores a campos repetidos do tipo escalar, por exemplo, campos string ou int64, a interface é a mesma, independente do tipo de mensagem:

Mensagens do proto-plus
ad.final_urls.append("https://www.example.com")
Mensagens protobuf
ad.final_urls.append("https://www.example.com")

Isso inclui todos os outros métodos list comuns também, por exemplo, extend:

Mensagens do proto-plus
ad.final_urls.extend(["https://www.example.com", "https://www.example.com/2"])
Mensagens protobuf
ad.final_urls.extend(["https://www.example.com", "https://www.example.com/2"])

Adicionar tipos de mensagens a campos repetidos

Se o campo repetido não for um tipo escalar, o comportamento ao adicioná-los a campos repetidos será um pouco diferente:

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

Atribuir campos repetidos

Para campos repetidos escalares e não escalares, é possível atribuir listas ao campo de diferentes maneiras:

Mensagens do proto-plus
# In proto-plus it's possible to use assignment.
urls = ["https://www.example.com"]
ad.final_urls = urls
Mensagens 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

Mensagens vazias

Às vezes, é útil saber se uma instância de mensagem contém informações ou se algum dos campos dela está definido.

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

Cópia da mensagem

Para mensagens proto-plus e protobuf, recomendamos usar o método auxiliar copy_from no GoogleAdsClient:

client.copy_from(campaign, other_campaign)

Campos de mensagem vazios

O processo para definir campos de mensagens vazios é o mesmo, independente do tipo de mensagem que você está usando. Basta copiar uma mensagem vazia no campo em questão. Consulte a seção Cópia da mensagem e o guia Campos de mensagem vazios. Confira um exemplo de como definir um campo de mensagem vazio:

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

Nomes de campos que são palavras reservadas

Ao usar mensagens proto-plus, os nomes de campos aparecem automaticamente com um sublinhado à direita se o nome também for uma palavra reservada em Python. Confira um exemplo de como trabalhar com uma instância Asset:

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

A lista completa de nomes reservados é criada no módulo gerador gapic. Ele também pode ser acessado de forma programática.

Primeiro, instale o módulo:

python -m pip install gapic-generator

Em seguida, em um REPL ou script Python:

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

Presença de campo

Como os campos nas instâncias de mensagens protobuf têm valores padrão, nem sempre é intuitivo saber se um campo foi definido ou não.

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

A interface da classe protobuf Message tem um método HasField que determina se o campo de uma mensagem foi definido, mesmo que tenha sido definido como um valor padrão.

Métodos de mensagens protobuf

A interface de mensagens protobuf inclui alguns métodos convenientes que não fazem parte da interface proto-plus. No entanto, é simples acessá-los convertendo uma mensagem proto-plus para a contraparte 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())

Issue tracker

Se você tiver dúvidas sobre essas mudanças ou problemas ao migrar para a versão mais recente da biblioteca, registre um problema no nosso rastreador.