Google Ads API में, फ़ील्ड मास्क का इस्तेमाल करके अपडेट किए जाते हैं. फ़ील्ड मास्क उन सभी फ़ील्ड की सूची दिखाता है जिनमें आपको अपडेट के साथ बदलाव करना है. साथ ही, फ़ील्ड मास्क में शामिल नहीं किए गए किसी भी फ़ील्ड को अनदेखा कर दिया जाता है. भले ही, उसे सर्वर पर भेजा गया हो.
FieldMasks यूटिलिटी
फ़ील्ड मास्क जनरेट करने के लिए, हमारा सुझाव है कि आप पहले से मौजूद फ़ील्ड मास्क यूटिलिटी (FieldMasks) का इस्तेमाल करें. इससे आपको किसी ऑब्जेक्ट में बदलाव करके फ़ील्ड मास्क जनरेट करने की सुविधा मिलती है. इसके लिए, आपको नए सिरे से फ़ील्ड मास्क बनाने की ज़रूरत नहीं पड़ती.
यहां कैंपेन अपडेट करने का एक उदाहरण दिया गया है:
use Google::Ads::GoogleAds::Utils::FieldMasks qw(all_set_fields_of field_mask);
my $campaign =
Google::Ads::GoogleAds::V26::Resources::Campaign->new({
resourceName =>
Google::Ads::GoogleAds::V26::Utils::ResourceNames::campaign(
$customer_id, $campaign_id
),
status => "PAUSED",
networkSettings =>
Google::Ads::GoogleAds::V26::Resources::NetworkSettings
->new({
targetSearchNetwork => "false",
}),
});
my $campaign_operation =
Google::Ads::GoogleAds::V26::Services::CampaignService::CampaignOperation
->new({
update => $campaign,
updateMask => all_set_fields_of($campaign),
});
इस उदाहरण में, सबसे पहले ResourceNames यूटिलिटी का इस्तेमाल करके, Campaign ऑब्जेक्ट का रिसॉर्स नेम सेट किया जाता है. इससे एपीआई को पता चलता है कि किस कैंपेन को अपडेट किया जा रहा है.
इस उदाहरण में, कैंपेन पर FieldMasks::all_set_fields_of() तरीके का इस्तेमाल किया गया है, ताकि सेट किए गए सभी फ़ील्ड की गिनती करने वाला फ़ील्ड मास्क अपने-आप जनरेट हो सके. इसके बाद, वापस किए गए मास्क को सीधे अपडेट कॉल पर पास किया जा सकता है.
FieldMasks::all_set_fields_of(), FieldMasks::field_mask() के लिए एक आसान तरीका है. यह आपके पास किए गए ऑब्जेक्ट की तुलना, उसी क्लास के खाली ऑब्जेक्ट से करता है. ऊपर दिए गए कोड में, इनका भी इस्तेमाल किया जा सकता है:
field_mask(
Google::Ads::GoogleAds::V26::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::V26::Resources::Campaign->new({
resourceName =>
Google::Ads::GoogleAds::V26::Utils::ResourceNames::campaign(
$customer_id, $campaign_id
),
maximizeConversions =>
Google::Ads::GoogleAds::V26::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::V26::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::V26::Resources::Campaign->new({
resourceName =>
Google::Ads::GoogleAds::V26::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::V26::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::V26::Resources::Campaign->new({
resourceName =>
Google::Ads::GoogleAds::V26::Utils::ResourceNames::campaign(
$customer_id, $campaign_id
),
maximizeConversions =>
Google::Ads::GoogleAds::V26::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::V26::Services::CampaignService::CampaignOperation
->new({
update => $campaign,
updateMask => all_set_fields_of($campaign),
});
ध्यान दें कि नेस्ट किए गए सबफ़ील्ड वाले फ़ील्ड को सिर्फ़ हर सबफ़ील्ड को मिटाकर ही मिटाया जा सकता है. जैसा कि तय किए गए सबफ़ील्ड वाले ऑब्जेक्ट फ़ील्ड में दिखाया गया है.