Method: customers.uploadClickConversions

Memproses konversi klik yang diberikan.

Daftar error yang ditampilkan: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
customerId

string

Wajib. ID pelanggan yang melakukan upload.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
Kolom
conversions[]

object (ClickConversion)

Wajib. Konversi yang sedang diupload.
partialFailure

boolean

Wajib. 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. Nilai ini harus selalu ditetapkan ke true (benar). Lihat https://developers.google.com/google-ads/api/docs/best-practices/partial-failures untuk informasi selengkapnya tentang kegagalan sebagian.
validateOnly

boolean

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

boolean

Jika true (benar), API akan melakukan semua pemeriksaan upload dan menampilkan error jika ada yang ditemukan. Jika salah, fungsi ini hanya akan melakukan validasi input dasar, melewati pemeriksaan upload berikutnya, dan menampilkan keberhasilan meskipun tidak ada klik yang ditemukan untuk userIdentifiers yang disediakan.

Setelan ini hanya memengaruhi Konversi yang disempurnakan untuk upload prospek yang menggunakan userIdentifiers, bukan GCLID, GBRAID, atau WBRAID. Saat mengupload konversi yang disempurnakan untuk prospek, Anda harus mengupload semua peristiwa konversi ke API, termasuk peristiwa yang mungkin tidak berasal dari kampanye Google Ads. Upload peristiwa yang bukan dari kampanye Google Ads akan menghasilkan error CLICK_NOT_FOUND jika kolom ini ditetapkan ke true. Karena error ini sudah diperkirakan untuk peristiwa tersebut, tetapkan kolom ini ke false agar Anda dapat mengonfirmasi bahwa upload Anda diformat dengan benar, tetapi abaikan CLICK_NOT_FOUND error dari semua konversi yang bukan berasal dari kampanye Google Ads. Langkah ini memungkinkan Anda untuk berfokus hanya pada {i>error<i} yang dapat Anda atasi.

Defaultnya adalah false.
jobId

integer

Opsional. Input opsional untuk menetapkan ID tugas. Harus berupa angka yang tidak negatif yang kurang dari 2^31 jika diberikan. Jika kolom ini tidak disediakan, API akan menghasilkan ID pekerjaan dalam rentang [2^31, (2^63)-1]. API akan menampilkan nilai untuk permintaan ini dalam kolom jobId dari UploadClickConversionsResponse.

Isi respons

Pesan respons untuk ConversionUploadService.UploadClickConversions.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
Kolom
partialFailureError

object (Status)

Error yang berkaitan dengan kegagalan konversi dalam mode kegagalan sebagian. Ditampilkan saat semua error terjadi di dalam konversi. Jika terjadi error di luar konversi (misalnya, error autentikasi), kami akan menampilkan error tingkat RPC. Lihat https://developers.google.com/google-ads/api/docs/best-practices/partial-failures untuk informasi selengkapnya tentang kegagalan sebagian.
results[]

object (ClickConversionResult)

Ditampilkan untuk konversi yang berhasil diproses. Proto akan kosong untuk baris yang mengalami error. Hasil tidak ditampilkan jika validationOnly bernilai true (benar).
jobId

string (int64 format)

ID tugas untuk batch upload.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

ClickConversion

Konversi klik.

Representasi JSON 
{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "consent": {
    object (Consent)
  },
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}
Kolom
gbraid

string

ID klik untuk klik yang dikaitkan dengan konversi aplikasi dan berasal dari perangkat iOS mulai iOS 14.
wbraid

string

ID klik untuk klik yang terkait dengan konversi web dan berasal dari perangkat iOS mulai iOS 14.
externalAttributionData

object (ExternalAttributionData)

Data tambahan tentang konversi yang diatribusikan secara eksternal. Kolom ini wajib ada untuk konversi dengan tindakan konversi yang diatribusikan secara eksternal, tetapi tidak boleh ditetapkan jika sebaliknya.
customVariables[]

object (CustomVariable)

Variabel kustom yang terkait dengan konversi ini.
cartData

object (CartData)

Data keranjang yang terkait dengan konversi ini.
userIdentifiers[]

object (UserIdentifier)

