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. Alan maskesinde bulunmayan belirtilen alanlar, sunucuya gönderilmiş olsa bile yoksayılır. Google\Protobuf\FieldMask oluşturarak, değiştirmek istediğiniz tüm alanların adlarıyla doldurulmuş bir dizi oluşturarak ve ardından bunu alan maskesinin yol alanına atayarak manuel olarak bir alan maskesi oluşturabilirsiniz.
Ayrıca, yerleşik alan maskesi yardımcı programımızı (FieldMasks) da kullanabilirsiniz. Bu yardımcı program, belirli ayrıntıların çoğunu gizler ve öğenin alanlarında yaptığınız değişiklikleri izleyerek otomatik olarak alan maskeleri oluşturmanıza olanak tanır.
Aşağıda bir kampanyayı güncelleme örneği 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 Campaign nesnesi oluşturur ve ardından API'nin hangi kampanyanın güncellendiğini bilmesi için ResourceNames kullanarak kaynak adını ayarlar. status da PAUSED olarak ayarlanır.
Ardından kod bir CampaignOperation nesnesi oluşturur ve daha önce oluşturulan kampanyayı bu nesneye ayarlar. Ardından, değiştirilen tüm alanları kullanarak kampanya için bir alan maskesi oluşturmak üzere FieldMasks::allSetFieldsOf() işlevini kullanır. Son olarak, döndürülen maskeyi kampanya işlemi nesnesine iletir.
FieldMasks::allSetFieldsOf'ün FieldMasks::compare() için uygun bir yöntem olduğunu unutmayın.
İletilen nesnenizi 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ında alt alanlar olabilir (ör. target_cpa_micros, cpc_bid_ceiling_micros ve cpc_bid_floor_micros olmak üzere üç alt alanı olan MaximizeConversions) veya hiç alt alan olmayabilir (ör. ManualCpm).
Tanımlanmış alt alanı olmayan mesaj alanları
Herhangi bir alt alanla tanımlanmayan bir MESSAGE alanını güncellerken, daha önce açıklandığı gibi bir alan maskesi oluşturmak için FieldMasks kullanın.
Tanımlanmış alt alanları olan ileti alanları
Alt alanlarla tanımlanan bir MESSAGE alanını, ilgili iletideki alt alanlardan hiçbirini açıkça ayarlamadan güncellerken, sıfırdan alan maskesi oluşturan önceki örneğe benzer şekilde, değiştirilebilir MESSAGE alt alanlarının her birini FieldMask alanına manuel olarak eklemeniz gerekir.
Sık karşılaşılan bir örnek, yeni teklif stratejisindeki hiçbir alanı ayarlamadan bir kampanyanın teklif stratejisini güncellemektir. Aşağıdaki kod, bir kampanyanın teklif stratejisindeki alt alanlardan hiçbirini ayarlamadan MaximizeConversions teklif stratejisini kullanacak şekilde nasıl güncelleneceğini gösterir.
Bu durumda, FieldMasks sınıfının 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ı oluşturur.
// 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 kodda, bir kampanyanın alt alanlarından herhangi birini ayarlamaksızın MaximizeConversions teklif stratejisini kullanacak şekilde nasıl doğru şekilde güncelleneceği gösterilmektedir.
// 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ı temizleme
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'den 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 stratejisindeki target_cpa_micros alanının nasıl doğru şekilde temizleneceğini göstermektedir.
// 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ış" kodunun, Google Ads API'de optional olarak tanımlanan alanlar için amaçlandığı gibi çalıştığını unutmayın protocol buffers. Ancak target_cpa_micros bir optional alanı olmadığından "yanlış" kod, teklif stratejisini target_cpa alanını temizleyecek şekilde güncellemez.