Alan Maskeleri

Google Ads API'de güncellemeler alan maskesi kullanılarak yapılır. Alan maskesi, güncellemeyle değiştirmeyi planladığınız tüm alanları listeler ve alan maskesinde olmayan belirtilen alanlar, sunucuya gönderilse bile yoksayılır. Değiştirmeyi planladığınız tüm alanların adlarıyla doldurulmuş bir dizi oluşturup bunu alan maskesinin yol alanına atayarak alan maskesini manuel olarak oluşturabilirsiniz.Google\Protobuf\FieldMask

Ayrıca, belirli ayrıntıların çoğunu gizleyen ve öğenin 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) da kullanabilirsiniz.

Kampanya güncelleme örneğini aşağıda görebilirsiniz:

    $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, ardından ResourceNames kullanarak kaynak adını ayarlar. Böylece API, hangi kampanyanın güncellendiğini bilir. status değeri de PAUSED olarak ayarlanır.

Kod daha sonra bir CampaignOperation nesnesi oluşturur ve daha önce oluşturulan kampanyayı bu nesneye ayarlar. Ardından, tüm değiştirilen alanları kullanarak 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, FieldMasks::compare() için uygun bir yöntemdir. Bu kural, iletilen nesnenizi aynı sınıftaki boş bir nesneyle 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ı, alt alanlara (ör. MaximizeConversions alanının üç alt alanı vardır: target_cpa_micros, cpc_bid_ceiling_micros ve cpc_bid_floor_micros) veya hiç alt alana sahip olmayabilir (ör. ManualCpm).

Alt alanları tanımlanmamış ileti alanları

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

Tanımlanmış alt alanlara sahip ileti alanları

Bir iletideki alt alanlardan herhangi birini açıkça ayarlamadan alt alanlarla tanımlanmış bir MESSAGE alanını güncellerken, 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.

Bunun yaygın bir örneği, yeni teklif stratejisindeki alanlardan herhangi birini ayarlamadan bir kampanyanın teklif stratejisini güncellemedir. Aşağıdaki kod, teklif stratejisinde herhangi bir alt alan belirlemeden bir kampanyayı MaximizeConversions teklif stratejisini kullanacak şekilde nasıl güncelleyeceğinizi gösterir.

Bu durumda, FieldMasks yöntemlerinin allSetFieldsOf() ve compare() yöntemlerini kullanmak amaçlanan hedefe ulaşılmasını sağlamaz.

Aşağıdaki kod, maximize_conversions öğesini 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 kod, bir kampanyanın alt alanlarından herhangi biri ayarlanmadan 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 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 stratejisinin kullanıldığı 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ışır ancak maximize_conversions.target_cpa_micros alan maskesine eklenmez. 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, target_cpa_micros alanının MaximizeConversions teklif stratejisinde 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'sinde protocol buffers optional olarak tanımlanan alanlarda beklendiği gibi çalıştığını unutmayın. Ancak target_cpa_micros alanı bir optional alanı olmadığı için "yanlış" kod, target_cpa alanını temizlemek üzere teklif stratejisini güncellemez.