מסכות שדה

ב-Google Ads API, העדכונים מתבצעים באמצעות מסכת שדות. מסכת השדות מפרטת את כל השדות שאתם מתכוונים לשנות באמצעות העדכון, וכל שדה שצוין ולא נמצא במסכת השדות לא יקבל התייחסות, גם אם הוא נשלח לשרת. כדי ליצור מסכת שדות באופן ידני, יוצרים FieldMask (Google\Protobuf\FieldMask), יוצרים מערך שמאוכלס בשמות של כל השדות שרוצים לשנות, ואז מקצים את המערך הזה לשדה paths של מסכת השדות.

אפשר גם להשתמש בכלי המובנה של מסכת השדות (FieldMasks), שמסתיר הרבה מהפרטים הספציפיים ומאפשר ליצור מסכות שדות באופן אוטומטי על ידי בדיקת השינויים שאתם מבצעים בשדות של הישות.

דוגמה לעדכון קמפיין:

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

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

הקוד הזה יוצר קודם אובייקט Campaign ואז מגדיר את שם המשאב שלו באמצעות ResourceNames, כדי שה-API ידע איזה קמפיין מתעדכן. גם status מוגדר ל-CampaignStatus::PAUSED.

לאחר מכן, הקוד יוצר אובייקט CampaignOperation ומגדיר בו את הקמפיין שנוצר קודם לכן. לאחר מכן, הוא משתמש ב-FieldMasks::allSetFieldsOf() כדי ליצור מסכת שדה לקמפיין על ידי פירוט כל השדות ששונו. לבסוף, הוא מעביר את המסכה שהוחזרה לאובייקט של פעולת הקמפיין.

שימו לב ש-FieldMasks::allSetFieldsOf() היא שיטה נוחה ל-FieldMasks::compare(). הוא משווה בין האובייקט שהועבר לבין אובייקט ריק מאותה מחלקה. לדוגמה, בקוד הקודם, יכולתם להשתמש ב-FieldMasks::compare(new Campaign(), $campaign) במקום ב-FieldMasks::allSetFieldsOf($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 includes 'maximize_conversions',
// which produces 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 results in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns(
    MutateCampaignsRequest::build($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 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 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:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->getPaths()[] = '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);

ניקוי השדות

אפשר לנקות שדות מסוימים באופן מפורש. בדומה לדוגמה הקודמת, צריך להוסיף את השדות האלה באופן מפורש למסכת השדות, כי FieldMasks מתעלם משדות סקלריים של Proto3 שמוגדרים לערכי ברירת המחדל שלהם (כמו 0,‏ false או ""). לדוגמה, נניח שיש לכם קמפיין שמשתמש בשיטת בידינג מסוג 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_micros' => 0
    ]),
    'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask does 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 succeeds, but does 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(
    MutateCampaignsRequest::build($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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->getPaths()[] = '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);

שימו לב שהגדרת ערך ברירת מחדל פועלת כמצופה בשדות ש מוגדרים כ-optional במאגרי האחסון לפרוטוקולים של Google Ads API. עם זאת, מכיוון ש-target_cpa_micros הוא לא שדה optional, הגדרה שלו ל-0 בלי להוסיף במפורש את הנתיב לאנונימיזציה של שדות לא מעדכנת את שיטת הבידינג כדי לנקות את target_cpa_micros.

נקודה חשובה: אם אתם רוצים לנקות שדה, הדרך הבטוחה ביותר היא להוסיף אותו באופן מפורש למסכת השדות.