Alan Maskeleri

Google Ads API'de güncellemeler bir alan maskesi kullanılarak yapılır. Alan maskesi listeleri güncellemeyle değiştirmek istediğiniz tüm alanlar ve belirtilen tüm alanlar verileri, sunucuya gönderilse bile yoksayılır. Siz kullanarak manuel olarak bir alan maskesi, Google\Protobuf\FieldMask bir diziyi, değiştirmek istediğiniz tüm alanların adlarıyla doldurulduğunda ve ardından bunu alan maskesinin yol alanına atarsınız.

Yerleşik alan maskesi yardımcı programımızı da kullanabilirsiniz (FieldMasks) Bu, özel ayrıntıların çoğunu gizler ve alan oluşturmanıza olanak tanır. maskeleri otomatik olarak devre dışı bırakabilirsiniz.

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 daha sonra ResourceNames: Böylece API, hangi kampanyanın yayınlanmakta olduğunu bilir güncellendi. status değeri de PAUSED olarak ayarlandı.

Kod, daha sonra bir CampaignOperation nesnesi oluşturur ve öncekini, ona kampanya oluşturuyoruz. Ondan sonra, FieldMasks::allSetFieldsOf() kullanarak kampanya için bir alan maskesi oluşturun. Son olarak, döndürülen maskeyi kampanya işlem nesnesine geçirir.

Lütfen FieldMasks::allSetFieldsOf, FieldMasks::compare() İletilen nesnenizi aynı sınıfın boş bir nesnesiyle karşılaştırır. Örneğin, örnekte, ö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. Üç tane olan MaximizeConversions: target_cpa_micros, cpc_bid_ceiling_micros ve cpc_bid_floor_micros) ya da hiçbirinin olmaması (örneğin, ManualCpm).

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

Herhangi bir alt alanla tanımlanmayan bir MESSAGE alanını güncellerken FieldMasks kullanarak bir alan maskesi oluşturun.

Tanımlanmış alt alanlara sahip mesaj alanları

Aşağıdaki değer içermeyen alt alanlarla tanımlanmış bir MESSAGE alanını güncellerken: alt alanlardan herhangi birini açıkça ayarlarsanız manuel olarak mutable MESSAGE alt alanlarının her birini şuna benzer şekilde FieldMask öğesine ekleyin: sıfırdan bir alan maskesi oluşturan önceki örneğe bakalım.

Yaygın bir örnek olarak, bir kampanyanın teklif stratejisini herhangi bir yeni teklif stratejisinin Aşağıdaki kod, bir kampanyayı MaximizeConversions teklif stratejisi teklif stratejisindeki alt alanlardan hiçbirini ayarlamadan.

Bu durumda, allSetFieldsOf()compare() FieldMasks istenen hedefe ulaşamıyor.

Aşağıdaki kod, maximize_conversions değerini içeren bir alan maskesi oluşturur. Ancak Google Ads API, bu durumu önlemek için bu davranışa izin vermez: alanları yanlışlıkla temizler ve FieldMaskError.FIELD_HAS_SUBFIELDS hatası.

// 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 stratejisi uygulayabilirsiniz.

// 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ı açık bir şekilde alan maskesine eklemenizi öneririz. Örneğin, MaximizeConversions teklif stratejisi kullanan ve target_cpa_micros alanı, 0 değerinden büyük bir değerle ayarlanmış.

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ı:

// 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 etiketinin nasıl düzgün bir şekilde silineceğini gösterir alanına MaximizeConversions ulaşabilirsiniz.

// 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ış" bilginin kod, tanımlanmış alanlar için amaçlandığı gibi çalışıyor Google Ads API'de protocol buffers optional olarak. Ancak target_cpa_micros optional alanı değil, "yanlış" kodu güncellemez teklif stratejisini target_cpa alanını temizleyin.