أقنعة الحقل

في إعلانات Google API، يتم إجراء التحديثات باستخدام قناع حقل. يسرد قناع الحقول جميع الحقول التي تنوي تغييرها مع التحديث، وسيتم تجاهل أي حقول محددة غير موجودة في قناع الحقل، حتى إذا تم إرسالها إلى الخادم.

قناع الحقل

تتمثل الطريقة الموصى بها لإنشاء أقنعة ميدانية في استخدام الأداة المساعدة المُدمجة لقناع الحقل، والتي تسمح لك بإنشاء أقنعة الحقول من كائن معدل بدلاً من إنشائه من البداية.

في ما يلي مثال لتحديث حملة:

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

أولاً، ننشئ كائن Campaign فارغًا. بعد ذلك، نعيّن اسم المورد بحيث تعرف واجهة برمجة التطبيقات بدقة الحملة التي نحدّثها.

يستخدم المثال طريقة FieldMasks.AllSetFieldsOf في الحملة تلقائيًا لإنتاج قناع حقولي يعمل على تعداد جميع الحقول المحددة. يمكنك بعد ذلك تمرير القناع الناتج مباشرةً إلى طلب التحديث.

قد تحتاج أحيانًا إلى التعامل مع عنصر حالي وتعديل بعض الحقول. في هذه الحالات، يمكنك تعديل الشفرة على النحو التالي:

Campaign existingCampaign;

// Obtain existingCampaign from elsewhere.
...

// Create a new campaign based off 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)
};

لإنشاء قناع حقل من البداية، عليك أولاً إنشاء كائن FieldMask ثم إنشاء مصفوفة تتم تعبئتها بأسماء جميع الحقول التي تنوي تغييرها، ثم إضافة محتوى المصفوفة إلى الحقل Path لقناع الحقل.

FieldMask fieldMask = new FieldMask();
fieldMask.Paths.AddRange(new string[] { "status", "name" });

تحديث حقول الرسالة وحقولها الفرعية

يمكن أن تحتوي حقول MESSAGE على حقول فرعية (مثل MaximizeConversions تتضمن ثلاثة حقول: target_cpa_micros و cpc_bid_ceiling_micros وcpc_bid_floor_micros)، أو لا يمكن أن تتضمن أي حقول على الإطلاق (مثل ManualCpm).

حقول رسالة بدون حقول فرعية محدّدة

عند تعديل حقل MESSAGE لم يتم تعريفه في أي حقول فرعية، استخدِم FieldMasks لإنشاء قناع حقل، كما هو موضّح أعلاه.

حقول الرسائل ذات الحقول الفرعية المحددة

عند تعديل الحقل MESSAGE الذي تم تحديده باستخدام الحقول الفرعية بدون ضبط أي من الحقول الفرعية بوضوح في تلك الرسالة، يجب إضافة كل من الحقول الفرعية القابلة للتغيير MESSAGE يدويًا إلى FieldMask، على غرار المثال أعلاه الذي ينشئ قناع حقل من البداية.

ومن الأمثلة الشائعة تحديث إستراتيجية عروض الأسعار لإحدى الحملات دون تعيين أي من حقول إستراتيجية عروض الأسعار الجديدة. يوضح المثال أدناه كيفية تعديل حملة لاستخدام استراتيجية عروض الأسعار MaximizeConversions بدون ضبط أي من الحقول الفرعية لاستراتيجية عروض الأسعار.

في هذه الحالة، لا يؤدي استخدام الطريقتين AllSetFieldsOf() وFromChanges() في FieldMasks إلى تحقيق الهدف المقصود.

في المثال التالي، يتم إنشاء قناع حقل يتضمن maximize_conversions. ومع ذلك، لا تسمح واجهة برمجة التطبيقات مع "إعلانات Google" بهذا السلوك لمنع محو الحقول عن طريق الخطأ وعرض خطأ 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()
};

// Constructs an operation, using the FieldMasks' AllSetFieldsOf utility to
// derive the update mask. The field mask will include 'maximize_conversions`,
// which will produce a FieldMaskError.FIELD_HAS_SUBFIELDS error.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

// Sends the operation in a mutate request that will result in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

يوضّح المثال التالي كيفية تعديل حملة بشكلٍ سليم لاستخدام استراتيجية عروض الأسعار MaximizeConversions بدون ضبط أي من حقولها الفرعية.

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

// Creates a field mask from the existing campaign and adds all of the fields
// on the MaximizeConversions bidding strategy to the field mask. Because these
// fields are included in the field mask but excluded from the campaign object,
// the Google Ads API will set the campaign's bidding strategy to a
// MaximizeConversions object with none of its subfields set.
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 here:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
fieldMask.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

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

محو الحقول

يمكن محو بعض الحقول بشكل صريح. وكما هو موضح في المثال أعلاه، يجب إضافة هذه الحقول بشكل صريح إلى قناع الحقل. على سبيل المثال، لنفترض أن لديك حملة تستخدم إستراتيجية عروض أسعار MaximizeConversions وأنه تم تعيين الحقل target_cpa_micros بقيمة أكبر من 0.

يتم تشغيل الرمز التالي، ومع ذلك، لن تتم إضافة maximize_conversions.target_cpa_micros إلى قناع الحقل، وبالتالي لا يتم إجراء أي تغييرات على الحقل target_cpa_micros:

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

// Constructs an operation, using the FieldMasks' AllSetFieldsOf utility to
// derive the update mask. However, the field mask will NOT include
// 'maximize_conversions.target_cpa_micros'.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

// Sends the operation in a mutate request that will succeed but will NOT update
// the 'target_cpa_micros' field because 'maximize_conversions.target_cpa_micros'
// was not included in the field mask.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

يوضّح المثال التالي كيفية محو الحقل target_cpa_micros بشكل صحيح على استراتيجية عروض الأسعار MaximizeConversions.

// 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 will
// clear this field from the bidding strategy without impacting any other fields
// on the bidding strategy.
FieldMask fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

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

تجدر الإشارة إلى أن المثال "غير الصحيح" أعلاه يعمل على النحو المنشود للحقول التي تم تعريفها على أنها optional في Google Ads API protocol buffers. وبما أنّ الحقل target_cpa_micros ليس حقلاً optional، فإنّ المثال "غير الصحيح" لا يؤدي إلى تعديل استراتيجية عروض الأسعار لمسح الحقل target_cpa.