Method: events.ingest

อัปโหลดรายการEventจากDestinationที่ระบุ

คำขอ HTTP

POST https://datamanager.googleapis.com/v1/events:ingest

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

เนื้อความของคำขอ

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

การแสดง JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
ช่อง
destinations[]

object (Destination)

ต้องระบุ รายการปลายทางที่จะส่งเหตุการณ์ไป
events[]

object (Event)

ต้องระบุ รายการเหตุการณ์ที่จะส่งไปยังปลายทางที่ระบุ ส่งทรัพยากร Event ได้สูงสุด 2,000 รายการในคำขอเดียว
consent

object (Consent)

ไม่บังคับ ความยินยอมระดับคำขอที่จะใช้กับผู้ใช้ทั้งหมดในคำขอ ความยินยอมระดับผู้ใช้จะลบล้างความยินยอมระดับคำขอ และระบุได้ในแต่ละ Event
validateOnly

boolean

ไม่บังคับ เพื่อวัตถุประสงค์ในการทดสอบ หากเป็น true ระบบจะตรวจสอบคำขอแต่จะไม่ดำเนินการ ระบบจะแสดงเฉพาะข้อผิดพลาด ไม่ใช่ผลลัพธ์
encoding

enum (Encoding)

ไม่บังคับ ต้องระบุสำหรับการอัปโหลด UserData ประเภทการเข้ารหัสของตัวระบุผู้ใช้ สําหรับตัวระบุผู้ใช้ที่แฮช นี่คือประเภทการเข้ารหัสของสตริงที่แฮช สำหรับตัวระบุผู้ใช้ที่แฮชและเข้ารหัส นี่คือประเภทการเข้ารหัสของสตริงที่เข้ารหัสภายนอก แต่ไม่จำเป็นต้องเป็นสตริงที่แฮชภายใน ซึ่งหมายความว่าสตริงที่แฮชภายในอาจเข้ารหัสในลักษณะที่แตกต่างจากสตริงที่เข้ารหัสภายนอก สำหรับUserDataที่ไม่ใช่การอัปโหลด ระบบจะไม่สนใจฟิลด์นี้
encryptionInfo

object (EncryptionInfo)

ไม่บังคับ ข้อมูลการเข้ารหัสสำหรับการอัปโหลดของ UserData หากไม่ได้ตั้งค่าไว้ ระบบจะถือว่าข้อมูลระบุตัวตนที่อัปโหลดได้รับการแฮชแต่ไม่ได้เข้ารหัส สำหรับUserDataที่ไม่ใช่การอัปโหลด ระบบจะไม่สนใจฟิลด์นี้

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

คำตอบจาก IngestEventsRequest

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

การแสดง JSON 
{
  "requestId": string
}
ช่อง
requestId

string

รหัสที่สร้างขึ้นโดยอัตโนมัติของคำขอ

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

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

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

กิจกรรม

เหตุการณ์ที่แสดงการโต้ตอบของผู้ใช้กับเว็บไซต์หรือแอปของผู้ลงโฆษณา

การแสดง JSON 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
ช่อง
destinationReferences[]

string

ไม่บังคับ สตริงอ้างอิงที่ใช้ในการกำหนดปลายทาง หากเว้นว่างไว้ ระบบจะส่งเหตุการณ์ไปยัง destinations ทั้งหมดในคำขอ
transactionId

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับเหตุการณ์นี้
eventTimestamp

string (Timestamp format)

ต้องระบุ เวลาที่เกิดเหตุการณ์

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่าง: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
lastUpdatedTimestamp

string (Timestamp format)

ไม่บังคับ ครั้งล่าสุดที่มีการอัปเดตกิจกรรม

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่าง: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
userData

object (UserData)

ไม่บังคับ ชิ้นส่วนของข้อมูลที่ได้จากผู้ใช้ ซึ่งแสดงถึงผู้ใช้ที่เชื่อมโยงกับเหตุการณ์
consent

object (Consent)

ไม่บังคับ ข้อมูลเกี่ยวกับว่าผู้ใช้ที่เชื่อมโยงได้ให้ความยินยอมประเภทต่างๆ หรือไม่
adIdentifiers

object (AdIdentifiers)

ไม่บังคับ ตัวระบุและข้อมูลอื่นๆ ที่ใช้เพื่อจับคู่เหตุการณ์ Conversion กับกิจกรรมออนไลน์อื่นๆ (เช่น การคลิกโฆษณา)
currency

