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önderilseler bile yoksayılır. Alan maskesini manuel olarak oluşturmak için Google\Protobuf\FieldMask oluşturabilir, değiştirmek istediğiniz tüm alanların adlarıyla doldurulmuş bir dizi oluşturabilir ve ardından bunu alan maskesinin yol alanına atayabilirsiniz.

Belirli ayrıntıların çoğunu gizleyen ve varlığın alanlarında yaptığınız değişiklikleri izleyerek otomatik olarak alan maskeleri oluşturmanızı sağlayan, yerleşik alan maskesi yardımcı programmızı (FieldMasks) de kullanabilirsiniz.

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

    $campaign = new Campaign([
        'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
        'status' => CampaignStatus::PAUSED
    ]);

    $campaignOperation = new CampaignOperation();
    $campaignOperation->setUpdate($campaign);
    $campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

Bu kod önce bir Kampanya nesnesi oluşturur ve ardından ResourceNames kullanarak kaynak adını ayarlar. Böylece API, hangi kampanyanın güncellenmekte olduğunu bilir. status de PAUSED olarak ayarlandı.

Daha sonra kod, bir CampaignOperation nesnesi oluşturur ve önceden oluşturulan kampanyayı buna ayarlar. Sonrasında, değiştirilen tüm alanları kullanarak kampanya için bir alan maskesi oluşturmak üzere FieldMasks::allSetFieldsOf() aracını kullanır. Son olarak, döndürülen maskeyi kampanya işlem nesnesine iletir.

FieldMasks::allSetFieldsOf yönteminin, FieldMasks::compare() için uygun bir yöntem olduğunu unutmayın. Geçirdiğiniz nesneyi aynı sınıftaki boş bir nesneyle karşılaştırır. Örneğin, önceki kodda allSetFieldsOf() yerine FieldMasks::compare(new Campaign(), $campaign) kullanabilirsiniz.

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 alanla tanımlanmamış bir MESSAGE alanını güncellerken, daha önce açıklandığı gibi alan maskesi oluşturmak için FieldMasks özelliğini 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 önceki ö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 kod, teklif stratejisinin alt alanlarını ayarlamadan bir kampanyayı MaximizeConversions teklif stratejisini kullanacak şekilde nasıl güncelleyeceğinizi gösterir.

Bu durumda FieldMasks için allSetFieldsOf() ve compare() yöntemlerinin kullanılması amaçlanan hedefe ulaşmaz.

Aşağıdaki kod, 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ına neden olur.

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => 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 = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(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.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

Aşağıdaki kod, bir kampanyayı alt alanlarından birini ayarlamadan MaximizeConversions teklif stratejisini kullanacak şekilde doğru şekilde nasıl güncelleyeceğinizi gösterir.

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);

// 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 = 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->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

Alanlar temizleniyor

Bazı alanlar açıkça temizlenebilir. Önceki örnekte olduğu gibi, 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 değerinden 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 = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions(['target_cpa' => 0]),
    'status' => CampaignStatus::PAUSED
]);

// 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 = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(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.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

Aşağıdaki kod, 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 = new Campaign([
    'resource_name' => ResourceNames::forCampaign($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 = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

"Hatalı" kodun, Google Ads API protocol buffers'de optional olarak tanımlanan alanlarda amaçlandığı gibi çalıştığını unutmayın. Ancak target_cpa_micros bir optional alanı olmadığından, "yanlış" kod teklif stratejisini target_cpa alanını temizleyecek şekilde güncellemez.