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,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
ช่อง
requestId

string

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

fieldWarnings[]

object (FieldWarning)

คำเตือนระดับแถวโดยละเอียดพร้อมเส้นทางฟิลด์

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

ต้องใช้ขอบเขต 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,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "callInfo": {
    object (CallInfo)
  },
  "conversionValue": number,
  "conversionCount": number
}
ฟิลด์
destinationReferences[]

string

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

transactionId

string

ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับกิจกรรมนี้ จําเป็นสําหรับเหตุการณ์ที่ส่งเป็นแหล่งข้อมูลเพิ่มเติมสําหรับ Conversion ของแท็ก

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

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

eventSource

enum (EventSource)

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

eventDeviceInfo

object (DeviceInfo)

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

cartData

object (CartData)

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

customVariables[]

object (CustomVariable)

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

experimentalFields[]

object (ExperimentalField)

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

userProperties

object (UserProperties)

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

eventName

string

ไม่บังคับ ชื่อเหตุการณ์ ต้องระบุสำหรับเหตุการณ์ GA4

clientId

string

ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับอินสแตนซ์ผู้ใช้ของไคลเอ็นต์เว็บสำหรับสตรีมเว็บ GA4 นี้

userId

string

ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับผู้ใช้ตามที่ผู้ลงโฆษณากำหนด

additionalEventParameters[]

object (EventParameter)

ไม่บังคับ ที่เก็บพารามิเตอร์เหตุการณ์ที่จะรวมไว้ในเหตุการณ์ซึ่งยังไม่ได้ระบุโดยใช้ช่องที่มีโครงสร้างอื่นๆ

thirdPartyUserData

object (UserData)

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

eventLocation

object (EventLocation)

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

appInstanceId

string

ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับอินสแตนซ์ผู้ใช้ของไคลเอ็นต์แอปสำหรับสตรีมแอป GA4 นี้

callInfo

object (CallInfo)

ไม่บังคับ ข้อมูลที่รวบรวมเกี่ยวกับการโทร (หากมี) ซึ่งนำไปสู่เหตุการณ์นี้

conversionValue

number

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

conversionCount

number

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

AdIdentifiers

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

การแสดง JSON
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ],
  "ppid": string,
  "visitorPpid": string,
  "leadId": string
}
ฟิลด์
sessionAttributes

string

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

gclid

string

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

gbraid

string

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

wbraid

string

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

landingPageDeviceInfo

object (DeviceInfo)

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

mobileDeviceId

string

ไม่บังคับ ตัวระบุอุปกรณ์เคลื่อนที่สำหรับผู้ลงโฆษณา ซึ่งอาจเป็น IDFA ใน iOS, AdID ใน Android หรือตัวระบุอื่นๆ ของแพลตฟอร์มสำหรับผู้ลงโฆษณา

dclid

string

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

impressionId

string

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

matchId

string

ไม่บังคับ ฟิลด์รหัสที่ตรงกันที่ใช้เพื่อรวมเหตุการณ์นี้กับเหตุการณ์ก่อนหน้า

encryptedUserIds[]

object (EncryptedUserId)

ไม่บังคับ รหัสผู้ใช้ที่เข้ารหัสจำนวนเท่าใดก็ได้

ppid

string

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

visitorPpid

string

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

leadId

string

ไม่บังคับ รหัสที่ Google สร้างขึ้นซึ่งจะออกเมื่อผู้ใช้ส่งโฆษณาแบบกรอกฟอร์ม

EncryptedUserId

ตัวระบุผู้ใช้ที่ออกให้เพื่อใช้สำหรับการระบุแหล่งที่มา ต้องกรอกข้อมูลทุกช่องหากใช้ฟิลด์นี้

การแสดง JSON
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
ช่อง
encryptedId

string

ต้องระบุ รหัสที่เข้ารหัสซึ่งเป็นตัวอักษรและตัวเลขคละกัน

entityType

enum (EncryptionEntityType)

