کار کردن با انواع protobuf

ازآنجایی‌که Google Ads API از proto3 به‌عنوان قالب بار داده پیش‌فرض خود استفاده می‌کند، مهم است که هنگام کار با کتابخانه کارخواه .NET، چند قرارداد و نوع «میان‌گیر پروتکل» را درک کنید.

فیلدهای اختیاری

بسیاری از فیلدها در Google Ads API با optional علامت‌گذاری شده‌اند. این به شما امکان می‌دهد بین مواردی که فیلد مقدار خالی دارد و مواردی که سرور مقداری برای فیلد برنمی‌گرداند تمایز قائل شوید. این فیلدها مانند ویژگی‌های معمولی رفتار می‌کنند، با این تفاوت که روش‌های اضافی برای پاک کردن فیلد و بررسی تنظیم شدن فیلد نیز ارائه می‌دهند.

برای مثال، فیلد Name از شیء Campaign به‌عنوان optional علامت‌گذاری شده است، بنابراین می‌توانید از روش‌های زیر برای کار با این فیلد استفاده کنید:

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

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 فیلدها شبیه به نوع union در زبان برنامه‌نویسی 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 را بااستفاده از Google.Protobuf.JsonFormatter به قالب JSON تبدیل کنید و برگردانید. این ویژگی هنگام ساختن سیستم‌هایی که باید با سیستم‌های دیگر با قالب‌های مبتنی بر نوشتار مثل 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);