Alan Maskeleri

Google Ads API'de, bir API isteğinin güncellemesi gereken alanların listesini sağlamak için alan maskesi kullanılır. Alan maskesinde belirtilmeyen tüm alanlar, sunucuya gönderilse bile yoksayılır.

FieldMaskUtil sınıfı

Alan maskeleri oluşturmanın önerilen yolu, yerleşik FieldMaskUtil sınıfını kullanmaktır. Bu sınıf, alan maskelerini sıfırdan oluşturmak yerine değiştirilmiş bir nesneden oluşturmanıza olanak tanır.

Aşağıda, tüm ayarlanmış alanları numaralandıran bir alan maskesi oluşturmak için FieldMasks.AllSetFieldsOf yönteminin kullanıldığı bir kampanyayı güncelleme örneği verilmiştir. Ardından, oluşturulan alan maskesini doğrudan güncelleme çağrısına iletebilirsiniz.

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

Bazen mevcut bir nesneyle çalışmanız ve birkaç alanı güncellemeniz gerekebilir. Bu gibi durumlarda, kodu FieldMasks.FromChanges yöntemini kullanacak şekilde değiştirirsiniz. Bu yöntem, iki nesne arasındaki farkı temsil eden bir alan maskesi oluşturur.

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 hatalarını işleme

Nadiren de olsa, bir alanı bu türdeki alt alanlardan herhangi birini güncellemeden ayarlamanız gerekebilir. Aşağıdaki örneği inceleyelim:

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

Bu API çağrısı FieldMaskError.FIELD_HAS_SUBFIELDS hatasıyla başarısız olur. MaximizeConversions üç alt alana sahip olduğundan Google Ads API sunucusu, bu alanlar için alan maskelerinin istekte bulunmasını bekler. Ancak istek bu alanları ayarlamadığı için FieldMaskUtil bu durumda alan maskelerini doğru şekilde oluşturamaz.

Bu gibi durumlarda, alan maskesini aşağıdaki şekilde manuel olarak düzenleyebilirsiniz:

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

Alanları temizleme

Google Ads API, bazı alan değerlerinin temizlenmesini destekler. Bir alanı temizlemek için söz konusu alanın alan maskesini manuel olarak ayarlamanız gerekir. Bir alanı varsayılan değerine ayarlamak (ör. int64 alanı için sıfır) alanı temizlemez.

Aşağıdaki kod örneğinde, MaximizeConversions teklif stratejisinin target_cpa_micros alanının nasıl temizleneceği gösterilmektedir.

Doğru kod

Aşağıdaki kod, alan maskesinde maximize_conversions.target_cpa_micros ayarlandığı ve campaign.MaximizeConversions.TargetCpaMicros alanı ayarlanmadığı için target_cpa_micros alanını temizler.

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

Yanlış kod

Bu alanı sıfır olarak ayarladığımız için aşağıdaki kod target_cpa_micros alanını temizlemez. Hem FieldMaskUtils hem de Google Ads API sunucusu bu değeri yoksayar. Ayrıca, değer sunucu tarafından yoksayıldığı için bu durumda hata da almayabilirsiniz.

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