घर में मास्क लगाने की सेवा

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

FieldMasks यूटिलिटी

हमारा सुझाव है कि फ़ील्ड मास्क जनरेट करने के लिए, पहले से मौजूद फ़ील्ड मास्क यूटिलिटी (FieldMasks) का इस्तेमाल करें. इससे, फ़ील्ड मास्क को शुरू से बनाने के बजाय, बदले गए ऑब्जेक्ट से जनरेट किया जा सकता है.

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

use Google::Ads::GoogleAds::Utils::FieldMasks qw(all_set_fields_of field_mask);

my $campaign =
  Google::Ads::GoogleAds::V25::Resources::Campaign->new({
    resourceName =>
      Google::Ads::GoogleAds::V25::Utils::ResourceNames::campaign(
        $customer_id, $campaign_id
      ),
    status => "PAUSED",
    networkSettings =>
      Google::Ads::GoogleAds::V25::Resources::NetworkSettings
      ->new({
        targetSearchNetwork => "false",
      }),
  });

my $campaign_operation =
  Google::Ads::GoogleAds::V25::Services::CampaignService::CampaignOperation
  ->new({
    update     => $campaign,
    updateMask => all_set_fields_of($campaign),
  });

इस उदाहरण में, सबसे पहले Campaign ऑब्जेक्ट बनाया जाता है. इसके लिए, ResourceNames यूटिलिटी का इस्तेमाल करके, इसके संसाधन का नाम सेट किया जाता है. इससे एपीआई को पता चलता है कि किस कैंपेन को अपडेट किया जा रहा है.

इस उदाहरण में, कैंपेन पर FieldMasks::all_set_fields_of() तरीके का इस्तेमाल किया गया है. इससे फ़ील्ड मास्क अपने-आप जनरेट हो जाता है. इसमें सेट किए गए सभी फ़ील्ड शामिल होते हैं. इसके बाद, लौटाए गए मास्क को सीधे तौर पर अपडेट कॉल में पास किया जा सकता है.

FieldMasks::all_set_fields_of(), FieldMasks::field_mask() के लिए एक आसान तरीका है. यह पास किए गए ऑब्जेक्ट की तुलना, उसी क्लास के खाली ऑब्जेक्ट से करता है. ऊपर दिए गए कोड में, इनका भी इस्तेमाल किया जा सकता है:

field_mask(
  Google::Ads::GoogleAds::V25::Resources::Campaign->new({}),
  $campaign
)

के बजाय all_set_fields_of($campaign) का इस्तेमाल करें.

मैन्युअल तरीके से मास्क बनाना

शुरुआत से फ़ील्ड मास्क बनाने के लिए, सबसे पहले Google::Ads::GoogleAds::Common::FieldMask ऑब्जेक्ट बनाएं. इसके बाद, उन सभी फ़ील्ड के नामों से भरा हुआ एक ऐरे रेफ़रंस बनाएं जिन्हें आपको बदलना है. आखिर में, ऐरे रेफ़रंस को फ़ील्ड मास्क के paths फ़ील्ड को असाइन करें:

my $field_mask = Google::Ads::GoogleAds::Common::FieldMask->new({
  paths => ["status", "name"],
});

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

ऑब्जेक्ट फ़ील्ड में सबफ़ील्ड हो सकते हैं. जैसे, MaximizeConversions में target_cpa_micros जैसे सबफ़ील्ड शामिल होते हैं. हालांकि, ऐसा भी हो सकता है कि उनमें कोई सबफ़ील्ड न हो. जैसे, ManualCpm.

ऐसे ऑब्जेक्ट फ़ील्ड जिनमें कोई सब-फ़ील्ड तय नहीं किया गया है

Perl में ऑब्जेक्ट फ़ील्ड, gRPC पर चलने वाली क्लाइंट लाइब्रेरी में protobuf MESSAGE के बराबर होता है. अगर आपको किसी ऐसे ऑब्जेक्ट फ़ील्ड को अपडेट करना है जिसे किसी सब-फ़ील्ड के साथ तय नहीं किया गया है, तो फ़ील्ड मास्क जनरेट करने के लिए FieldMasks यूटिलिटी का इस्तेमाल करें. इसके बारे में पिछले सेक्शन में बताया गया है.

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

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

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

