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:

// 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 örnek ilk olarak boş bir Campaign nesnesi oluşturur ve ardından kaynağını ayarlar adını girmeniz gerekir.

Örnekte, şu işlemler için kampanyada FieldMasks.allSetFieldsOf() yöntemi kullanılmaktadır: otomatik olarak, tüm ayarlanmış alanları numaralandıran bir alan maskesi oluşturur. Ardından döndürülen maskeyi doğrudan güncelleme çağrısına iletin.

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

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 ardından, değiştirmek istediğiniz her bir alanın adını nesnesini tanımlayın.

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

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 FieldMaskUtil'i kullanarak 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()compare() FieldMaskUtil amaçlanan 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 = 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, bir kampanyanın Alt alanlarını ayarlamadan MaximizeConversions teklif stratejisi uygulayabilirsiniz.

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

"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.