أقنعة الحقل

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

FieldMaskUtil

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

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

// Creates a Campaign object with the proper resource name and any other changes.
Campaign campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// allSetFieldsOf utility to derive the update mask. This mask tells the Google
// Ads API which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

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

يستخدِم المثال طريقة FieldMasks.allSetFieldsOf() في الحملة ل إنشاء قناع حقل تلقائيًا يسرد جميع الحقول المحدّدة. يمكنك بعد ذلك تمرير القناع الذي تم إرجاعه مباشرةً إلى طلب التعديل.

إذا كنت بحاجة إلى العمل مع عنصر حالي لتعديل بعض الحقول، يمكنك تعديل الرمز على النحو التالي:

Campaign existingCampaign;

// Obtains existingCampaign from elsewhere.
...

// Creates a new campaign based off the existing campaign and updates the
// campaign by setting its status to paused.
Campaign campaignToUpdate =
    existingCampaign.toBuilder()
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// compare utility to derive the update mask. This mask tells the Google Ads API
// which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaignToUpdate)
        .setUpdateMask(FieldMasks.compare(existingCampaign, campaignToUpdate))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

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

FieldMask fieldMask =
    FieldMask.newBuilder()
        .addPaths("status")
        .addPaths("name")
        .build();

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

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

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

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

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

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

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

في هذه الحالة، لا يؤدي استخدام الطريقتَين allSetFieldsOf() وcompare() من ملف برمجي FieldMaskUtil إلى تحقيق الهدف المقصود.

ينشئ المثال التالي قناع حقل يتضمّن maximize_conversions. ومع ذلك، لا تسمح Google Ads API بهذا السلوك لمنع محو الحقول عن طريق الخطأ، وتُنشئ خطأ FieldMaskError.FIELD_HAS_SUBFIELDS.

تحذير: تؤدي التعليمة البرمجية التالية إلى ظهور خطأ.

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .setMaximizeConversions(MaximizeConversions.newBuilder().build())
    .build();

// 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 =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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 =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

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

النجاح: يُعدّ الرمز أدناه ناجحًا في تعديل استراتيجية عروض أسعار الحملة.

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// Creates a field mask from the existing campaign and adds all of the mutable
// fields (only one in this case) on the MaximizeConversions bidding strategy to
// the field mask. Because this field is 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 without any of its subfields
// set.
FieldMask fieldMask = FieldMasks.allSetFieldsOf(campaign)
    .toBuilder()
    // 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
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask)
        .build();

محو الحقول

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

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

تحذير: لا يؤدي هذا الرمز إلى ظهور خطأ، ولكن لن يتم محو target_cpa_micros لاستراتيجية عروض الأسعار MaximizeConversions.

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
Campaign campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setMaximizeConversions(
            MaximizeConversions.newBuilder().setTargetCpa(0).build())
        .setStatus(CampaignStatus.PAUSED)
        .build();

// 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 =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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 =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

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

النجاح: تعمل التعليمة البرمجية التالية على محو target_cpa_micros.

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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)
    .toBuilder()
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask))
        .build();

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

نقطة رئيسية: إذا كنت تريد محو حقل، فإنّ الطريقة الأكثر أمانًا لتحقيق هذا الهدف هي إضافة هذا الحقل صراحةً إلى قناع الحقل.