Alan Maskeleri

Google Ads API'de güncellemeler bir alan maskesi kullanılarak yapılır. Alan maskesi listeleri güncellemeyle değiştirmek istediğiniz tüm alanlar ve belirtilen tüm alanlar diğer şablonlar, sunucuya gönderilse bile yoksayılır.

FieldMaskUtil

Alan maskeleri oluşturmak için önerilen yol, yerleşik alan maskemizi kullanmaktır yerine, değiştirilmiş bir nesneden alan maskeleri oluşturmanıza olanak tanıyan en iyi uygulamaları paylaşacağız.

Aşağıda, bir kampanyayı güncellemeyle ilgili bir örnek verilmiştir:

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

İlk olarak boş bir Campaign nesnesi oluştururuz. Ardından, kaynağın kaynak adını API'nin tam olarak hangi kampanyayı güncellediğimizi bilmesini sağlar.

Örnekte, kampanyada FieldMasks.AllSetFieldsOf yöntemi kullanılmaktadır otomatik olarak, ayarlanan tüm alanları numaralandıran bir alan maskesi oluşturur. Ardından döndürülen maskeyi doğrudan güncelleme çağrısına iletin.

Bazen mevcut bir nesneyle çalışmanız ve birkaç alanı güncellemeniz gerekebilir. Bu gibi durumlarda, kodu aşağıdaki gibi değiştirebilirsiniz:

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

Sıfırdan bir alan maskesi oluşturmak için önce bir FieldMask nesnesini tanımlayın, ardından istediğiniz tüm alanların adlarıyla doldurulan bir dizi yapın değerini girin ve son olarak dizi içeriğini, alan maskesinin Path alanına ekleyin.

FieldMask fieldMask = new FieldMask();
fieldMask.Paths.AddRange(new string[] { "status", "name" });

Mesaj alanlarını ve alt alanlarını güncelleme

MESSAGE alanlarının alt alanları olabilir (ör. Üç tane olan MaximizeConversions: target_cpa_micros, cpc_bid_ceiling_micros ve cpc_bid_floor_micros) ya da hiçbirinin olmaması (örneğin, ManualCpm).

Tanımlanmış alt alanı olmayan mesaj alanları

Herhangi bir alt alanla tanımlanmayan bir MESSAGE alanını güncellerken FieldMasks kullanarak yukarıda açıklandığı gibi bir alan maskesi oluşturun.

Tanımlanmış alt alanlara sahip mesaj alanları

Aşağıdaki değer içermeyen alt alanlarla tanımlanmış bir MESSAGE alanını güncellerken: alt alanlardan herhangi birini açıkça ayarlarsanız manuel olarak mutable MESSAGE alt alanlarının her birini şuna benzer şekilde FieldMask öğesine ekleyin: yukarıdaki örneğe bakın.

Yaygın bir örnek olarak, bir kampanyanın teklif stratejisini herhangi bir yeni teklif stratejisinin Aşağıdaki örnekte, bir kampanyayı MaximizeConversions teklif stratejisi teklif stratejisindeki alt alanlardan hiçbirini ayarlamadan.

Bu durumda AllSetFieldsOf() ve FromChanges() FieldMasks istenen hedefe ulaşamıyor.

Aşağıdaki örnekte, aşağıdakileri içeren bir alan maskesi oluşturulur: maximize_conversions Ancak Google Ads API, bu davranışın alanları yanlışlıkla temizlemesini engeller ve FieldMaskError.FIELD_HAS_SUBFIELDS hatası.

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

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

Aşağıdaki örnekte, bir kampanyanın Alt alanlarını ayarlamadan MaximizeConversions teklif stratejisi uygulayabilirsiniz.

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

// Creates a field mask from the existing campaign and adds all of the fields
// on the MaximizeConversions bidding strategy to the field mask. Because these
// fields are 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 with none of its subfields set.
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 Temizleniyor

Bazı alanlar açıkça temizlenebilir. Yukarıdaki örneğe benzer şekilde bu alanları açık bir şekilde alan maskesine eklemenizi öneririz. Örneğin, MaximizeConversions teklif stratejisi kullanan ve target_cpa_micros alanı 0'dan büyük bir değerle ayarlanmış.

Aşağıdaki kod çalıştırılır: ancak maximize_conversions.target_cpa_micros alan maskesine eklenmez ve bu nedenle target_cpa_micros alanı:

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set 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 });

Sonraki örnekte, target_cpa_micros etiketinin nasıl düzgün bir şekilde temizleneceği gösterilmektedir alanına MaximizeConversions ulaşabilirsiniz.

// 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ış" bilginin yukarıdaki örnek, gerçekten de Google Ads API'de optional olarak tanımlanır protocol buffers Ancak target_cpa_micros optional alanı değil, "yanlış" örnek, teklif stratejisini target_cpa alanını temizleyin.