Mask kolom

Di Google Ads API, pembaruan dilakukan menggunakan mask kolom. Masker kolom mencantumkan semua kolom yang ingin Anda ubah dengan update, dan kolom tertentu yang tidak ada dalam masker kolom akan diabaikan, meskipun dikirim ke server. Anda dapat membuat field mask secara manual dengan membuat FieldMask (Google\Protobuf\FieldMask), membuat array yang diisi dengan nama semua kolom yang ingin Anda ubah, lalu menetapkan array tersebut ke kolom paths field mask.

Anda juga dapat menggunakan utilitas field mask bawaan kami (FieldMasks), yang menyembunyikan banyak detail spesifik dan memungkinkan Anda membuat field mask secara otomatis dengan memeriksa perubahan yang Anda buat pada kolom entity.

Berikut contoh untuk memperbarui kampanye:

$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);

$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

Kode ini pertama-tama membuat objek Campaign, lalu menetapkan nama resource-nya menggunakan ResourceNames, sehingga API mengetahui kampanye mana yang sedang diperbarui. status juga ditetapkan ke CampaignStatus::PAUSED.

Kode tersebut kemudian membuat objek CampaignOperation dan menetapkan kampanye yang dibuat sebelumnya ke objek tersebut. Setelah itu, kode ini menggunakan FieldMasks::allSetFieldsOf() untuk membuat masker kolom bagi kampanye dengan menghitung semua kolom yang diubah. Terakhir, fungsi ini meneruskan masker yang ditampilkan ke objek operasi kampanye.

Perhatikan bahwa FieldMasks::allSetFieldsOf() adalah metode praktis untuk FieldMasks::compare(). Metode ini membandingkan objek yang Anda teruskan dengan objek kosong dari class yang sama. Misalnya, dalam kode sebelumnya, Anda dapat menggunakan FieldMasks::compare(new Campaign(), $campaign), bukan FieldMasks::allSetFieldsOf($campaign).

Memperbarui kolom pesan dan subkolomnya

Kolom MESSAGE dapat memiliki subkolom (seperti MaximizeConversions, yang mencakup subkolom seperti target_cpa_micros, cpc_bid_ceiling_micros, dan cpc_bid_floor_micros), atau tidak memiliki subkolom sama sekali (seperti ManualCpm).

Kolom pesan tanpa subkolom yang ditentukan

Saat memperbarui kolom MESSAGE yang tidak ditentukan dengan subkolom apa pun, gunakan FieldMasks untuk membuat mask kolom, seperti yang dijelaskan sebelumnya.

Kolom pesan dengan subkolom yang ditentukan

Saat memperbarui kolom MESSAGE yang ditentukan dengan subkolom tanpa menetapkan subkolom apa pun secara eksplisit pada pesan tersebut, Anda harus menambahkan setiap subkolom MESSAGE yang dapat diubah ke FieldMask secara manual, mirip dengan contoh sebelumnya yang membuat mask kolom dari awal.

Salah satu contoh umum adalah memperbarui strategi bidding kampanye tanpa menetapkan kolom apa pun pada strategi bidding baru. Kode berikut menunjukkan cara memperbarui kampanye untuk menggunakan strategi bidding MaximizeConversions tanpa menetapkan subkolom apa pun pada strategi bidding.

Dalam hal ini, penggunaan metode allSetFieldsOf() dan compare() dari FieldMasks tidak mencapai sasaran yang diinginkan.

Kode berikut menghasilkan field mask yang menyertakan maximize_conversions. Namun, Google Ads API tidak mengizinkan perilaku ini untuk mencegah penghapusan kolom secara tidak sengaja, dan menghasilkan error FieldMaskError.FIELD_HAS_SUBFIELDS.

// 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])
);

Kode berikut menunjukkan cara memperbarui kampanye dengan benar untuk menggunakan strategi bidding MaximizeConversions tanpa menetapkan subkolomnya.

// 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);

Hapus kolom

Beberapa kolom dapat dihapus secara eksplisit. Serupa dengan contoh sebelumnya, Anda harus secara eksplisit menambahkan kolom ini ke mask kolom karena FieldMasks mengabaikan kolom skalar Proto3 yang ditetapkan ke nilai defaultnya (seperti 0, false, atau ""). Misalnya, asumsikan Anda memiliki kampanye yang menggunakan strategi bidding MaximizeConversions dan kolom target_cpa_micros ditetapkan dengan nilai yang lebih besar dari 0.

Kode berikut akan berjalan; namun, maximize_conversions.target_cpa_micros tidak akan ditambahkan ke mask kolom sehingga tidak ada perubahan yang dilakukan pada kolom target_cpa_micros:

// 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])
);

Kode berikut menunjukkan cara menghapus kolom target_cpa_micros dengan benar pada strategi bidding MaximizeConversions.

// 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);

Perhatikan bahwa menetapkan nilai default berfungsi sebagaimana mestinya untuk kolom yang ditentukan sebagai optional di buffering protokol Google Ads API. Namun, karena target_cpa_micros bukan kolom optional, menetapkannya ke 0 tanpa menambahkan jalur secara eksplisit ke mask kolom tidak akan memperbarui strategi bidding untuk menghapus target_cpa_micros.