أقنعة الحقل

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

FieldMaskUtil

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

في ما يلي مثال على تعديل إحدى الحملات:

// 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 Ads API هذا السلوك لمنع محو الحقول عن طريق الخطأ وظهور خطأ 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".