מסכות שדה

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

המחלקות FieldMaskUtil

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

דוגמה לעדכון קמפיין באמצעות השיטה FieldMasks.AllSetFieldsOf ליצירת מסכת שדות שמפרטת את כל השדות שהוגדרו. אחר כך אפשר להעביר את מסכת השדות שנוצרה ישירות לקריאה של update.

// Update campaign by setting its status to paused, and "Search network" to false.
Campaign campaignToUpdate = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    NetworkSettings = new NetworkSettings()
    {
        TargetSearchNetwork = false
    }
};

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};

// Update the campaign.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

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

Campaign existingCampaign;

// Obtain existingCampaign from elsewhere.
...

// Create a new campaign based off the existing campaign for update.
Campaign campaignToUpdate = new Campaign(existingCampaign);

// Update campaign by setting its status to paused, and "Search network" to
// false.
campaignToUpdate.Status = CampaignStatus.Paused;
campaignToUpdate.NetworkSettings = new NetworkSettings()
{
    TargetSearchNetwork = false
}

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.FromChanges(existingCampaign, campaignToUpdate)
};

איך מטפלים בשגיאות FieldMaskError.FIELD_HAS_SUBFIELDS

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

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
};

CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

הקריאה הזו ל-API תיכשל עם שגיאה FieldMaskError.FIELD_HAS_SUBFIELDS. מכיוון שלשדה MaximizeConversions יש שלושה שדות משנה, שרת Google Ads API מצפה שיהיו בבקשה מסכות שדות עבור השדות האלה. עם זאת, FieldMaskUtil לא יכול ליצור מסכות שדות בצורה נכונה במצב הזה, כי הבקשה לא מגדירה את השדות האלה.

במקרים כאלה, אפשר לערוך ידנית את מסכת השדות באופן הבא:

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
};

FieldMask 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.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

איך מוחקים שדות

‫Google Ads API תומך בניקוי של חלק מערכי השדות. כדי לנקות שדה, צריך להגדיר ידנית את מסכת השדה עבור השדה הזה. הגדרת שדה לערך ברירת המחדל שלו (כמו אפס בשדה int64) לא תנקה את השדה.

בדוגמת הקוד הבאה אפשר לראות איך מוחקים את השדה target_cpa_micros של שיטת הבידינג MaximizeConversions.

הקוד הנכון

הקוד הבא מנקה את השדה target_cpa_micros כי אנחנו מגדירים את maximize_conversions.target_cpa_micros במסכת השדות ולא מגדירים את השדה campaign.MaximizeConversions.TargetCpaMicros.

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(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 fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

קוד שגוי

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

// Creates a campaign with the proper resource name and a MaximizeConversions
// object. Attempt to clear the target_cpa_micros field by setting it to 0.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
    {
        TargetCpaMicros = 0
    }
};

// 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 operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });