أقنعة الحقل

في 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.

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