string

ไม่บังคับ รหัสสกุลเงินที่เชื่อมโยงกับมูลค่าทางการเงินทั้งหมดภายในเหตุการณ์นี้
conversionValue

number

ไม่บังคับ มูลค่า Conversion ที่เชื่อมโยงกับเหตุการณ์สําหรับ Conversion ตามมูลค่า
eventSource

enum (EventSource)

ไม่บังคับ สัญญาณที่ระบุตำแหน่งที่เกิดเหตุการณ์ (เว็บ แอป ในร้านค้า ฯลฯ)
eventDeviceInfo

object (DeviceInfo)

ไม่บังคับ ข้อมูลที่รวบรวมเกี่ยวกับอุปกรณ์ที่ใช้ (หากมี) เมื่อเกิดเหตุการณ์
cartData

object (CartData)

ไม่บังคับ ข้อมูลเกี่ยวกับธุรกรรมและรายการที่เชื่อมโยงกับกิจกรรม
customVariables[]

object (CustomVariable)

ไม่บังคับ ข้อมูลคู่คีย์/ค่าเพิ่มเติมที่จะส่งไปยังคอนเทนเนอร์ Conversion (การกระทําที่ถือเป็น Conversion หรือกิจกรรม FL)
experimentalFields[]

object (ExperimentalField)

ไม่บังคับ รายการคู่คีย์/ค่าสำหรับฟิลด์ทดลองที่อาจได้รับการเลื่อนขั้นให้เป็นส่วนหนึ่งของ API ในอนาคต
userProperties

object (UserProperties)

ไม่บังคับ ข้อมูลที่ผู้ลงโฆษณาประเมินเกี่ยวกับผู้ใช้ ณ เวลาที่เกิดเหตุการณ์

AdIdentifiers

ตัวระบุและข้อมูลอื่นๆ ที่ใช้เพื่อจับคู่เหตุการณ์ Conversion กับกิจกรรมออนไลน์อื่นๆ (เช่น การคลิกโฆษณา)

การแสดง JSON 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  }
}
ช่อง
sessionAttributes

string

ไม่บังคับ แอตทริบิวต์เซสชันสําหรับการระบุแหล่งที่มาและการประมาณเหตุการณ์
gclid

string

ไม่บังคับ Google Click ID (gclid) ที่เชื่อมโยงกับเหตุการณ์นี้
gbraid

string

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

string

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

object (DeviceInfo)

ไม่บังคับ ข้อมูลที่รวบรวมเกี่ยวกับอุปกรณ์ที่ใช้ (หากมี) ในขณะที่เข้าสู่เว็บไซต์ของผู้ลงโฆษณาหลังจากโต้ตอบกับโฆษณา

DeviceInfo

ข้อมูลเกี่ยวกับอุปกรณ์ที่ใช้ (หากมี) เมื่อเกิดเหตุการณ์

การแสดง JSON 
{
  "userAgent": string,
  "ipAddress": string
}
ช่อง
userAgent

string

ไม่บังคับ สตริง User Agent ของอุปกรณ์สำหรับบริบทที่ระบุ
ipAddress

string

ไม่บังคับ ที่อยู่ IP ของอุปกรณ์สำหรับบริบทที่ระบุ

หมายเหตุ: Google Ads ไม่รองรับการจับคู่ที่อยู่ IP สำหรับผู้ใช้ปลายทางในเขตเศรษฐกิจยุโรป (EEA), สหราชอาณาจักร (UK) หรือสวิตเซอร์แลนด์ (CH) เพิ่มตรรกะเพื่อยกเว้นการแชร์ที่อยู่ IP จากผู้ใช้ในภูมิภาคเหล่านี้แบบมีเงื่อนไข และตรวจสอบว่าคุณได้ให้ข้อมูลที่ชัดเจนและครบถ้วนแก่ผู้ใช้เกี่ยวกับข้อมูลที่คุณรวบรวมในเว็บไซต์ แอป และพร็อพเพอร์ตี้อื่นๆ พร้อมทั้งได้รับความยินยอมในกรณีที่กฎหมายหรือนโยบายที่เกี่ยวข้องของ Google กำหนด ดูรายละเอียดเพิ่มเติมได้ที่หน้าเกี่ยวกับการนำเข้า Conversion ออฟไลน์

EventSource

