फ़ील्ड मास्क

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 फ़ील्ड को अपडेट करते समय जिसे किसी सबफ़ील्ड में तय नहीं किया गया है, इसका इस्तेमाल करें फ़ील्ड मास्क जनरेट करना होगा, जैसा कि ऊपर बताया गया है.

तय किए गए सबफ़ील्ड वाले मैसेज फ़ील्ड

जब MESSAGE फ़ील्ड को अपडेट किया जाता है, तो उसके बिना सबफ़ील्ड का इस्तेमाल किया जाता है किसी सबफ़ील्ड को साफ़ तौर पर सेट करना हो, तो आपको हर म्यूटेबल MESSAGE सबफ़ील्ड को FieldMask में जोड़ें, इससे मिलता-जुलता ऊपर दिया गया उदाहरण शुरू से फ़ील्ड मास्क बनाता है.

एक सामान्य उदाहरण है, किसी भी अभियान की बोली-प्रक्रिया कार्यनीति को अपडेट किए बिना फ़ील्ड पर माइग्रेट करें. नीचे दिया गया उदाहरण दिखाता है कि इस टूल का इस्तेमाल करके कैंपेन को अपडेट करना होगा MaximizeConversions बिडिंग की रणनीति सबफ़ील्ड सेट किए बिना.

इस मामले में, allSetFieldsOf()compare() फ़ील्डमास्कयूटिल तय किया गया लक्ष्य हासिल नहीं करता.

नीचे दिया गया उदाहरण एक फ़ील्ड मास्क जनरेट करता है, जिसमें ये शामिल हैं 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();

ध्यान दें कि "गलत" ऊपर दिया गया उदाहरण उन फ़ील्ड के लिए सही तरीके से काम करता है जिनमें Google Ads API में optional के तौर पर तय किए जाते हैं protocol buffers. हालांकि, जिस दिन target_cpa_micros optional फ़ील्ड नहीं है, यह "गलत" है उदाहरण not करता है target_cpa फ़ील्ड को खाली करने के लिए बोली-प्रक्रिया कार्यनीति.

अहम जानकारी: अगर आपको किसी फ़ील्ड को खाली करना है, तो इसे पाने का सबसे सुरक्षित तरीका है इसका मकसद उस फ़ील्ड को साफ़ तौर पर फ़ील्ड मास्क में जोड़ना है.