Mask Kolom

Peringatan: Mulai dari versi 19.0.0, Library klien Google Ads API untuk .NET akan tidak lagi mendukung .NET 5.0. Untuk memastikan pengoperasian yang lancar, sebaiknya mengupgrade versi .NET Anda sebelum akhir tahun 2024.

Di Google Ads API, pembaruan dilakukan menggunakan mask kolom. Daftar mask kolom semua kolom yang ingin Anda ubah dengan update, serta kolom tertentu yang tidak ada dalam mask kolom akan diabaikan, bahkan jika dikirim ke server.

FieldMaskUtil

Cara yang direkomendasikan untuk membuat mask kolom adalah menggunakan mask kolom bawaan kami utilitas, yang memungkinkan Anda menghasilkan mask kolom dari objek yang dimodifikasi, membuatnya dari awal.

Berikut adalah contoh untuk memperbarui kampanye:

// Update campaign by setting its status to paused, and "Search network" to false.
Campaign campaignToUpdate = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    NetworkSettings = new NetworkSettings()
    {
        TargetSearchNetwork = false
    }
};

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};

// Update the campaign.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

Pertama, kita membuat objek Campaign kosong. Kemudian, kita tetapkan nama sumber dayanya sehingga API akan mengetahui kampanye yang sedang diperbarui.

Contoh ini menggunakan metode FieldMasks.AllSetFieldsOf pada kampanye secara otomatis menghasilkan mask kolom yang menghitung semua kolom yang ditetapkan. Anda kemudian dapat meneruskan mask yang ditampilkan secara langsung ke panggilan update.

Terkadang, Anda mungkin perlu bekerja dengan objek yang sudah ada, dan memperbarui beberapa kolom. Dalam kasus tersebut, Anda perlu memodifikasi kode sebagai berikut:

Campaign existingCampaign;

// Obtain existingCampaign from elsewhere.
...

// Create a new campaign based off the existing campaign for update.
Campaign campaignToUpdate = new Campaign(existingCampaign);

// Update campaign by setting its status to paused, and "Search network" to
// false.
campaignToUpdate.Status = CampaignStatus.Paused;
campaignToUpdate.NetworkSettings = new NetworkSettings()
{
    TargetSearchNetwork = false
}

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.FromChanges(existingCampaign, campaignToUpdate)
};

Untuk membuat mask kolom dari awal, pertama-tama Anda akan membuat FieldMask , lalu buat sebuah array yang berisi nama semua kolom yang ingin Anda diubah, dan terakhir menambahkan konten array ke kolom Path mask kolom.

FieldMask fieldMask = new FieldMask();
fieldMask.Paths.AddRange(new string[] { "status", "name" });

Memperbarui kolom pesan dan subkolomnya

Kolom MESSAGE dapat memiliki subkolom (seperti MaximizeConversions yang memiliki tiga: target_cpa_micros, cpc_bid_ceiling_micros, dan cpc_bid_floor_micros), atau keduanya dapat tidak memiliki keduanya (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 di atas.

Kolom pesan dengan subkolom yang ditentukan

Saat memperbarui kolom MESSAGE yang ditentukan dengan subkolom tanpa secara eksplisit setiap subkolom pada pesan tersebut, Anda harus tambahkan setiap subkolom MESSAGE yang dapat diubah ke FieldMask, mirip dengan contoh di atas yang membuat mask kolom dari awal.

Satu contoh umum adalah memperbarui strategi bidding kampanye tanpa menetapkan kolom pada strategi bidding baru. Contoh di bawah ini menunjukkan cara perbarui kampanye untuk menggunakan Strategi bidding MaximizeConversions tanpa menetapkan subkolom apa pun pada strategi bidding.

Dalam hal ini, menggunakan metode AllSetFieldsOf() dan FromChanges() FieldMasks tidak mencapai sasaran yang diinginkan.

Contoh berikut menghasilkan mask kolom yang menyertakan maximize_conversions. Namun, Google Ads API tidak mengizinkan perilaku ini mencegah pembersihan {i>field <i}secara tidak sengaja dan menghasilkan FieldMaskError.FIELD_HAS_SUBFIELDS {i>error<i}.

Peringatan: Kode berikut menghasilkan error.

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = 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 operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

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

Berhasil: Kode di bawah berhasil memperbarui strategi bidding kampanye.

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
};

// Creates a field mask from the existing campaign and adds all of the fields
// on the MaximizeConversions bidding strategy to the field mask. Because these
// fields are 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 with none of its subfields set.
FieldMask 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.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

Mengosongkan Kolom

Beberapa kolom dapat dihapus secara eksplisit. Mirip dengan contoh di atas, Anda harus secara eksplisit menambahkan kolom ini ke mask kolom. Misalnya, anggaplah Anda memiliki kampanye yang menggunakan strategi bidding MaximizeConversions dan bahwa Kolom target_cpa_micros ditetapkan dengan nilai yang lebih besar dari 0.

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

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

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
    {
        TargetCpaMicros = 0
    }
};

// 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 operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

Contoh berikutnya menunjukkan cara menghapus target_cpa_micros dengan benar pada strategi bidding MaximizeConversions.

Berhasil: Kode berikut menghapus target_cpa_micros.

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(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 fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

Perhatikan bahwa "salah" contoh di atas berfungsi sebagaimana mestinya untuk kolom yang ditetapkan sebagai optional di Google Ads API protocol buffers. Tapi karena target_cpa_micros bukan kolom optional, berarti "salah" tidak memperbarui strategi bidding untuk mengosongkan kolom target_cpa.

Poin Penting: Jika Anda ingin membersihkan suatu bidang, cara paling aman untuk melakukannya tujuannya adalah menambahkan kolom tersebut secara eksplisit ke mask kolom.