फ़ील्ड मास्क

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

फ़ील्डमास्क यूटिलिटी

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

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

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

my $campaign_operation =
  Google::Ads::GoogleAds::V17::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::V17::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, cpc_bid_ceiling_micros, और cpc_bid_floor_micros); या तो वह कुछ नहीं हो सकता (जैसे कि ManualCpm).

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

Perl में मौजूद ऑब्जेक्ट फ़ील्ड, क्लाइंट में प्रोटोबफ़ MESSAGE के बराबर है gRPC पर चल रही लाइब्रेरी के लिए. किसी ऐसे ऑब्जेक्ट फ़ील्ड को अपडेट करते समय जिसे तय नहीं किया गया है फ़ील्ड मास्क जनरेट करने के लिए, फ़ील्ड मास्क सुविधा इस्तेमाल करें. जैसे, ऊपर बताया गया है.

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

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

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

इस मामले में, 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::V17::Resources::Campaign->new({
    resourceName =>
      Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign(
        $customer_id, $campaign_id
      ),
    maximizeConversions =>
      Google::Ads::GoogleAds::V17::Resources::MaximizeConversions->new()
    });

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

# Sends the operation in a mutate request that will result 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::V17::Resources::Campaign->new({
    resourceName => Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign(
      $customer_id, $campaign_id
    )
  });

# Creates a field mask from the existing campaign and adds all of the fields
# on the MaximizeConversions bidding strategy to the field mask. Because these
# fields are 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 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.
#
# Learn more about standard and portfolio bidding strategies here:
# https://developers.google.com/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::V17::Services::CampaignService::CampaignOperation->new({
    update     => $campaign,
    updateMask => $field_mask
  });

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

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

हो गया: यह कोड target_cpa_micros फ़ील्ड को हटा देता है.

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

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

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