इस मामले में, FieldMasks यूटिलिटी के all_set_fields_of() और field_mask() तरीकों का इस्तेमाल करने से, तय किया गया लक्ष्य हासिल नहीं होता.

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

# Creates a campaign with the proper resource name and an empty
# MaximizeConversions field.
my $campaign =
  Google::Ads::GoogleAds::V25::Resources::Campaign->new({
    resourceName =>
      Google::Ads::GoogleAds::V25::Utils::ResourceNames::campaign(
        $customer_id, $campaign_id
      ),
    maximizeConversions =>
      Google::Ads::GoogleAds::V25::Resources::MaximizeConversions
      ->new(),
  });

# Constructs an operation, using the FieldMasks' all_set_fields_of utility to
# derive the update mask. The field mask includes 'maximize_conversions',
# which produces a FieldMaskError.FIELD_HAS_SUBFIELDS error.
my $campaign_operation =
  Google::Ads::GoogleAds::V25::Services::CampaignService::CampaignOperation
  ->new({
    update     => $campaign,
    updateMask => all_set_fields_of($campaign),
  });

# Sends the operation in a mutate request that results in a
# FieldMaskError.FIELD_HAS_SUBFIELDS error because empty object fields cannot
# be included in a field mask.
my $response = $api_client->CampaignService()->mutate({
  customerId => $customer_id,
  operations => [$campaign_operation],
});

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

# Creates a campaign with the proper resource name.
my $campaign =
  Google::Ads::GoogleAds::V25::Resources::Campaign->new({
    resourceName =>
      Google::Ads::GoogleAds::V25::Utils::ResourceNames::campaign(
        $customer_id, $campaign_id
      ),
  });

# Creates a field mask from the existing campaign and adds the mutable subfield
# 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 sets the campaign's bidding strategy to a
# MaximizeConversions object with none of its subfields set.
# 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.
#
# See the guide on assigning standard and portfolio bidding strategies
# (/google-ads/api/docs/campaigns/bidding/assign-strategies).
my $field_mask = all_set_fields_of($campaign);
push @{$field_mask->{paths}}, "maximize_conversions.target_cpa_micros";

# Creates an operation to update the campaign with the specified fields.
my $campaign_operation =
  Google::Ads::GoogleAds::V25::Services::CampaignService::CampaignOperation
  ->new({
    update     => $campaign,
    updateMask => $field_mask,
  });

फ़ील्ड में मौजूद कॉन्टेंट मिटाएं

फ़ील्ड को साफ़ तौर पर हटाने के लिए, उन्हें फ़ील्ड मास्क में जोड़ा जा सकता है. जैसा कि ऊपर दिए गए उदाहरण में दिखाया गया है. इसके अलावा, फ़ील्ड को खाली या अपरिभाषित वैल्यू पर सेट करके भी हटाया जा सकता है. उदाहरण के लिए, मान लें कि आपके पास एक ऐसा कैंपेन है जिसमें MaximizeConversions बिडिंग की रणनीति का इस्तेमाल किया जाता है. साथ ही, target_cpa_micros फ़ील्ड को ऐसी वैल्यू के साथ सेट किया गया है जो 0 से ज़्यादा है.

# Creates a campaign with the proper resource name and a MaximizeConversions
# object with target_cpa_micros set to 0.
my $campaign =
  Google::Ads::GoogleAds::V25::Resources::Campaign->new({
    resourceName =>
      Google::Ads::GoogleAds::V25::Utils::ResourceNames::campaign(
        $customer_id, $campaign_id
      ),
    maximizeConversions =>
      Google::Ads::GoogleAds::V25::Resources::MaximizeConversions
      ->new({
        targetCpaMicros => 0,
      }),
  });

# Constructs an operation using all_set_fields_of to derive the update mask,
# which includes 'maximize_conversions.target_cpa_micros'.
my $campaign_operation =
  Google::Ads::GoogleAds::V25::Services::CampaignService::CampaignOperation
  ->new({
    update     => $campaign,
    updateMask => all_set_fields_of($campaign),
  });

ध्यान दें कि नेस्ट किए गए सब-फ़ील्ड वाले फ़ील्ड को सिर्फ़ हर सब-फ़ील्ड को मिटाकर साफ़ किया जा सकता है. इसके बारे में डिफ़ाइन किए गए सब-फ़ील्ड वाले ऑब्जेक्ट फ़ील्ड में बताया गया है.