Mask Kolom

Di Google Ads API, pembaruan dilakukan menggunakan mask kolom. Mask kolom mencantumkan semua kolom yang ingin Anda ubah dengan update, dan setiap kolom yang ditentukan yang tidak ada dalam mask kolom akan diabaikan, meskipun dikirim ke server. Anda dapat membuat mask kolom secara manual, dengan membuat Google\Protobuf\FieldMask, membuat array yang diisi dengan nama semua kolom yang ingin Anda ubah, lalu menetapkannya ke kolom jalur mask kolom.

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

Berikut adalah contoh untuk memperbarui kampanye:

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

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

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

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

Perhatikan bahwa FieldMasks::allSetFieldsOf adalah metode yang mudah 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 allSetFieldsOf().

Memperbarui kolom pesan dan sub-kolomnya

Kolom MESSAGE dapat memiliki subkolom (seperti MaximizeConversions yang memiliki tiga: target_cpa_micros, cpc_bid_ceiling_micros, dan cpc_bid_floor_micros), atau tidak memilikinya 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 pada pesan tersebut secara eksplisit, Anda harus menambahkan setiap subkolom MESSAGE yang dapat diubah secara manual ke FieldMask, 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 di bawah ini menunjukkan cara memperbarui kampanye untuk menggunakan strategi bidding MaximizeConversions tanpa menetapkan subkolom apa pun pada strategi bidding.

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

Kode berikut menghasilkan mask kolom 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.

Peringatan: Kode berikut menghasilkan error.

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

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

Berhasil: Kode di bawah berhasil memperbarui strategi bidding kampanye.

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

Menghapus kolom

Beberapa kolom dapat dihapus secara eksplisit. Serupa dengan contoh sebelumnya, Anda harus menambahkan kolom ini secara eksplisit ke mask kolom. Misalnya, 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:

Peringatan: Kode ini tidak menghasilkan error, tetapi target_cpa_micros strategi bidding MaximizeConversions tidak akan dihapus.

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

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

Berhasil: Kode berikut menghapus target_cpa_micros.

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

Perhatikan bahwa kode "salah" berfungsi sebagaimana mestinya untuk kolom yang ditentukan sebagai optional di protocol buffers Google Ads API. Namun, karena target_cpa_micros bukan kolom optional, kode "incorrect" tidak memperbarui strategi bidding untuk menghapus kolom target_cpa.

Poin Penting: Jika Anda ingin menghapus kolom, cara teraman adalah dengan menambahkan kolom tersebut secara eksplisit ke mask kolom.