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 olmayan belirtilen alanlar, sunucuya gönderilse bile yoksayılır. Manuel olarak alan maskesi oluşturmak için bir FieldMask (Google\Protobuf\FieldMask) oluşturabilir, değiştirmek istediğiniz tüm alanların adlarıyla doldurulmuş bir dizi oluşturabilir ve ardından bu diziyi alan maskesinin paths alanına atayabilirsiniz.
Ayrıca, belirli ayrıntıların çoğunu gizleyen ve öğenin alanlarında yaptığınız değişiklikleri inceleyerek alan maskelerini otomatik olarak oluşturmanıza olanak tanıyan yerleşik alan maskesi yardımcı programımızı (FieldMasks) da kullanabilirsiniz.
Bir kampanyayı güncellemeye ilişkin örnek:
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));
Bu kod önce bir Campaign nesnesi oluşturur ve ardından ResourceNames kullanarak kaynak adını ayarlar. Böylece API, hangi kampanyanın güncellendiğini bilir. status de CampaignStatus::PAUSED olarak ayarlandı.
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ı numaralandırarak kampanya için bir alan maskesi oluşturmak üzere FieldMasks::allSetFieldsOf() kullanır. Son olarak, döndürülen maskeyi kampanya işlemi nesnesine iletir.
FieldMasks::allSetFieldsOf() yönteminin, FieldMasks::compare() için kolaylık sağlayan bir yöntem olduğunu unutmayın. İlettiğiniz nesneyi aynı sınıftan boş bir nesneyle karşılaştırır. Örneğin, önceki kodda FieldMasks::allSetFieldsOf($campaign) 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 gibi alt alanları içeren MaximizeConversions) veya hiç alt alanı olmayabilir (ör. ManualCpm).
Tanımlanmış alt alanları olmayan mesaj alanları
Herhangi bir alt alanla tanımlanmamış 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 mesaj alanları
Alt alanlarla tanımlanmış bir MESSAGE alanını, mesajdaki alt alanlardan herhangi birini açıkça ayarlamadan güncellerken değiştirilebilir MESSAGE alt alanlarının her birini FieldMask'ye manuel olarak eklemeniz gerekir. Bu işlem, sıfırdan alan maskesi oluşturulan önceki örneğe benzer.
Sık karşılaşılan bir örnek, yeni teklif stratejisindeki alanlardan hiçbirini ayarlamadan bir kampanyanın teklif stratejisini güncellemektir. Aşağıdaki kod, teklif stratejisindeki alt alanlardan hiçbirini ayarlamadan MaximizeConversions teklif stratejisini kullanmak için bir kampanyanın nasıl güncelleneceğini gösterir.
Bu durumda, FieldMasks için allSetFieldsOf() ve compare() yöntemlerini kullanmak istenen amaca ulaşmayı sağlamaz.
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ı verir.
// 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 includes 'maximize_conversions',
// which produces 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 results in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns(
MutateCampaignsRequest::build($customerId, [$campaignOperation])
);
Aşağıdaki kod, bir kampanyanın alt alanlarından hiçbirini ayarlamadan MaximizeConversions teklif stratejisini kullanacak şekilde nasıl doğru şekilde 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 the mutable
// subfield 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 sets 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:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->getPaths()[] = '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ı temizle
Bazı alanlar açıkça temizlenebilir. Önceki örneğe benzer şekilde, FieldMasks varsayılan değerlerine (ör. 0, false veya "") ayarlanmış Proto3 skaler alanlarını yoksaydığı için 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ğere ayarlandığını varsayalım.
Aşağıdaki kod çalışı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_micros' => 0
]),
'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);
// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask does 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 succeeds, but does 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(
MutateCampaignsRequest::build($customerId, [$campaignOperation])
);
Aşağıdaki kodda, MaximizeConversions teklif stratejisindeki target_cpa_micros alanının nasıl doğru şekilde temizleneceği gösterilmektedir.
// 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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->getPaths()[] = '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);
Varsayılan değer ayarlamanın, Google Ads API protokol arabelleklerinde optional olarak tanımlanan alanlar için beklendiği gibi çalıştığını unutmayın. Ancak target_cpa_micros bir optional alanı olmadığından, yolu alan maskesine açıkça eklemeden 0 olarak ayarlamak, teklif stratejisini target_cpa_micros'i temizleyecek şekilde güncellemez.