العمل مع أنواع Protobuf

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

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

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

على سبيل المثال، تم تصنيف الحقل 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 Name field from
// being sent to the server in a subsequent API call.
campaign.ClearName();

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

// This will throw a runtime error. Use ClearName() instead.
campaign.Name = null;

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

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

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

هناك طريقتان لتعبئة حقل RepeatedField.

طريقة AddRange

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

 // Add values to UrlCustomParameters using 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، وجميع السمات تعدّل حقل فئة مشتركة.

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

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()
    {
        EnhancedCpcEnabled = true
    },
    ManualCpm = new ManualCpm()
    {

    }
};

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

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

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

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

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

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

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

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