Mask Kolom

Di Google Ads API, pembaruan dilakukan menggunakan mask kolom. Mask kolom mencantumkan semua kolom yang ingin Anda ubah dengan update, dan kolom tertentu yang tidak ada di mask kolom akan diabaikan, meskipun dikirim ke server.

FieldMaskUtil

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

Berikut 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 menetapkan nama resource-nya sehingga API akan mengetahui persis kampanye mana yang kita perbarui.

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

Terkadang, Anda mungkin perlu bekerja dengan objek yang ada, dan memperbarui beberapa kolom. Dalam kasus tersebut, Anda akan mengubah 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, Anda harus membuat objek FieldMask terlebih dahulu, lalu membuat array yang diisi dengan nama semua kolom yang ingin Anda ubah, 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 sub-kolomnya

Kolom MESSAGE dapat memiliki subkolom (seperti MaximizeConversions yang memiliki tiga subkolom: 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 sub-kolom 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 sub-kolom tanpa menetapkan sub-kolom apa pun secara eksplisit pada pesan tersebut, Anda harus menambahkan setiap sub-kolom MESSAGE yang dapat diubah secara manual ke FieldMask, mirip dengan contoh di atas yang membuat mask kolom dari awal.

Salah satu contoh umum adalah memperbarui strategi bidding kampanye tanpa menetapkan kolom apa pun pada strategi bidding baru. Contoh di bawah menunjukkan cara memperbarui kampanye untuk menggunakan strategi bidding MaximizeConversions tanpa menetapkan sub-bidang apa pun pada strategi bidding.

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

Contoh berikut menghasilkan mask kolom yang mencakup 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 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 strategi bidding MaximizeConversions tanpa menyetel subfield-nya.

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

Menghapus Kolom

Beberapa kolom dapat dihapus secara eksplisit. Mirip dengan contoh di atas, Anda harus menambahkan kolom ini secara eksplisit ke mask kolom. Misalnya, anggaplah Anda memiliki kampanye yang menggunakan strategi bidding MaximizeConversions dan 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 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 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 kolom target_cpa_micros dengan benar pada strategi bidding MaximizeConversions.

// 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 contoh "salah" di atas berfungsi sebagaimana mestinya untuk kolom yang ditetapkan sebagai optional di Google Ads API protocol buffers. Namun, karena target_cpa_micros bukan kolom optional, contoh "salah" tidak memperbarui strategi bidding untuk menghapus kolom target_cpa.