Bu sayfa, Cloud Translation API ile çevrilmiştir.

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 ve alan maskesinde bulunmayan belirtilen alanlar sunucuya gönderilse bile yoksayılır.

FieldMaskUtil

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

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 daha sonra API'nin hangi kampanyanın güncellendiğini bilebilmesi için kaynak adını ayarlar.

Örnek, tüm ayarlanan alanları numaralandıran bir alan maskesini otomatik olarak oluşturmak için kampanyada FieldMasks.allSetFieldsOf() yöntemi kullanır. Ardından, 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 gerekirse kodu aşağıdaki şekilde 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 nesne olarak değiştirmek istediğiniz her bir alanın adını eklersiniz.

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 (örneğin, üç adet target_cpa_micros, cpc_bid_ceiling_micros ve cpc_bid_floor_micros içeren MaximizeConversions) veya hiç alt alan içeremez (ManualCpm gibi).

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

Alt alanlarla tanımlanmamış bir MESSAGE alanını güncellerken, yukarıda açıklandığı gibi bir alan maskesi oluşturmak için FieldMaskUtil öğesini kullanın.

Tanımlı alt alanları olan mesaj alanları

Alt alanlarla tanımlanmış bir MESSAGE alanını bu iletideki alt alanlardan herhangi birini açık bir şekilde ayarlamadan güncellerken, sıfırdan alan maskesi oluşturan yukarıdaki örnekte olduğu gibi, değişebilir MESSAGE alt alanlarının her birini FieldMask öğesine manuel olarak eklemeniz gerekir.

Yaygın bir örnek, yeni teklif stratejisindeki alanların hiçbirini ayarlamadan bir kampanyanın teklif stratejisini güncellemektir. Aşağıdaki örnekte, teklif stratejisinin alt alanlarını 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 hedefe ulaşmaz.

Aşağıdaki örnek, maximize_conversions değerini içeren bir alan maskesi oluşturur. Ancak Google Ads API, bu davranışın alanları yanlışlıkla temizlemesine izin vermez ve bir FieldMaskError.FIELD_HAS_SUBFIELDS hatasına neden olur.

// 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 kampanyayı alt alanlarından herhangi birini ayarlamadan MaximizeConversions teklif stratejisini kullanacak şekilde doğru şekilde nasıl güncelleyeceğiniz gösterilmektedir.

// 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 bir şekilde 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 =
    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 örnek, MaximizeConversions teklif stratejisinde target_cpa_micros alanının nasıl doğru şekilde temizleneceğini gösterir.

// 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 protocol buffers optional olarak tanımlanan alanlarda beklendiği 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.