التعامل مع أنواع protobuf

بما أنّ Google Ads API تستخدم proto3 كتنسيق تلقائي للحِمل، من المهم فهم بعض اصطلاحات وأنواع مخازن البروتوكولات المؤقتة عند استخدام مكتبة برامج .NET.

حقول اختيارية

يتم وضع علامة optional على العديد من الحقول في Google Ads API. يتيح لك ذلك التمييز بين الحالات التي يتضمّن فيها الحقل قيمة فارغة والحالات التي لا يعرض فيها الخادم قيمة للحقل. تتصرّف هذه الحقول مثل السمات العادية، ولكنّها توفّر أيضًا طرقًا إضافية لمحو الحقل والتحقّق مما إذا تم ضبطه.

على سبيل المثال، تم وضع علامة optional على الحقل Name الخاص بالكائن Campaign، لذا يمكنك استخدام الطرق التالية للتعامل مع هذا الحقل:

// Get the name.
string name = campaign.Name;

// Set the name.
campaign.Name = name;

// Check if the campaign object has the name field set.
bool hasName = campaign.HasName();

// Clear the name field. Use this method to exclude the Name field from
// being sent to the server in a subsequent API call.
campaign.ClearName();

// Set the campaign name to an empty string value. This value will be
// sent to the server if you use this object in a subsequent API call.
campaign.Name = "";

// This throws a runtime ArgumentNullException. Use ClearName() instead.
campaign.Name = null;

الحقول المتكررة

يتم تمثيل مصفوفة الحقول في Google Ads API كـ RepeatedField للقراءة فقط.

على سبيل المثال، حقل url_custom_parameters في الحملة هو حقل متكرّر، لذا يتم تمثيله كحقل RepeatedField<CustomParameter> للقراءة فقط في مكتبة برامج .NET. تنفّذ RepeatedField<T> الواجهة IList<T>.

هناك طريقتان لتعبئة السمة RepeatedField:

AddRange method

Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
};

// Add values to UrlCustomParameters using the AddRange method.
campaign.UrlCustomParameters.AddRange(new CustomParameter[]
{
    new CustomParameter { Key = "season", Value = "christmas" },
    new CustomParameter { Key = "promocode", Value = "NY123" }
});

بنية أداة تهيئة المجموعة

// Option 1: Initialize the field directly.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    // Directly initialize the field.
    UrlCustomParameters =
    {
        new CustomParameter { Key = "season", Value = "christmas" },
        new CustomParameter { Key = "promocode", Value = "NY123" }
    }
};

// Option 2: Initialize using an intermediate variable.
CustomParameter[] parameters = new CustomParameter[]
{
    new CustomParameter { Key = "season", Value = "christmas" },
    new CustomParameter { Key = "promocode", Value = "NY123" }
};

Campaign campaign1 = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    // Initialize from an existing array.
    UrlCustomParameters = { parameters }
};

حقول Oneof

يتم تصنيف بعض الحقول في Google Ads API على أنّها حقول oneof، ما يعني أنّ الحقل يمكن أن يتضمّن أنواعًا مختلفة ولكن قيمة واحدة فقط في وقت معيّن. تتشابه حقول oneof مع نوع الاتحاد في لغة البرمجة C.

تنفّذ مكتبة ‎ .NET الحقل oneof من خلال توفير سمة واحدة لكل نوع من القيم التي يمكن الاحتفاظ بها في الحقل oneof، مع تعديل جميع السمات لحقل تخزين أساسي مشترك.

على سبيل المثال، يتم وضع علامة campaign_bidding_strategy على oneof حقل الحملة. يتم تنفيذ هذه الفئة على النحو التالي (تم تبسيط الرمز للاختصار):

public sealed partial class Campaign : pb::IMessage<Campaign>
{
    object campaignBiddingStrategy_ = null;
    CampaignBiddingStrategyOneofCase campaignBiddingStrategyCase_;

    public ManualCpc ManualCpc
    {
        get
        {
            return campaignBiddingStrategyCase_ ==
                CampaignBiddingStrategyOneofCase.ManualCpc
                ? (ManualCpc)campaignBiddingStrategy_ : null;
        }
        set
        {
            campaignBiddingStrategy_ = value;
            campaignBiddingStrategyCase_ =
                CampaignBiddingStrategyOneofCase.ManualCpc;
        }
    }

    public ManualCpm ManualCpm
    {
        get
        {
            return campaignBiddingStrategyCase_ ==
                CampaignBiddingStrategyOneofCase.ManualCpm
                ? (ManualCpm)campaignBiddingStrategy_ : null;
        }
        set
        {
            campaignBiddingStrategy_ = value;
            campaignBiddingStrategyCase_ =
                CampaignBiddingStrategyOneofCase.ManualCpm;
        }
    }

    public CampaignBiddingStrategyOneofCase CampaignBiddingStrategyCase
    {
        get { return campaignBiddingStrategyCase_; }
    }
}

بما أنّ المواقع oneof تتشارك مساحة التخزين، يمكن أن يؤدي تعيين قيمة إلى الكتابة فوق قيمة سابقة، ما يؤدي إلى حدوث أخطاء طفيفة. على سبيل المثال:

Campaign campaign = new Campaign()
{
    ManualCpc = new ManualCpc(),
    ManualCpm = new ManualCpm()
};

في هذه الحالة، تكون قيمة campaign.ManualCpc هي null لأنّ تهيئة السمة campaign.ManualCpm تؤدي إلى الكتابة فوق عملية التهيئة السابقة للسمة campaign.ManualCpc.

التحويل إلى تنسيقات أخرى

التحويل إلى تنسيق JSON

يمكنك تحويل عناصر protobuf إلى تنسيق JSON والعكس باستخدام Google.Protobuf.JsonFormatter. ويكون ذلك مفيدًا عند إنشاء أنظمة تحتاج إلى التفاعل مع أنظمة أخرى تتطلّب تنسيقات مستندة إلى نصوص، مثل JSON أو XML.

using Google.Protobuf;

GoogleAdsRow row = new GoogleAdsRow()
{
    Campaign = new Campaign()
    {
        Id = 123,
        Name = "Campaign 1",
        ResourceName = ResourceNames.Campaign(1234567890, 123)
    }
};

// Serialize to JSON and back.
string json = JsonFormatter.Default.Format(row);
row = GoogleAdsRow.Parser.ParseJson(json);

التحويل إلى وحدات بايت

يمكنك تحويل عنصر إلى تسلسل بايتات والعكس باستخدام Google.Protobuf. تكون عملية التسلسل الثنائي أكثر كفاءة من حيث الذاكرة ومساحة التخزين مقارنةً بتنسيق JSON.

using Google.Protobuf;

GoogleAdsRow row = new GoogleAdsRow()
{
    Campaign = new Campaign()
    {
        Id = 123,
        Name = "Campaign 1",
        ResourceName = ResourceNames.Campaign(1234567890, 123)
    }
};

// Serialize to bytes and back.
byte[] bytes = row.ToByteArray();
row = GoogleAdsRow.Parser.ParseFrom(bytes);