Alan Maskeleri

Google Ads API'de güncellemeler bir alan maskesi kullanılarak yapılır. Alan maskesi, güncellemeyle değiştirmek istediğiniz tüm alanları listeler. Alan maskesinde bulunmayan belirtilen alanlar, sunucuya gönderilmiş olsa bile yoksayılır.

FieldMaskUtil

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

Aşağıda bir kampanyayı güncelleme örneği 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 });

Öncelikle boş bir Campaign nesnesi oluştururuz. Ardından, API'nin tam olarak hangi kampanyayı güncellediğimizi bilmesi için kaynağın adını belirleriz.

Örnekte, kampanyadaki FieldMasks.AllSetFieldsOf yöntemi kullanılarak ayarlanan tüm alanları listeleyen bir alan maskesi otomatik olarak oluşturulur. Ardından, döndürülen maskeyi doğrudan güncelleme çağrısına iletebilirsiniz.

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

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 nesnesi oluşturur, ardından değiştirmek istediğiniz tüm alanların adlarıyla doldurulmuş bir dizi oluşturur ve son olarak dizi içeriğini alan maskesinin Path alanına eklersiniz.

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

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

MESSAGE alanlarında alt alanlar olabilir (ör. target_cpa_micros, cpc_bid_ceiling_micros ve cpc_bid_floor_micros olmak üzere üç alt alanı olan MaximizeConversions) veya hiç alt alan olmayabilir (ör. ManualCpm).

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

Herhangi bir alt alanla tanımlanmayan bir MESSAGE alanını güncellerken, yukarıda açıklandığı gibi bir alan maskesi oluşturmak için FieldMasks kullanın.

Tanımlanmış alt alanları olan ileti alanları

Alt alanlarıyla tanımlanan bir MESSAGE alanını, bu iletideki alt alanlardan herhangi birini açıkça ayarlamadan güncellerken, sıfırdan alan maskesi oluşturan yukarıdaki örneğe benzer şekilde, değiştirilebilir MESSAGE alt alanlarının her birini manuel olarak FieldMask alanına eklemeniz gerekir.

Sık karşılaşılan bir örnek, yeni teklif stratejisindeki hiçbir alanı ayarlamadan bir kampanyanın teklif stratejisini güncellemektir. Aşağıdaki örnekte, teklif stratejisindeki alt alanlardan hiçbirini ayarlamadan bir kampanyanın MaximizeConversions teklif stratejisini kullanacak şekilde nasıl güncelleneceği gösterilmektedir.

Bu durumda, FieldMasks için AllSetFieldsOf() ve FromChanges() yöntemlerinin kullanılması istenen hedefe ulaşmaz.

Aşağıdaki örnekte, maximize_conversions içeren bir alan maskesi oluşturulmaktadır. Ancak Google Ads API, alanların yanlışlıkla temizlenmesini önlemek için bu davranışa izin vermez ve FieldMaskError.FIELD_HAS_SUBFIELDS hatası oluşturur.

// 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ından herhangi birini ayarlamaksızın MaximizeConversions teklif stratejisini kullanacak şekilde nasıl doğru şekilde güncelleneceği gösterilmektedir.

// 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ı temizleme

Bazı alanlar açıkça temizlenebilir. Yukarıdaki örneğe benzer şekilde, bu alanları alan maskesine açıkça eklemeniz gerekir. Örneğin, MaximizeConversions teklif stratejisi kullanan bir kampanyanız olduğunu ve target_cpa_micros alanının 0'dan büyük bir değerle ayarlandığını varsayalım.

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ında herhangi bir değişiklik yapılmaz:

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

Aşağıdaki örnekte, MaximizeConversions teklif stratejisindeki target_cpa_micros alanının nasıl doğru şekilde temizleneceği gösterilmektedir.

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

Yukarıdaki "yanlış" örneğinin, Google Ads API'de optional olarak tanımlanan alanlar için protocol buffers amaçlandığı gibi çalıştığını unutmayın. Ancak target_cpa_micros bir optional alanı olmadığından "yanlış" örnek, teklif stratejisini target_cpa alanını temizleyecek şekilde güncellemez.