ID pengguna yang terkait dengan konversi ini. Hanya hashedEmail dan hashedPhoneNumber yang didukung untuk upload konversi. Jumlah maksimum ID pengguna untuk setiap konversi adalah 5.
conversionEnvironment

enum (ConversionEnvironment)

Lingkungan tempat konversi ini dicatat, misalnya, Aplikasi atau Web.
consent

object (Consent)

Setelan izin untuk peristiwa.
gclid

string

ID klik (gclid) Google yang terkait dengan konversi ini.
conversionAction

string

Nama resource tindakan konversi yang terkait dengan konversi ini. Catatan: Meskipun nama resource ini terdiri dari ID pelanggan dan ID tindakan konversi, validasi akan mengabaikan ID pelanggan dan menggunakan ID tindakan konversi sebagai satu-satunya ID tindakan konversi.
conversionDateTime

string

Tanggal waktu saat konversi terjadi. Harus setelah waktu klik. Zona waktu harus ditentukan. Formatnya adalah "yyyy-mm-dd hh:mm:ss+|-hh:mm", misalnya, "2019-01-01 12:32:45-08:00".
conversionValue

number

Nilai konversi untuk pengiklan.
currencyCode

string

Mata uang yang terkait dengan nilai konversi. Ini adalah kode mata uang 3 karakter ISO 4217. Misalnya: USD, EUR.
orderId

string

ID pesanan yang terkait dengan konversi. ID pesanan hanya dapat digunakan untuk satu konversi per tindakan konversi.

ExternalAttributionData

Berisi informasi tambahan tentang konversi yang diatribusikan secara eksternal.

Representasi JSON 
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
Kolom
externalAttributionCredit

number

Menunjukkan bagian konversi yang diatribusikan ke klik Google Ads.
externalAttributionModel

string

Menentukan nama model atribusi.

CartData

Berisi informasi tambahan tentang data keranjang.

Representasi JSON 
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Kolom
merchantId

string (int64 format)

ID Merchant Center, tempat item diupload.
feedCountryCode

string

Kode negara yang terkait dengan feed tempat item diupload.
feedLanguageCode

string

Kode bahasa yang terkait dengan feed tempat item diupload.
localTransactionCost

number

Jumlah semua diskon tingkat transaksi, seperti pengiriman gratis dan diskon kupon untuk seluruh keranjang. Kode mata uang sama dengan kode dalam pesan ClickConversion.
items[]

object (Item)

Data item yang dibeli.

Item

Berisi data item yang dibeli.

Representasi JSON 
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
Kolom
productId

string

ID belanja item. Harus sama dengan kode produk Merchant Center.
quantity

integer

Jumlah item yang terjual.
unitPrice

number

Harga unit sebelum pajak, ongkos kirim, dan diskon tingkat transaksi. Kode mata uang sama dengan kode dalam pesan ClickConversion.

ConversionEnvironment

Lingkungan konversi dari konversi yang diupload.

Enum
UNSPECIFIED Tidak ditentukan.
UNKNOWN Hanya digunakan untuk nilai hasil. Mewakili nilai yang tidak diketahui dalam versi ini.
APP Konversi dicatat di aplikasi.
WEB Konversi dicatat di situs.

ClickConversionResult

Informasi pengidentifikasi untuk ClickConversion yang berhasil diproses.

Representasi JSON 
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
Kolom
gbraid

string

ID klik untuk klik yang dikaitkan dengan konversi aplikasi dan berasal dari perangkat iOS mulai iOS 14.
wbraid

string

ID klik untuk klik yang terkait dengan konversi web dan berasal dari perangkat iOS mulai iOS 14.
userIdentifiers[]

object (UserIdentifier)

ID pengguna yang terkait dengan konversi ini. Hanya hashedEmail dan hashedPhoneNumber yang didukung untuk upload konversi. Jumlah maksimum ID pengguna untuk setiap konversi adalah 5.
gclid

string

ID Klik Google (gclid) yang terkait dengan konversi ini.
conversionAction

string

Nama resource tindakan konversi yang terkait dengan konversi ini.
conversionDateTime

string

Tanggal waktu saat konversi terjadi. Formatnya adalah "yyyy-mm-dd hh:mm:ss+|-hh:mm", misalnya, "2019-01-01 12:32:45-08:00".