แหล่งที่มาของเหตุการณ์

Enum
EVENT_SOURCE_UNSPECIFIED EventSource ที่ไม่ได้ระบุ ไม่ควรใช้
WEB กิจกรรมสร้างขึ้นจากเว็บเบราว์เซอร์
APP กิจกรรมสร้างขึ้นจากแอป
IN_STORE ระบบสร้างเหตุการณ์จากธุรกรรมในร้านค้า
PHONE ระบบสร้างกิจกรรมจากการโทร
OTHER ระบบสร้างกิจกรรมจากแหล่งที่มาอื่นๆ

CartData

ข้อมูลรถเข็นช็อปปิ้งที่เชื่อมโยงกับเหตุการณ์

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

string

ไม่บังคับ รหัส Merchant Center ที่เชื่อมโยงกับสินค้า
merchantFeedLabel

string

ไม่บังคับ ป้ายกำกับฟีด Merchant Center ที่เชื่อมโยงกับฟีดของสินค้า
merchantFeedLanguageCode

string

ไม่บังคับ รหัสภาษาใน ISO 639-1 ที่เชื่อมโยงกับฟีด Merchant Center ของสินค้าที่มีการอัปโหลดสินค้า
transactionDiscount

number

ไม่บังคับ ยอดรวมของส่วนลดทั้งหมดที่เชื่อมโยงกับธุรกรรม
items[]

object (Item)

ไม่บังคับ รายการสินค้าที่เชื่อมโยงกับกิจกรรม

รายการ

แสดงสินค้าในรถเข็นที่เชื่อมโยงกับเหตุการณ์

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

string

ไม่บังคับ รหัสผลิตภัณฑ์ภายในบัญชี Merchant Center
quantity

string (int64 format)

ไม่บังคับ หมายเลขของสินค้าที่เชื่อมโยงกับเหตุการณ์
unitPrice

number

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

ตัวแปรที่กำหนดเอง

ตัวแปรที่กำหนดเองสําหรับ Conversion ของโฆษณา

การแสดง JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
ช่อง
variable

string

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

string

ไม่บังคับ ค่าที่จะจัดเก็บสำหรับตัวแปรที่กำหนดเอง
destinationReferences[]

string

ไม่บังคับ สตริงอ้างอิงที่ใช้เพื่อกำหนดว่าควรส่งตัวแปรที่กำหนดเองไปยัง Event.destination_references ใด หากเว้นว่างไว้ ระบบจะใช้ Event.destination_references

ExperimentalField

ฟิลด์ทดลองที่แสดงฟิลด์ที่ไม่เป็นทางการ

การแสดง JSON 
{
  "field": string,
  "value": string
}
ช่อง
field

string

ไม่บังคับ ชื่อของช่องที่จะใช้
value

string

ไม่บังคับ ค่าของช่องที่จะตั้งค่า

UserProperties

ข้อมูลที่ผู้ลงโฆษณาประเมินเกี่ยวกับผู้ใช้ ณ เวลาที่เกิดเหตุการณ์ ดูรายละเอียดเพิ่มเติมได้ที่ https://support.google.com/google-ads/answer/14007601

การแสดง JSON 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket)
}
ช่อง
customerType

enum (CustomerType)

ไม่บังคับ ประเภทลูกค้าที่เชื่อมโยงกับเหตุการณ์
customerValueBucket

enum (CustomerValueBucket)

ไม่บังคับ มูลค่าของลูกค้าที่ผู้ลงโฆษณาประเมิน

CustomerType

ประเภทลูกค้าที่เชื่อมโยงกับเหตุการณ์

Enum
CUSTOMER_TYPE_UNSPECIFIED ไม่ได้ระบุ CustomerType ไม่ควรใช้
NEW ลูกค้าเป็นลูกค้าใหม่ของผู้ลงโฆษณา
RETURNING ลูกค้ากลับมาหาผู้ลงโฆษณา
REENGAGED ลูกค้ากลับมามีส่วนร่วมกับผู้ลงโฆษณาอีกครั้ง

CustomerValueBucket

มูลค่าของลูกค้าที่ผู้ลงโฆษณาประเมิน

Enum
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Unspecified CustomerValueBucket ไม่ควรใช้
LOW ลูกค้ามีคุณค่าต่ำ
MEDIUM ลูกค้ามีคุณค่าปานกลาง
HIGH ลูกค้ามีคุณค่าสูง