Alan Maskeleri

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

FieldMaskUtil

Alan maskeleri oluşturmak için önerilen yöntem, alan maskelerini sıfırdan oluşturmak yerine değiştirilmiş bir nesneden oluşturmanıza olanak tanıyan yerleşik alan maskesi yardımcı programımızı kullanmaktır.

Kampanya güncelleme örneğini aşağıda görebilirsiniz:

// Creates a Campaign object with the proper resource name and any other changes.
Campaign campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// allSetFieldsOf utility to derive the update mask. This mask tells the Google
// Ads API which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Bu örnekte önce boş bir Campaign nesnesi oluşturulur, ardından API'nin hangi kampanyanın güncellendiğini bilmesi için kaynak adı ayarlanır.

Örnekte, tüm ayarlanmış alanları numaralandıran bir alan maskesini otomatik olarak oluşturmak için kampanyada FieldMasks.allSetFieldsOf() yöntemi kullanılmaktadır. Daha sonra döndürülen maskeyi doğrudan güncelleme çağrısına iletebilirsiniz.

Birkaç alanı güncellemek için mevcut bir nesneyle çalışmanız gerekiyorsa kodu aşağıdaki gibi değiştirebilirsiniz:

Campaign existingCampaign;

// Obtains existingCampaign from elsewhere.
...

// Creates a new campaign based off the existing campaign and updates the
// campaign by setting its status to paused.
Campaign campaignToUpdate =
    existingCampaign.toBuilder()
        .setStatus(CampaignStatus.PAUSED)
        .build();

// Constructs an operation that will update the campaign, using the FieldMasks'
// compare utility to derive the update mask. This mask tells the Google Ads API
// which attributes of the campaign you want to change.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaignToUpdate)
        .setUpdateMask(FieldMasks.compare(existingCampaign, campaignToUpdate))
        .build();

// Sends the operation in a mutate request.
MutateCampaignsResponse response =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Sıfırdan bir alan maskesi oluşturmak için önce bir FieldMask nesnesi oluşturur, ardından değiştirmeyi planladığınız her alanın adını nesneye eklersiniz.

FieldMask fieldMask =
    FieldMask.newBuilder()
        .addPaths("status")
        .addPaths("name")
        .build();

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

MESSAGE alanları, alt alanlara (ör. MaximizeConversions alanının üç alt alanı vardır: target_cpa_micros, cpc_bid_ceiling_micros ve cpc_bid_floor_micros) veya hiç alt alana sahip olmayabilir (ör. ManualCpm).

Alt alanları tanımlanmamış ileti alanları

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

Tanımlanmış alt alanlara sahip ileti alanları

Bir iletideki alt alanları açıkça ayarlamadan alt alanlarla tanımlanmış bir MESSAGE alanını güncellerken, değiştirilebilir MESSAGE alt alanlarının her birini FieldMask'ye manuel olarak eklemeniz gerekir. Bu işlem, yukarıdaki örnekte olduğu gibi sıfırdan bir alan maskesi oluşturmaya benzer.

Bunun yaygın bir örneği, yeni teklif stratejisindeki alanlardan herhangi birini ayarlamadan bir kampanyanın teklif stratejisini güncellemedir. Aşağıdaki örnekte, teklif stratejisinde alt alanların hiçbirini ayarlamadan bir kampanyayı MaximizeConversions teklif stratejisini kullanacak şekilde nasıl güncelleyeceğiniz gösterilmektedir.

Bu durumda, FieldMaskUtil'in allSetFieldsOf() ve compare() yöntemlerinin kullanılması amaçlanan hedefi gerçekleştirmez.

Aşağıdaki örnek, maximize_conversions içeren bir alan maskesi oluşturur. 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.

Uyarı: Aşağıdaki kod hata oluşturur.

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .setMaximizeConversions(MaximizeConversions.newBuilder().build())
    .build();

// 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 =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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 =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Aşağıdaki örnekte, alt alanlarından herhangi biri ayarlanmadan bir kampanyanın MaximizeConversions teklif stratejisini kullanacak şekilde nasıl doğru şekilde güncelleneceği gösterilmektedir.

Başarı: Aşağıdaki kod, kampanyanın teklif stratejisini başarıyla günceller.

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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 fieldMask = FieldMasks.allSetFieldsOf(campaign)
    .toBuilder()
    // 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
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask)
        .build();

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 stratejisinin kullanıldığı 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ışır ancak maximize_conversions.target_cpa_micros alan maskesine eklenmez. Bu nedenle target_cpa_micros alanında herhangi bir değişiklik yapılmaz:

Uyarı: Bu kod hata oluşturmaz ancak target_cpa_micros MaximizeConversions teklif stratejisinin temizlenmez.

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
Campaign campaign =
    Campaign.newBuilder()
        .setResourceName(ResourceNames.campaign(customerId, campaignId))
        .setMaximizeConversions(
            MaximizeConversions.newBuilder().setTargetCpa(0).build())
        .setStatus(CampaignStatus.PAUSED)
        .build();

// 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 =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(FieldMasks.allSetFieldsOf(campaign))
        .build();

// 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 =
    campaignServiceClient.mutateCampaigns(
        customerId.toString(), Collections.singletonList(operation));

Sonraki örnekte, target_cpa_microsMaximizeConversions teklif stratejisindeki alanın nasıl doğru şekilde temizleneceği gösterilmektedir.

Başarılı: Aşağıdaki kod, target_cpa_micros öğesini temizliyor.

// Creates a Campaign object with the proper resource name.
Campaign campaign = Campaign.newBuilder()
    .setResourceName(ResourceNames.campaign(customerId, campaignId))
    .build();

// 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)
    .toBuilder()
    .addPaths("maximize_conversions.target_cpa_micros")
    .build();

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation =
    CampaignOperation.newBuilder()
        .setUpdate(campaign)
        .setUpdateMask(fieldMask))
        .build();

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

Önemli nokta: Bir alanı temizlemek istiyorsanız bu hedefe ulaşmanın en güvenli yolu, söz konusu alanı alan maskesine açıkça eklemektir.