फ़ील्ड मास्क

Google Ads API में, फ़ील्ड मास्क का इस्तेमाल करके अपडेट किए जाते हैं. फ़ील्ड मास्क सूचियां वे सभी फ़ील्ड जिन्हें आपको अपडेट के साथ बदलना है. साथ ही, तय किए गए वे फ़ील्ड भी शामिल करें जो फ़ील्ड मास्क में नहीं हैं उन्हें अनदेखा किया जाता है, भले ही उन्हें सर्वर पर भेजा गया हो. आपने लोगों तक पहुंचाया मुफ़्त में मैन्युअल तौर पर फ़ील्ड मास्क बना सकता है. इसके लिए, Google\Protobuf\FieldMask उन सभी फ़ील्ड के नामों के साथ एक अरे बना कर जिनमें आपको बदलाव करना है, और फिर उसे फ़ील्ड मास्क के पाथ फ़ील्ड को असाइन कर सकता है.

पहले से मौजूद फ़ील्ड मास्क की सुविधा का भी इस्तेमाल किया जा सकता है (FieldMasks), इससे बहुत सारी खास जानकारी छिप जाती है और आपको फ़ील्ड जनरेट करने में मदद मिलती है मास्क अपने-आप, इकाई के फ़ील्ड में किए जाने वाले बदलावों की निगरानी करते हैं.

कैंपेन अपडेट करने का एक उदाहरण यहां दिया गया है:

    $campaign = new Campaign([
        'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
        'status' => CampaignStatus::PAUSED
    ]);

    $campaignOperation = new CampaignOperation();
    $campaignOperation->setUpdate($campaign);
    $campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

यह कोड सबसे पहले कैंपेन ऑब्जेक्ट बनाता है और फिर इसका इस्तेमाल करके अपने संसाधन का नाम सेट करता है ResourceNames, ताकि एपीआई को पता चल सके कि कौनसा कैंपेन अपडेट किया गया. status को भी PAUSED पर सेट किया गया है.

इसके बाद कोड एक CampaignOperation ऑब्जेक्ट बनाता है और पहले वाले ऑब्जेक्ट को सेट करता है ने टोन में अभियान बनाया. इसके बाद, यह FieldMasks::allSetFieldsOf() का इस्तेमाल करें. आख़िर में, लौटाए गए मास्क को कैंपेन ऑपरेशन ऑब्जेक्ट में पास करता है.

ध्यान दें कि FieldMasks::allSetFieldsOf, इनके लिए एक आसान तरीका है FieldMasks::compare(). यह आपके पास किए गए ऑब्जेक्ट की तुलना उसी क्लास के किसी खाली ऑब्जेक्ट से करता है. इसके लिए उदाहरण के लिए, पुराने कोड में आप allSetFieldsOf() के बजाय FieldMasks::compare(new Campaign(), $campaign) का इस्तेमाल कर सकते थे.

मैसेज फ़ील्ड और उनके सबफ़ील्ड अपडेट करना

MESSAGE फ़ील्ड में सबफ़ील्ड हो सकते हैं (जैसे कि MaximizeConversions, जिसमें तीन हैं: target_cpa_micros, cpc_bid_ceiling_micros और cpc_bid_floor_micros) या उनका कोई डेटा नहीं हो सकता (जैसे ManualCpm).

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

किसी ऐसे MESSAGE फ़ील्ड को अपडेट करते समय जिसे किसी सबफ़ील्ड में तय नहीं किया गया है, इसका इस्तेमाल करें जैसा कि पहले बताया गया है, फ़ील्ड मास्क जनरेट करने के लिए, FieldMasks का इस्तेमाल किया जा सकता है.

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

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

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

इस मामले में, allSetFieldsOf()compare() FieldMasks लक्षित लक्ष्य को प्राप्त नहीं करता.

यह कोड, ऐसा फ़ील्ड मास्क जनरेट करता है जिसमें maximize_conversions शामिल है. हालांकि, Google Ads API इस तरह के व्यवहार की अनुमति नहीं देता, ताकि गलती से फ़ील्ड को साफ़ कर देता है और FieldMaskError.FIELD_HAS_SUBFIELDS गड़बड़ी.

चेतावनी: यह कोड एक गड़बड़ी दिखा रहा है.

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions()
]);

// 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 = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

// 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.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

नीचे दिया गया कोड बताता है कि कैंपेन को कैसे अपडेट करना है, ताकि MaximizeConversions बिडिंग की रणनीति का कोई भी सबफ़ील्ड सेट नहीं किया गया है.

हो गया: नीचे दिया गया कोड, कैंपेन की बिडिंग की रणनीति को अपडेट करता है.

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);

// 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 = 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->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

फ़ील्ड खाली किए जा रहे हैं

कुछ फ़ील्ड साफ़ तौर पर मिटाए जा सकते हैं. ऊपर दिए गए उदाहरण की तरह ही, आपको इन फ़ील्ड को साफ़ तौर पर फ़ील्ड मास्क में जोड़ें. उदाहरण के लिए, मान लें कि आपके पास जो 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 = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions(['target_cpa' => 0]),
    'status' => CampaignStatus::PAUSED
]);

// 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 = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(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.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

यह कोड बताता है कि target_cpa_micros को ठीक से कैसे हटाया जा सकता है फ़ील्ड में डालें.MaximizeConversions

हो गया: यह कोड target_cpa_micros को हटा देता है.

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($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 = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

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

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