Method: customers.googleAds.mutate

Membuat, memperbarui, atau menghapus resource. Metode ini mendukung transaksi atomik dengan beberapa jenis resource. Misalnya, Anda dapat membuat kampanye dan anggaran kampanye secara atomik, atau melakukan hingga ribuan perubahan secara atomik.

Metode ini pada dasarnya adalah wrapper di sekitar serangkaian metode yang bermutasi. Satu-satunya fitur yang ditawarkannya daripada memanggil metode tersebut secara langsung adalah:

  • Transaksi atomik
  • Nama resource sementara (dijelaskan di bawah)
  • Mengurangi latensi karena melakukan serangkaian panggilan yang bermutasi

Catatan: Hanya resource yang mendukung transaksi atomik yang disertakan, sehingga metode ini tidak dapat mengganti semua panggilan ke setiap layanan.

Manfaat Transaksi Atom

Atomisitas membuat penanganan error menjadi lebih mudah. Jika Anda membuat serangkaian perubahan dan satu perubahan gagal, kondisi ini dapat membuat akun Anda menjadi tidak konsisten. Dengan atomicity, Anda dapat langsung menjangkau status yang dipilih, atau permintaan akan gagal dan Anda dapat mencoba lagi.

Nama Resource Temperatur

Nama resource sementara adalah jenis nama resource khusus yang digunakan untuk membuat resource dan mereferensikan resource tersebut dalam permintaan yang sama. Misalnya, jika anggaran kampanye dibuat dengan resourceName yang setara dengan customers/123/campaignBudgets/-1, nama resource tersebut dapat digunakan kembali di kolom Campaign.budget dalam permintaan yang sama. Dengan begitu, dua sumber daya dibuat dan ditautkan secara atomik.

Untuk membuat nama resource sementara, masukkan angka negatif di bagian nama yang biasanya akan dialokasikan server.

Catatan:

  • Resource harus dibuat dengan nama sementara sebelum nama tersebut dapat digunakan kembali. Misalnya, contoh CampaignBudget+Kampanye sebelumnya akan gagal jika urutan mutasi dibatalkan.
  • Nama sementara tidak diingat di seluruh permintaan.
  • Tidak ada batasan jumlah nama sementara dalam permintaan.
  • Setiap nama sementara harus menggunakan angka negatif yang unik, meskipun jenis resource berbeda.

Latensi

Penting untuk mengelompokkan mutasi berdasarkan jenis resource. Jika tidak, permintaan dapat habis waktu tunggunya dan gagal. Latensi kurang lebih sama dengan serangkaian panggilan ke metode mutasi individual, dengan setiap perubahan dalam jenis resource adalah panggilan baru. Misalnya, mengubah 10 kampanye, lalu 10 grup iklan akan sama dengan 2 panggilan, sedangkan mengubah 1 kampanye, 1 grup iklan, 1 kampanye, 1 grup iklan sama dengan 4 panggilan.

Daftar {9AdCustomizerErrorAdErrorAdGroupAdErrorAdGroupCriterionErrorAdGroupErrorAssetErrorAuthenticationErrorAuthorizationErrorBiddingErrorCampaignBudgetErrorCampaignCriterionErrorCampaignErrorCampaignExperimentErrorCampaignSharedSetErrorCollectionSizeErrorContextErrorConversionActionErrorCriterionErrorCustomerFeedErrorDatabaseErrorDateErrorDateRangeErrorDistinctErrorExtensionFeedItemErrorExtensionSettingErrorFeedAttributeReferenceErrorFeedErrorFeedItemErrorFeedItemSetErrorFieldErrorFieldMaskErrorFunctionParsingErrorHeaderErrorImageErrorInternalErrorKeywordPlanAdGroupKeywordErrorKeywordPlanCampaignErrorKeywordPlanErrorLabelErrorListOperationErrorMediaUploadErrorMutateErrorNewResourceCreationErrorNullErrorOperationAccessDeniedErrorPolicyFindingErrorPolicyViolationErrorQuotaErrorRangeErrorRequestErrorResourceCountLimitExceededErrorSettingErrorSharedSetErrorSizeLimitErrorStringFormatErrorStringLengthErrorUrlFieldErrorUserListErrorYoutubeVideoRegistrationError

Permintaan HTTP

POST https://googleads.googleapis.com/v16/customers/{customerId}/googleAds:mutate

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
customerId

string

Wajib. ID pelanggan yang resource-nya diubah.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "mutateOperations": [
    {
      object (MutateOperation)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "responseContentType": enum (ResponseContentType)
}
Kolom
mutateOperations[]

object (MutateOperation)

Wajib. Daftar operasi yang akan dilakukan pada resource individual.
partialFailure

boolean

Jika true (benar), operasi yang berhasil akan dilakukan dan operasi yang tidak valid akan menampilkan error. Jika salah (false), semua operasi akan dilakukan dalam satu transaksi jika dan hanya jika semuanya valid. Defaultnya adalah false.
validateOnly

boolean

Jika true (benar), permintaan divalidasi tetapi tidak dijalankan. Hanya error yang ditampilkan, bukan hasil.
responseContentType

enum (ResponseContentType)

Setelan jenis konten respons. Menentukan apakah resource yang dapat berubah atau hanya nama resource yang harus ditampilkan setelah mutasi. Resource yang dapat berubah hanya akan ditampilkan jika resource memiliki kolom respons yang sesuai. Misalnya, MutateCampaignResult.campaign.

Isi respons

Pesan respons untuk GoogleAdsService.Mutate.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "partialFailureError": {
    object (Status)
  },
  "mutateOperationResponses": [
    {
      object (MutateOperationResponse)
    }
  ]
}
Kolom
partialFailureError

object (Status)

Error yang berkaitan dengan kegagalan operasi dalam mode kegagalan sebagian. Ditampilkan hanya jika partialFailure = true dan semua error terjadi di dalam operasi. Jika terjadi error di luar operasi (misalnya, error autentikasi), kami akan menampilkan error tingkat RPC.
mutateOperationResponses[]

object (MutateOperationResponse)

Semua respons untuk mutate tersebut.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/adwords

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.