أقنعة الحقل

في 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 لم يتم تحديده مع أي حقول فرعية، استخدِم FieldMaskUtill لإنشاء قناع حقل، كما هو موضّح أعلاه.

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

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

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

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

ينشئ المثال التالي قناع حقل يتضمن 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:

// 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".

// 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".