ต้องระบุ ประเภทเอนทิตีการเข้ารหัส ซึ่งควรตรงกับการกำหนดค่าการเข้ารหัสสำหรับการแสดงโฆษณาหรือการโอนข้อมูล

entityId

string (int64 format)

ต้องระบุ รหัสเอนทิตีการเข้ารหัส ซึ่งควรตรงกับการกำหนดค่าการเข้ารหัสสำหรับการแสดงโฆษณาหรือการโอนข้อมูล

source

enum (EncryptionSource)

ต้องระบุ อธิบายว่าได้รับคุกกี้ที่เข้ารหัสจากการแสดงโฆษณา (มาโคร %m) หรือจากการโอนข้อมูล

EncryptionEntityType

ประเภทเอนทิตีการเข้ารหัส

Enum
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED ประเภทเอนทิตีการเข้ารหัสที่ไม่ได้ระบุ
CAMPAIGN_MANAGER_ACCOUNT บัญชี Campaign Manager 360
CAMPAIGN_MANAGER_ADVERTISER ผู้ลงโฆษณา Campaign Manager 360
DISPLAY_VIDEO_PARTNER พาร์ทเนอร์ Display & Video 360
DISPLAY_VIDEO_ADVERTISER ผู้ลงโฆษณา Display & Video 360
GOOGLE_ADS_CUSTOMER ลูกค้า Google Ads
GOOGLE_AD_MANAGER_NETWORK_CODE รหัสเครือข่าย Ad Manager ของ Google

EncryptionSource

แหล่งที่มาของการเข้ารหัส

Enum
ENCRYPTION_SOURCE_UNSPECIFIED แหล่งที่มาของการเข้ารหัสที่ไม่ระบุ
AD_SERVING แหล่งที่มาของการเข้ารหัสการแสดงโฆษณา
DATA_TRANSFER แหล่งที่มาของการเข้ารหัสการโอนข้อมูล

EventSource

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

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

CartData

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

การแสดง JSON
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ],
  "couponCodes": [
    string
  ]
}
ฟิลด์
merchantId

string

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

merchantFeedLabel

string

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

merchantFeedLanguageCode

string

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

transactionDiscount

number

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

items[]

object (Item)

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

couponCodes[]

string

ไม่บังคับ รายการรหัสคูปองที่ใช้กับรถเข็น รหัสคูปองระดับรถเข็นและระดับสินค้าไม่ได้เชื่อมโยงกัน

หากเหตุการณ์มีไว้สําหรับปลายทาง Google Analytics ให้ระบุรหัสคูปองเพียงรหัสเดียว Google Analytics จะละเว้นรหัสคูปองเพิ่มเติม

รายการ

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

การแสดง JSON
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": number
}
ฟิลด์
merchantProductId

string

ไม่บังคับ รหัสสินค้าภายในบัญชี Merchant Center

quantity

string (int64 format)

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

unitPrice

number

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

itemId

string

ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันเพื่ออ้างอิงรายการ

additionalItemParameters[]

object (ItemParameter)

ไม่บังคับ ที่เก็บพารามิเตอร์เหตุการณ์ที่เกี่ยวข้องกับรายการที่จะรวมไว้ในเหตุการณ์ซึ่งยังไม่ได้ระบุโดยใช้ช่องที่มีโครงสร้างอื่นๆ

merchantId

string

ไม่บังคับ รหัส Merchant Center ที่เชื่อมโยงกับสินค้า สำหรับกิจกรรมลดราคาในร้านค้า การดำเนินการนี้จะลบล้างมูลค่าที่ตั้งไว้ที่ระดับรถเข็น ระบบจะไม่สนใจช่องนี้สำหรับเหตุการณ์อื่นๆ

merchantFeedLabel

string

