Protobuf 訊息

您可以使用 use_proto_plus 設定參數，指定程式庫要傳回 proto-plus 訊息還是 protobuf 訊息。如要進一步瞭解如何設定這個參數，請參閱設定說明文件。

本節說明選擇要使用的訊息類型對成效的影響，因此建議您詳閱並瞭解這些選項，以便做出明智的決定。

Proto-plus 與 protobuf 訊息

程式碼產生器管道會整合 proto-plus，藉此改善 protobuf 訊息介面的人因設計，讓其行為更像原生 Python 物件。不過，這表示使用 proto-plus 會導致效能額外負擔。

Proto-plus 效能

Proto-plus 的核心優點之一，是透過稱為型別封裝的程序，將 protobuf 訊息和已知類型轉換為原生 Python 類型。

在 proto-plus 訊息例項上存取欄位時，就會發生配對作業，尤其是在讀取或設定欄位時，例如在 protobuf 定義中：

syntax = "proto3";

message Dog {
  string name = 1;
}

當這個定義轉換為 proto-plus 類別時，會如下所示：

import proto

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

接著，您可以初始化 Dog 類別，並像存取任何其他 Python 物件一樣存取其 name 欄位：

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

讀取及設定 name 欄位時，系統會將值從原生 Python str 類型轉換為 string 類型，以便與 protobuf 執行階段相容。

根據成效分析，我們判斷這類轉換所需的時間會對成效造成相當大的影響，因此使用者應根據自身需求決定是否要使用 protobuf 訊息。

Proto-Plus 和 protobuf 訊息的用途

Proto-plus 訊息用途

Proto-plus 提供比 protobuf 訊息更人性化的改善功能，因此非常適合用於編寫可維護且易讀的程式碼。由於這些物件會公開原生 Python 物件，因此更容易使用和理解。

Protobuf 訊息用途

請在需要快速處理大量報表或建立大量作業的應用程式中使用 protobuf，例如使用 BatchJobService 或 OfflineUserDataJobService 時。

動態變更訊息類型

為應用程式選取適當的訊息類型後，您可能會發現需要使用其他類型來處理特定工作流程。在這種情況下，您可以使用用戶端程式庫提供的實用工具，輕鬆地在兩種型別之間動態切換。使用上述相同的 Dog 訊息類別：

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)

Protobuf 訊息介面差異

我們已詳細記錄 proto-plus 介面，但這裡將強調一些影響 Google Ads 用戶端程式庫常見用途的關鍵差異。

位元組序列化

Proto-plus 訊息

serialized = type(campaign).serialize(campaign)
deserialized = type(campaign).deserialize(serialized)

Protobuf 訊息

serialized = campaign.SerializeToString()
deserialized = campaign.FromString(serialized)

JSON 序列化

Proto-plus 訊息

serialized = type(campaign).to_json(campaign)
deserialized = type(campaign).from_json(serialized)

Protobuf 訊息

from google.protobuf.json_format import MessageToJson, Parse

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

欄位遮罩

api-core 提供的欄位遮罩輔助程式方法，旨在使用 protobuf 訊息例項。因此，在使用 proto-plus 訊息時，請將訊息轉換為 protobuf 訊息，以便使用輔助程式：

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)

Protobuf 訊息

from google.api_core.protobuf_helpers import field_mask

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

列舉

proto-plus 訊息公開的列舉是 Python 原生 enum 類型的例項，因此會繼承多種方便方法。

列舉類型擷取

使用 GoogleAdsClient.get_type 方法擷取列舉時，傳回的訊息會因您使用的是 proto-plus 還是 protobuf 訊息而略有不同。例如：

Proto-plus 訊息

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

Protobuf 訊息

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

為了讓擷取列舉變得更簡單，GoogleAdsClient 例項上有一個方便使用的屬性，無論您使用哪種訊息類型，這個屬性都會提供一致的介面：

