מסכות שדה

ב-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, כדי שה-API יבין איזה קמפיין עודכן. status מוגדר גם כ-PAUSED.

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

שימו לב FieldMasks::allSetFieldsOf היא שיטה נוחה עבור FieldMasks::compare(). היא משווה בין האובייקט שהעברתם לאובייקט ריק מאותה מחלקה. עבור למשל: בקוד הקודם, אפשר היה להשתמש ב-FieldMasks::compare(new Campaign(), $campaign) במקום ב-allSetFieldsOf().

עדכון שדות של הודעות ושדות המשנה שלהם

MESSAGE שדות יכולים לכלול שדות משנה (כמו הנכס MaximizeConversions שכולל 3: 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:

// 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.

// 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);

חשוב לשים לב שהשדה "שגוי" הקוד פועל כמתוכנן עבור שדות מוגדרים בתור optional ב-Google Ads API protocol buffers. אבל מכיוון target_cpa_micros אינו שדה optional, השדה "שגוי" לא מעדכן את של שיטת הבידינג כדי לנקות את השדה target_cpa.