ไม่บังคับ ป้ายกำกับฟีดของฟีด Merchant Center หากยังคงใช้ประเทศอยู่ คุณสามารถใช้รหัสประเทศ 2 ตัวอักษรตามมาตรฐาน ISO-3166-1 alpha-2 แทนได้ สำหรับกิจกรรมลดราคาในร้านค้า การดำเนินการนี้จะลบล้างมูลค่าที่ตั้งไว้ที่ระดับรถเข็น ระบบจะไม่สนใจช่องนี้สำหรับเหตุการณ์อื่นๆ

merchantFeedLanguageCode

string

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

customVariables[]

object (ItemCustomVariable)

ไม่บังคับ ข้อมูลคู่คีย์-ค่าเพิ่มเติมที่จะส่งไปยังคอนเทนเนอร์ Conversion (การกระทำที่ถือเป็น Conversion หรือกิจกรรม Floodlight) เมื่อติดตาม Conversion ต่อรายการ

conversionValue

number

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

ItemParameter

ที่เก็บพารามิเตอร์เหตุการณ์ที่เกี่ยวข้องกับรายการที่จะรวมไว้ในเหตุการณ์ซึ่งยังไม่ได้ระบุโดยใช้ช่องที่มีโครงสร้างอื่นๆ

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

string

ต้องระบุ ชื่อพารามิเตอร์ที่จะใช้

value

string

ต้องระบุ การแสดงสตริงของค่าพารามิเตอร์ที่จะตั้งค่า

ItemCustomVariable

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

การแสดง JSON
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
ฟิลด์
variable

string

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

value

string

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

destinationReferences[]

string

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

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

ตัวแปรที่กำหนดเองสำหรับ 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),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
ฟิลด์
customerType

enum (CustomerType)

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

customerValueBucket

enum (CustomerValueBucket)

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

additionalUserProperties[]

object (UserProperty)

ไม่บังคับ ที่เก็บพร็อพเพอร์ตี้ผู้ใช้เพิ่มเติมสำหรับผู้ใช้ที่เชื่อมโยงกับเหตุการณ์นี้

CustomerType

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

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

CustomerValueBucket

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

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

UserProperty

ที่เก็บพร็อพเพอร์ตี้ผู้ใช้เพิ่มเติมสำหรับผู้ใช้ที่เชื่อมโยงกับเหตุการณ์นี้

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

string

ต้องระบุ ชื่อของพร็อพเพอร์ตี้ผู้ใช้ที่จะใช้

value

string

ต้องระบุ การแสดงสตริงของค่าพร็อพเพอร์ตี้ผู้ใช้ที่จะใช้

EventParameter

พารามิเตอร์เหตุการณ์สําหรับเหตุการณ์ GA4

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

string

ต้องระบุ ชื่อพารามิเตอร์ที่จะใช้

value

string

ต้องระบุ การแสดงสตริงของค่าพารามิเตอร์ที่จะตั้งค่า

EventLocation

สถานที่ที่เกิดเหตุการณ์

การแสดง JSON
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
ฟิลด์
storeId

string

ไม่บังคับ ต้องระบุสำหรับยอดขายในร้านค้า ตัวระบุที่แสดงถึงหน้าร้านจริงที่เกิดเหตุการณ์

city

string

ไม่บังคับ ชื่อเมืองที่เกิดเหตุการณ์

subdivisionCode

string

ไม่บังคับ รหัสกลุ่มย่อย ISO 3166-2 ที่เกิดเหตุการณ์

regionCode

string

ไม่บังคับ รหัสภูมิภาค CLDR แบบ 2 ตัวอักษรของที่อยู่ผู้ใช้

subcontinentCode

string

ไม่บังคับ รหัสอนุทวีปในรูปแบบ UN M49 ที่เกิดเหตุการณ์

continentCode

string

ไม่บังคับ รหัสทวีปในรูปแบบ UN M49 ที่เกิดเหตุการณ์

CallInfo

ข้อมูลที่รวบรวมเกี่ยวกับการโทร (หากมี) ซึ่งนำไปสู่เหตุการณ์นี้

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

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"