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

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

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

تم وضع علامة 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 على أنّها للقراءة فقط 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

تم وضع علامة oneof على بعض الحقول في Google Ads API، ما يعني أنّ الحقل يمكنه الاحتفاظ بأنواع مختلفة ولكن بقيمة واحدة فقط في وقت معيّن. تشبه حقول 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

يمكنك تحويل كائنات بروتوكول المخزن المؤقت للبروتوكول إلى تنسيق 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);