أقنعة الحقل

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

فئة FieldMaskUtil

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

في ما يلي مثال على تعديل حملة تستخدم طريقة 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 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)
};

كيفية التعامل مع أخطاء 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 });

سيتعذّر تنفيذ طلب البيانات من واجهة برمجة التطبيقات هذا وسيظهر الخطأ FieldMaskError.FIELD_HAS_SUBFIELDS. بما أنّ MaximizeConversions يتضمّن ثلاثة حقول فرعية، يتوقّع خادم Google Ads API أن تتضمّن الطلبات أقنعة الحقول الخاصة بهذه الحقول. ومع ذلك، لا يمكن لـ FieldMaskUtil إنشاء أقنعة الحقول بشكل صحيح في هذه الحالة، لأنّ الطلب لا يضبط هذه الحقول.

في مثل هذه الحالات، يمكنك تعديل قناع الحقل يدويًا على النحو التالي:

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

كيفية محو الحقول

تتيح Google Ads API محو بعض قيم الحقول. لمحو حقل، عليك ضبط قناع الحقل يدويًا لهذا الحقل. لن يؤدي ضبط قيمة الحقل على القيمة التلقائية (مثل صفر لحقل 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 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
};

الرمز غير صالح

الرمز التالي لا يمحو الحقل target_cpa_micros، لأنّنا نضبط قيمة هذا الحقل على صفر. سيتجاهل كل من FieldMaskUtils وخادم Google Ads API هذه القيمة. بالإضافة إلى ذلك، قد لا تتلقّى رسالة خطأ في هذه الحالة، لأنّ الخادم تجاهل القيمة.

// Creates a campaign with the proper resource name and a MaximizeConversions
// object. Attempt 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 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 });