Method: customers.uploadClickConversions

ประมวลผล Conversion การคลิกที่ระบุ

รายการข้อผิดพลาดโยน: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
customerId

string

ต้องระบุ รหัสลูกค้าที่ทำการอัปโหลด

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
ช่อง
conversions[]

object (ClickConversion)

ต้องระบุ Conversion ที่กําลังอัปโหลด
partialFailure

boolean

ต้องระบุ หาก "จริง" ระบบจะดำเนินการสำเร็จและการดำเนินการที่ไม่ถูกต้องจะแสดงข้อผิดพลาด หากเป็นเท็จ การดำเนินการทั้งหมดจะดำเนินการในธุรกรรมเดียวในกรณีที่ทั้งหมดถูกต้องเท่านั้น ควรตั้งค่าเป็น "จริง" เสมอ ดูข้อมูลเพิ่มเติมเกี่ยวกับความล้มเหลวบางส่วนได้ที่ https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
validateOnly

boolean

หากเป็น "จริง" ระบบจะตรวจสอบคําขอแต่ไม่ได้ดําเนินการ ระบบจะแสดงเฉพาะข้อผิดพลาดเท่านั้น ไม่ใช่ผลลัพธ์
debugEnabled

boolean

หากเป็น "จริง" API จะตรวจสอบการอัปโหลดทั้งหมดและแสดงผลข้อผิดพลาด หากตรวจพบ หากเป็น "เท็จ" ระบบจะตรวจสอบความถูกต้องของอินพุตพื้นฐานเท่านั้น ข้ามการตรวจสอบการอัปโหลดครั้งต่อๆ ไป และจะส่งคืนความสำเร็จแม้จะไม่พบการคลิกสำหรับ userIdentifiers ที่ระบุ

การตั้งค่านี้ส่งผลต่อ Conversion ที่ปรับปรุงแล้วสำหรับการอัปโหลดโอกาสในการขายที่ใช้ userIdentifiers แทน GCLID, GBRAID หรือ WBRAID เท่านั้น เมื่ออัปโหลด Conversion ที่ปรับปรุงแล้วสำหรับโอกาสในการขาย คุณควรอัปโหลดเหตุการณ์ Conversion ทั้งหมดไปยัง API รวมถึงเหตุการณ์ที่ไม่ได้มาจากแคมเปญ Google Ads ด้วย การอัปโหลดเหตุการณ์ที่ไม่ได้มาจากแคมเปญ Google Ads จะทำให้เกิดข้อผิดพลาด CLICK_NOT_FOUND หากตั้งค่าช่องนี้เป็น true เนื่องจากข้อผิดพลาดเหล่านี้จะเกิดขึ้นกับเหตุการณ์ดังกล่าวอยู่แล้ว ให้ตั้งช่องนี้เป็น false เพื่อให้ยืนยันได้ว่าการอัปโหลดมีการจัดรูปแบบอย่างถูกต้องและไม่ต้องสนใจข้อผิดพลาด CLICK_NOT_FOUND จาก Conversion ทั้งหมดที่ไม่ได้มาจากแคมเปญ Google Ads ซึ่งจะช่วยให้คุณมุ่งเน้นเฉพาะข้อผิดพลาดที่คุณแก้ไขได้

ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ false
jobId

integer

ไม่บังคับ อินพุตที่ไม่บังคับเพื่อตั้งค่ารหัสงาน ต้องเป็นตัวเลขที่ไม่ติดลบที่น้อยกว่า 2^31 หากมี หากไม่ระบุช่องนี้ API จะสร้างรหัสงานในช่วง [2^31, (2^63)-1] API จะแสดงผลค่าของคำขอนี้ในช่อง jobId ของ UploadClickConversionsResponse

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับ ConversionUploadService.UploadClickConversions

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
ช่อง
partialFailureError

object (Status)

ข้อผิดพลาดที่เกี่ยวข้องกับความล้มเหลวในการแปลงในโหมดความล้มเหลวบางส่วน แสดงผลเมื่อข้อผิดพลาดทั้งหมดเกิดขึ้นภายใน Conversion หากเกิดข้อผิดพลาดนอก Conversion (เช่น ข้อผิดพลาดในการตรวจสอบสิทธิ์) เราจะแสดงผลข้อผิดพลาดระดับ RPC ดูข้อมูลเพิ่มเติมเกี่ยวกับความล้มเหลวบางส่วนได้ที่ https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
results[]

object (ClickConversionResult)

แสดงผล Conversion ที่ประมวลผลเรียบร้อยแล้ว Proto จะว่างเปล่าสำหรับแถวที่ได้รับข้อผิดพลาด ระบบจะไม่แสดงผลลัพธ์เมื่อ checkOnly เป็น "จริง"
jobId

string (int64 format)

รหัสงานสำหรับกลุ่มการอัปโหลด

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

โปรดดูข้อมูลเพิ่มเติมที่ภาพรวมของ OAuth 2.0

ClickConversion

Conversion การคลิก

การแสดง 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
}
ช่อง
gbraid

string

หมายเลขระบุคลิกสําหรับคลิกที่เชื่อมโยงกับ Conversion ของแอปและมาจากอุปกรณ์ iOS ซึ่งเริ่มต้นด้วย iOS14
wbraid

string

ตัวระบุการคลิกสําหรับคลิกที่เชื่อมโยงกับ Conversion ที่เกิดในเว็บและมาจากอุปกรณ์ iOS ที่เริ่มต้นด้วย iOS14
externalAttributionData

object (ExternalAttributionData)

ข้อมูลเพิ่มเติมเกี่ยวกับ Conversion ที่มาจากภายนอก ต้องระบุข้อมูลในช่องนี้สำหรับ Conversion ที่มีการกระทำที่ถือเป็น Conversion ที่มาจากภายนอก แต่ไม่ควรตั้งค่าเป็นอย่างอื่น
customVariables[]

object (CustomVariable)

ตัวแปรที่กําหนดเองที่เชื่อมโยงกับ Conversion นี้
cartData

object (CartData)

ข้อมูลรถเข็นช็อปปิ้งที่เชื่อมโยงกับ Conversion นี้
userIdentifiers[]

object (UserIdentifier)

ตัวระบุผู้ใช้ที่เชื่อมโยงกับ Conversion นี้ การอัปโหลด Conversion รองรับเฉพาะ hashedEmail และ hashedPhoneNumber เท่านั้น จำนวนตัวระบุผู้ใช้สูงสุดสำหรับ Conversion แต่ละรายการคือ 5 รายการ
conversionEnvironment

enum (ConversionEnvironment)

สภาพแวดล้อมที่มีการบันทึก Conversion เช่น แอปหรือเว็บ
consent

object (Consent)

การตั้งค่าความยินยอมสําหรับเหตุการณ์
gclid

string

Google Click ID (gclid) ที่เชื่อมโยงกับ Conversion นี้
conversionAction

string

ชื่อทรัพยากรของการกระทำที่ถือเป็น Conversion ที่เชื่อมโยงกับ Conversion นี้ หมายเหตุ: แม้ว่าชื่อทรัพยากรนี้ประกอบด้วยรหัสลูกค้าและรหัสการกระทำที่ถือเป็น Conversion แต่การตรวจสอบจะไม่สนใจรหัสลูกค้าและใช้รหัสการกระทำที่ถือเป็น Conversion เป็นตัวระบุเพียงอย่างเดียวของการกระทำที่ถือเป็น Conversion
conversionDateTime

string

วันที่และเวลาที่เกิด Conversion ต้องอยู่หลังเวลาที่คลิก ต้องระบุเขตเวลา โดยอยู่ในรูปแบบ "yyyy-mm-dd hh:mm:ss+|-hh:mm" เช่น "2019-01-01 12:32:45-08:00"
conversionValue

number

มูลค่าของ Conversion สำหรับผู้ลงโฆษณา
currencyCode

string

สกุลเงินที่เชื่อมโยงกับมูลค่า Conversion นี่คือรหัสสกุลเงิน 3 อักขระตามมาตรฐาน ISO 4217 เช่น USD, EUR
orderId

string

รหัสคำสั่งซื้อที่เชื่อมโยงกับ Conversion รหัสคำสั่งซื้อใช้ได้กับ Conversion 1 รายการต่อการกระทำที่ถือเป็น Conversion เท่านั้น

ExternalAttributionData

มีข้อมูลเพิ่มเติมเกี่ยวกับ Conversion ที่มาจากภายนอก

การแสดง JSON 
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
ช่อง
externalAttributionCredit

number

แสดงเศษส่วนของ Conversion ที่เกิดจากการคลิก Google Ads
externalAttributionModel

string

ระบุชื่อรูปแบบการระบุแหล่งที่มา

CartData

มีข้อมูลเพิ่มเติมเกี่ยวกับข้อมูลรถเข็นช็อปปิ้ง

การแสดง JSON 
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
ช่อง
merchantId

string (int64 format)

รหัส Merchant Center ที่มีการอัปโหลดสินค้า
feedCountryCode

string

รหัสประเทศที่เชื่อมโยงกับฟีดที่อัปโหลดสินค้า
feedLanguageCode

string

รหัสภาษาที่เชื่อมโยงกับฟีดที่อัปโหลดสินค้า
localTransactionCost

number

ยอดรวมของส่วนลดในระดับธุรกรรมทั้งหมด เช่น จัดส่งฟรีและส่วนลดจากคูปองสำหรับทั้งรถเข็น รหัสสกุลเงินจะเหมือนกับรหัสในข้อความ ClickConversion
items[]

object (Item)

ข้อมูลของสินค้าที่ซื้อ

รายการ

มีข้อมูลของสินค้าที่ซื้อ

การแสดง JSON 
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
ช่อง
productId

string

รหัส Shopping ของสินค้า โดยต้องมีค่าเท่ากับรหัสระบุผลิตภัณฑ์ Merchant Center
quantity

integer

จำนวนสินค้าที่ขาย
unitPrice

number

ราคาต่อหน่วยไม่รวมภาษี ค่าจัดส่ง และส่วนลดธุรกรรมระดับใดๆ รหัสสกุลเงินจะเหมือนกับรหัสในข้อความ ClickConversion

ConversionEnvironment

สภาพแวดล้อม Conversion ของ Conversion ที่อัปโหลด

Enum
UNSPECIFIED ไม่ได้ระบุ
UNKNOWN ใช้สำหรับค่าที่ส่งกลับเท่านั้น แสดงค่าที่ไม่รู้จักในเวอร์ชันนี้
APP มีการบันทึก Conversion ในแอป
WEB มีการบันทึก Conversion ในเว็บไซต์

ClickConversionResult

การระบุข้อมูลสำหรับ ClickConversion ที่ประมวลผลสำเร็จ

การแสดง JSON 
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
ช่อง
gbraid

string

หมายเลขระบุคลิกสําหรับคลิกที่เชื่อมโยงกับ Conversion ของแอปและมาจากอุปกรณ์ iOS ซึ่งเริ่มต้นด้วย iOS14
wbraid

string

ตัวระบุการคลิกสําหรับคลิกที่เชื่อมโยงกับ Conversion ที่เกิดในเว็บและมาจากอุปกรณ์ iOS ที่เริ่มต้นด้วย iOS14
userIdentifiers[]

object (UserIdentifier)

ตัวระบุผู้ใช้ที่เชื่อมโยงกับ Conversion นี้ การอัปโหลด Conversion รองรับเฉพาะ hashedEmail และ hashedPhoneNumber เท่านั้น จำนวนตัวระบุผู้ใช้สูงสุดสำหรับ Conversion แต่ละรายการคือ 5 รายการ
gclid

string

Google Click ID (gclid) ที่เชื่อมโยงกับ Conversion นี้
conversionAction

string

ชื่อทรัพยากรของการกระทำที่ถือเป็น Conversion ที่เชื่อมโยงกับ Conversion นี้
conversionDateTime

string

วันที่และเวลาที่เกิด Conversion โดยอยู่ในรูปแบบ "yyyy-mm-dd hh:mm:ss+|-hh:mm" เช่น "2019-01-01 12:32:45-08:00"