ماسک های میدانی

در API گوگل ادز، از یک ماسک فیلد برای ارائه لیستی از فیلدهایی که یک درخواست API باید به‌روزرسانی کند، استفاده می‌شود. هر فیلدی که در ماسک فیلد مشخص نشده باشد، حتی اگر به سرور ارسال شود، نادیده گرفته می‌شود.

کلاس FieldMasks

روش توصیه‌شده برای تولید ماسک‌های میدانی در کتابخانه کلاینت .NET، استفاده از کلاس کاربردی داخلی FieldMasks است که به شما امکان می‌دهد ماسک‌های میدانی را از یک شیء اصلاح‌شده به جای ساخت آنها از ابتدا، تولید کنید.

در اینجا مثالی برای به‌روزرسانی یک کمپین آورده شده است که از متد FieldMasks.AllSetFieldsOf برای تولید یک ماسک فیلد که تمام فیلدهای تنظیم‌شده را شمارش می‌کند، استفاده می‌کند. سپس می‌توانید ماسک فیلد تولیدشده را مستقیماً به فراخوانی به‌روزرسانی ارسال کنید:

// Update campaign by setting its status to paused, and "Search network" to
// false.
Campaign campaignToUpdate = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    NetworkSettings = new NetworkSettings()
    {
        TargetSearchNetwork = false
    }
};

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};

// Update the campaign.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

گاهی اوقات، ممکن است لازم باشد با یک شیء موجود کار کنید و چند فیلد را به‌روزرسانی کنید. در چنین مواردی، به جای آن از متد FieldMasks.FromChanges استفاده کنید. این متد یک ماسک فیلد ایجاد می‌کند که تفاوت بین دو شیء را نشان می‌دهد:

Campaign existingCampaign;

// Obtain existingCampaign from an earlier API call.

// Create a new campaign based on the existing campaign for update.
Campaign campaignToUpdate = new Campaign(existingCampaign);

// Update campaign by setting its status to paused, and "Search network" to
// false.
campaignToUpdate.Status = CampaignStatus.Paused;
campaignToUpdate.NetworkSettings = new NetworkSettings()
{
    TargetSearchNetwork = false
};

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.FromChanges(existingCampaign, campaignToUpdate)
};

خطاهای FieldMaskError.FIELD_HAS_SUBFIELDS را مدیریت کنید

در موارد نادر، ممکن است لازم باشد فیلد پیام را بدون به‌روزرسانی هیچ یک از زیرفیلدهای آن تنظیم کنید. مثال زیر را در نظر بگیرید:

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
};

CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

این فراخوانی API با خطای FieldMaskError.FIELD_HAS_SUBFIELDS ناموفق است. از آنجایی که MaximizeConversions دارای زیرفیلد است، سرور Google Ads API انتظار دارد که ماسک‌های فیلد برای زیرفیلدهای قابل تغییر در درخواست وجود داشته باشند. با این حال، FieldMasks نمی‌تواند در این شرایط ماسک‌های زیرفیلد را به طور خودکار ایجاد کند زیرا درخواست هیچ زیرفیلدی را تنظیم نمی‌کند.

در چنین مواردی، می‌توانید مسیرها را به صورت دستی به fieldMask.Paths (که یک RepeatedField<string> است) اضافه کنید:

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
};

FieldMask fieldMask = FieldMasks.AllSetFieldsOf(campaign);
// Only include 'maximize_conversions.target_cpa_micros' in the field mask
// as it is the only mutable subfield on MaximizeConversions when used as a
// standard bidding strategy.
//
// Learn more about standard and portfolio bidding strategies at:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
fieldMask.Paths.Add("maximize_conversions.target_cpa_micros");

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

پاک کردن فیلدها

API گوگل ادز از پاک کردن مقادیر برخی از فیلدها پشتیبانی می‌کند. برای پاک کردن یک فیلد، باید آن فیلد را به صورت دستی در ماسک فیلد قرار دهید و در عین حال فیلد را روی شیء منبع تنظیم نشده رها کنید. تنظیم یک فیلد به مقدار پیش‌فرض آن (مانند 0 برای یک فیلد int64 ) فیلد را پاک نمی‌کند.

مثال کد زیر نحوه پاک کردن فیلد target_cpa_micros از یک استراتژی پیشنهاد قیمت MaximizeConversions را نشان می‌دهد:

کد صحیح

کد زیر فیلد target_cpa_micros پاک می‌کند زیرا maximize_conversions.target_cpa_micros را بدون تنظیم campaign.MaximizeConversions.TargetCpaMicros به ماسک فیلد اضافه می‌کند:

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
};

// Constructs a field mask from the existing campaign and adds the
// 'maximize_conversions.target_cpa_micros' field to the field mask, which
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
FieldMask fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.Add("maximize_conversions.target_cpa_micros");

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

کد نادرست

کد زیر فیلد target_cpa_micros را پاک نمی‌کند ، زیرا این فیلد را روی 0 تنظیم می‌کند. هم ابزار FieldMasks و هم سرور Google Ads API این مقدار را زمانی که TargetCpaMicros 0 است یا زمانی که مسیر از ماسک حذف شده است، نادیده می‌گیرند و سرور خطایی برنمی‌گرداند:

// Creates a campaign with the proper resource name and a
// MaximizeConversions object. Attempts to clear the target_cpa_micros
// field by setting it to 0.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
    {
        TargetCpaMicros = 0
    }
};

// Constructs an operation using FieldMasks.AllSetFieldsOf to derive the
// update mask.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

// Sends the operation in a mutate request that succeeds without clearing
// the previous 'target_cpa_micros' value cleanly.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });