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 tüm alanlar, sunucuya gönderilse bile yoksayılır. Google\Protobuf\FieldMask oluşturup değiştirmek istediğiniz tüm alanların adlarıyla doldurulan bir dizi hazırladıktan sonra bunu alan maskesinin yol alanına atayarak manuel olarak alan maskesi oluşturabilirsiniz.

Belirli ayrıntıların çoğunu gizleyen ve varlığın alanlarında yaptığınız değişiklikleri izleyerek alan maskelerini otomatik olarak oluşturmanıza olanak tanıyan yerleşik alan maskesi yardımcı programımı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 kaynak adını ResourceNames kullanarak ayarlar. Böylece API, hangi kampanyanın güncellendiğini bilir. status değeri de PAUSED olarak ayarlandı.

Kod, daha sonra bir CampaignOperation nesnesi oluşturur ve önceden oluşturulan kampanyayı buna ayarlar. Ardından, değiştirilen tüm alanları kullanarak kampanya için bir alan maskesi oluşturmak üzere FieldMasks::allSetFieldsOf()'ten yararlanır. Son olarak, döndürülen maskeyi kampanya işlem nesnesine iletir.

FieldMasks::allSetFieldsOf işlevinin FieldMasks::compare() için kullanışlı bir yöntem olduğunu unutmayın. İletilen nesnenizi aynı sınıfın boş bir nesnesiyle karşılaştırır. Örneğin, önceki kodda allSetFieldsOf() yerine FieldMasks::compare(new Campaign(), $campaign) kullanabilirdiniz.

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

MESSAGE alanlarının alt alanları olabilir (ör. target_cpa_micros, cpc_bid_ceiling_micros ve cpc_bid_floor_micros) MaximizeConversions veya hiçbir alt alan bulunmayabilir (ör. ManualCpm).

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

Herhangi bir alt alanla tanımlanmamış bir MESSAGE alanını güncellerken, daha önce açıklandığı gibi alan maskesi oluşturmak için FieldMasks öğesini kullanın.

Tanımlanmış alt alanlara sahip mesaj alanları

Alt alanlarla tanımlanan bir MESSAGE alanını, söz konusu mesajdaki alt alanlardan hiçbirini açık bir şekilde ayarlamadan güncellerken, sıfırdan alan maskesi oluşturan önceki örneğe benzer şekilde değişebilir MESSAGE alt alanlarının her birini FieldMask öğesine manuel olarak eklemeniz gerekir.

Sık karşılaşılan bir örnek olarak, yeni teklif stratejisinde herhangi bir alanı ayarlamadan kampanyanın teklif stratejisini güncellemek gösterilebilir. Aşağıdaki kod, teklif stratejisindeki alt alanlardan hiçbiri ayarlanmadan bir kampanyanın MaximizeConversions teklif stratejisini kullanacak şekilde nasıl güncelleneceğini 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 değerini 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 kampanyanın alt alanlarını ayarlamadan MaximizeConversions teklif stratejisini kullanacak şekilde doğru şekilde nasıl güncelleneceğini 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 ö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 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 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);

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