Mensagens protobuf

A versão 14.0.0 da biblioteca de cliente Python introduz um novo parâmetro de configuração obrigatório chamado use_proto_plus, que especifica se você quer que a biblioteca retorne mensagens proto-plus ou mensagens protobuf. Para mais detalhes sobre como definir esse parâmetro, consulte os documentos de configuração.

Nesta seção, descrevemos as implicações de desempenho da escolha dos tipos de mensagens a serem usadas. Portanto, recomendamos que você leia e entenda as opções para tomar uma decisão informada. No entanto, se você quiser fazer upgrade para a versão 14.0.0 sem fazer mudanças no código, defina use_proto_plus como True para evitar alterações interruptivas na interface.

Mensagens Proto-plus x protobuf

Na versão 10.0.0, a biblioteca de cliente Python migrou para um novo pipeline gerador de código que integrou o proto-plus como uma forma de melhorar a ergonomia da interface de mensagens protobuf fazendo com que ela se comporte mais como objetos nativos do Python. A desvantagem dessa melhoria é que o proto-plus introduz sobrecarga no desempenho.

Performance Proto-plus

Um dos principais benefícios do proto-plus é que ele converte mensagens protobuf e tipos conhecidos para tipos nativos do Python usando um processo chamado marshaling 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 de 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 str nativo do Python para um tipo string para que o valor seja compatível com o ambiente de execução do protobuf.

Na análise que realizamos desde o lançamento da versão 10.0.0, determinamos que o tempo gasto com essas conversões de tipo tem um impacto no desempenho grande o suficiente para que seja importante oferecer aos usuários a opção de usar mensagens protobuf.

Casos de uso para mensagens proto-plus e protobuf

Casos de uso de mensagens Proto-plus

O Proto-plus oferece uma série de melhorias ergonômicas em relação às mensagens protobuf e é ideal para programar um código legível e fácil de manter. Por exporem objetos nativos do Python, são mais fáceis de usar e entender.

Casos de uso de mensagens protobuf

Use protobufs para casos de uso sensíveis ao desempenho, especificamente em apps que precisam processar relatórios grandes rapidamente ou que criam solicitações de modificação com um grande número de operações, por exemplo, com BatchJobService ou OfflineUserDataJobService.

Como mudar dinamicamente os tipos de mensagens

Depois de selecionar o tipo de mensagem adequado para seu app, talvez seja necessário usar o outro tipo para um fluxo de trabalho específico. Nesse caso, é fácil alternar entre os dois tipos dinamicamente 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 da interface de mensagens protobuf

A interface proto-plus é documentada em detalhes, mas aqui destacamos algumas diferenças importantes que afetam casos de uso comuns da biblioteca de cliente do Google Ads.

Serialização de bytes

Mensagens 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 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 pela api-core foi projetado para usar instâncias de mensagem protobuf. Portanto, ao usar mensagens proto-plus, converta-as em mensagens protobuf para utilizar o auxiliar:

Mensagens 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

Os tipos enumerados expostos por mensagens proto-plus são instâncias do tipo enum nativo do Python e, portanto, herdam vários métodos de conveniência.

Recuperação do tipo de enumeração

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

Mensagens Proto-plus

val = client.get_type("CampaignStatusEnum").CampaignStatus.PAUSED

Mensagens protobuf

val = client.get_type("CampaignStatusEnum").PAUSED

Para simplificar a recuperação de tipos enumerados, há um atributo de conveniência em instâncias de 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 enumeração

À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 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 de nomes de enumeração

Às vezes, é útil saber o nome de um campo de enumeração. Por exemplo, ao ler objetos da API, pode ser necessário saber a qual status de campanha o inte 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 nos documentos proto-plus, os campos repetidos são geralmente equivalentes a listas tipadas, o que significa que eles se comportam quase de maneira idêntica a um list.

Como anexar a campos escalares repetidos

Quando você adiciona valores a campos de tipo escalar repetidos, como os campos string ou int64, a interface é a mesma, independente do tipo de mensagem:

Mensagens Proto-plus

ad.final_urls.append("https://www.example.com")

Mensagens protobuf

ad.final_urls.append("https://www.example.com")

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

Mensagens 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"])

Como anexar tipos de mensagens a campos repetidos

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

Mensagens 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

Como atribuir campos repetidos

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

Mensagens 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 alguma informação ou se algum dos campos está definido.

Mensagens 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

Texto da mensagem

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

client.copy_from(campaign, other_campaign)

Campos de mensagem vazios

O processo de configuração de campos de mensagem vazios é o mesmo, independentemente do tipo de mensagem usado. Basta copiar uma mensagem vazia para o 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 campo que são palavras reservadas

Ao usar mensagens proto-plus, os nomes dos campos aparecem automaticamente com um sublinhado no final se o nome também for uma palavra reservada no Python. Veja um exemplo de como trabalhar com uma instância de 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 programaticamente.

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 mensagem protobuf têm valores padrão, nem sempre é intuitivo saber se um campo foi definido ou não.

Mensagens 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 em uma mensagem foi definido, mesmo que tenha sido definido como um valor padrão.

Métodos de mensagem protobuf

A interface de mensagens protobuf inclui alguns métodos de conveniência que não fazem parte da interface proto-plus. No entanto, é simples acessá-los convertendo uma mensagem proto-plus na 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 alguma dúvida sobre essas mudanças ou problemas para migrar para a versão 14.0.0 da biblioteca, registre um problema no nosso rastreador.