val = client.enums.CampaignStatusEnum.PAUSED

列舉值擷取

有時您可能需要知道特定列舉的值或欄位 ID，例如 CampaignStatusEnum 上的 PAUSED 對應至 3：

Proto-plus 訊息

campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
# To read the value of campaign status
print(campaign.status.value)

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))

擷取列舉名稱

有時您可能需要知道列舉欄位的名稱。舉例來說，當您從 API 讀取物件時，可能會想知道 int 3 對應的廣告活動狀態：

Proto-plus 訊息

campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED
# To read the name of campaign status
print(campaign.status.name)

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)

重複欄位

如proto-plus 說明文件所述，重複欄位通常等同於指定類型的清單，也就是說，這些欄位的行為幾乎與 list 相同。

在重複的純量欄位中附加值

當您在重複的純量類型欄位 (例如 string 或 int64 欄位) 中新增值時，無論訊息類型為何，介面都會相同：

Proto-plus 訊息

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

Protobuf 訊息

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

這也包括所有其他常見的 list 方法，例如 extend：

Proto-plus 訊息

ad.final_urls.extend(["https://www.example.com", "https://www.example.com/2"])

Protobuf 訊息

ad.final_urls.extend(["https://www.example.com", "https://www.example.com/2"])

在重複欄位中附加訊息類型

如果重複欄位不是標量類型，將這些欄位新增至重複欄位的行為會稍有不同：

Proto-plus 訊息

frequency_cap = client.get_type("FrequencyCapEntry")
frequency_cap.cap = 100
campaign.frequency_caps.append(frequency_cap)

Protobuf 訊息

# The add method initializes a message and adds it to the repeated field
frequency_cap = campaign.frequency_caps.add()
frequency_cap.cap = 100

指派重複欄位

無論是標量和非標量重複欄位，您都可以透過不同方式將清單指派給欄位：

Proto-plus 訊息

# In proto-plus it's possible to use assignment.
urls = ["https://www.example.com"]
ad.final_urls = urls

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

空白訊息

有時您可能需要知道訊息例項是否包含任何資訊，或是否已設定任何欄位。

Proto-plus 訊息

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

Protobuf 訊息

is_empty = campaign.ByteSize() == 0

訊息內容

對於 proto-plus 和 protobuf 訊息，我們建議在 GoogleAdsClient 上使用 copy_from 輔助程式方法：

client.copy_from(campaign, other_campaign)

空白訊息欄位

無論您使用哪種訊息類型，設定空白訊息欄位的程序都相同。只要將空白訊息複製到相關欄位即可。請參閱「訊息副本」一節，以及「空白訊息欄位」指南。以下是如何設定空白訊息欄位的範例：

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

保留字詞的欄位名稱

使用 proto-plus 訊息時，如果欄位名稱也是 Python 中的保留字，則系統會自動在名稱後方加上底線。以下是使用 Asset 例項的範例：

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

保留名稱的完整清單是在 gapic 產生器模組中建構。也可以透過程式存取。

首先，請安裝模組：

python -m pip install gapic-generator

接著，在 Python REPL 或指令碼中執行以下操作：

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

欄位狀態

由於 protobuf 訊息例項的欄位具有預設值，因此無法直接判斷是否已設定欄位。

Proto-plus 訊息

# Use the "in" operator.
has_field = "name" in campaign

Protobuf 訊息

campaign = client.get_type("Campaign")
# Determines whether "name" is set and not just an empty string.
campaign.HasField("name")

protobuf Message 類別介面具有 HasField 方法，可判斷訊息上的欄位是否已設定，即使已設為預設值也一樣。

Protobuf 訊息方法

protobuf 訊息介面包含一些便利方法，這些方法並非 proto-plus 介面的一部分；不過，只要將 proto-plus 訊息轉換為 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

如果您對這些異動有任何疑問，或在遷移至最新版程式庫時遇到任何問題，請在追蹤器中回報問題。