ดัชนี
IngestionService
(อินเทอร์เฟซ)AdIdentifiers
(ข้อความ)AddressInfo
(ข้อความ)AudienceMember
(ข้อความ)CartData
(ข้อความ)Consent
(ข้อความ)ConsentStatus
(enum)CustomVariable
(ข้อความ)Destination
(ข้อความ)DeviceInfo
(ข้อความ)Encoding
(enum)EncryptionInfo
(ข้อความ)Event
(ข้อความ)EventSource
(enum)ExperimentalField
(ข้อความ)GcpWrappedKeyInfo
(ข้อความ)GcpWrappedKeyInfo.KeyType
(enum)IngestAudienceMembersRequest
(ข้อความ)IngestAudienceMembersResponse
(ข้อความ)IngestEventsRequest
(ข้อความ)IngestEventsResponse
(ข้อความ)Item
(ข้อความ)MobileData
(ข้อความ)PairData
(ข้อความ)Product
(enum)ProductAccount
(ข้อความ)RemoveAudienceMembersRequest
(ข้อความ)RemoveAudienceMembersResponse
(ข้อความ)TermsOfService
(ข้อความ)TermsOfServiceStatus
(enum)UserData
(ข้อความ)UserIdentifier
(ข้อความ)
IngestionService
บริการสําหรับการส่งข้อมูลกลุ่มเป้าหมายไปยังปลายทางที่รองรับ
IngestAudienceMembers |
---|
อัปโหลดรายการ
|
IngestEvents |
---|
อัปโหลดรายการ
|
RemoveAudienceMembers |
---|
นำรายการ
|
AdIdentifiers
ตัวระบุและข้อมูลอื่นๆ ที่ใช้เพื่อจับคู่เหตุการณ์ Conversion กับกิจกรรมออนไลน์อื่นๆ (เช่น การคลิกโฆษณา)
ช่อง | |
---|---|
session_attributes |
ไม่บังคับ แอตทริบิวต์เซสชันสําหรับการระบุแหล่งที่มาและการประมาณเหตุการณ์ |
gclid |
ไม่บังคับ Google Click ID (gclid) ที่เชื่อมโยงกับเหตุการณ์นี้ |
gbraid |
ไม่บังคับ ตัวระบุคลิกสําหรับคลิกที่เชื่อมโยงกับเหตุการณ์ของแอปและมาจากอุปกรณ์ iOS ตั้งแต่ iOS14 |
wbraid |
ไม่บังคับ ตัวระบุคลิกสําหรับคลิกที่เชื่อมโยงกับเหตุการณ์บนเว็บและมาจากอุปกรณ์ iOS ตั้งแต่ iOS14 |
landing_page_device_info |
ไม่บังคับ ข้อมูลที่รวบรวมเกี่ยวกับอุปกรณ์ที่ใช้ (หากมี) ในขณะที่เข้าสู่เว็บไซต์ของผู้ลงโฆษณาหลังจากโต้ตอบกับโฆษณา |
AddressInfo
ข้อมูลที่อยู่ของผู้ใช้
ช่อง | |
---|---|
given_name |
ต้องระบุ ชื่อ (ชื่อแรก) ของผู้ใช้เป็นตัวพิมพ์เล็กทั้งหมด ไม่มีเครื่องหมายวรรคตอน ไม่มีช่องว่างนำหน้าหรือต่อท้าย และแฮชเป็น SHA-256 |
family_name |
ต้องระบุ นามสกุลของผู้ใช้เป็นตัวพิมพ์เล็กทั้งหมด ไม่มีเครื่องหมายวรรคตอน ไม่มีช่องว่างนำหน้าหรือต่อท้าย และแฮชเป็น SHA-256 |
region_code |
ต้องระบุ รหัสภูมิภาคที่เป็นอักษร 2 ตัวใน ISO-3166-1 Alpha-2 ของที่อยู่ผู้ใช้ |
postal_code |
ต้องระบุ รหัสไปรษณีย์ของที่อยู่ของผู้ใช้ |
AudienceMember
สมาชิกในกลุ่มเป้าหมายที่จะดำเนินการ
ช่อง | |
---|---|
consent |
ไม่บังคับ การตั้งค่าความยินยอมสำหรับผู้ใช้ |
ฟิลด์ Union data ประเภทของข้อมูลระบุตัวตนที่จะดำเนินการ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
user_data |
ข้อมูลที่ได้จากผู้ใช้ซึ่งระบุตัวผู้ใช้ |
pair_data |
|
mobile_data |
ข้อมูลที่ระบุอุปกรณ์เคลื่อนที่ของผู้ใช้ |
CartData
ข้อมูลรถเข็นช็อปปิ้งที่เชื่อมโยงกับเหตุการณ์
ช่อง | |
---|---|
merchant_id |
ไม่บังคับ รหัส Merchant Center ที่เชื่อมโยงกับสินค้า |
merchant_feed_label |
ไม่บังคับ ป้ายกำกับฟีด Merchant Center ที่เชื่อมโยงกับฟีดของสินค้า |
merchant_feed_language_code |
ไม่บังคับ รหัสภาษาใน ISO 639-1 ที่เชื่อมโยงกับฟีด Merchant Center ของสินค้าที่มีการอัปโหลดสินค้า |
transaction_discount |
ไม่บังคับ ยอดรวมของส่วนลดทั้งหมดที่เชื่อมโยงกับธุรกรรม |
items[] |
ไม่บังคับ รายการสินค้าที่เชื่อมโยงกับกิจกรรม |
ความยินยอม
การตั้งค่าความยินยอมตามกฎหมายตลาดดิจิทัล (DMA) สำหรับผู้ใช้
ช่อง | |
---|---|
ad_user_data |
ไม่บังคับ แสดงว่าผู้ใช้ยินยอมให้ใช้ข้อมูลผู้ใช้ของโฆษณาหรือไม่ |
ad_personalization |
ไม่บังคับ แสดงว่าผู้ใช้ยินยอมให้ปรับโฆษณาตามโปรไฟล์ของผู้ใช้หรือไม่ |
ConsentStatus
แสดงว่าผู้ใช้ให้ ปฏิเสธ หรือไม่ได้ระบุความยินยอม
Enum | |
---|---|
CONSENT_STATUS_UNSPECIFIED |
ไม่ได้ระบุ |
CONSENT_GRANTED |
ให้สิทธิ์แล้ว |
CONSENT_DENIED |
ถูกปฏิเสธ |
ตัวแปรที่กำหนดเอง
ตัวแปรที่กำหนดเองสําหรับ Conversion ของโฆษณา
ช่อง | |
---|---|
variable |
ไม่บังคับ ชื่อของตัวแปรที่กำหนดเองที่จะตั้งค่า หากไม่พบตัวแปรสำหรับปลายทางที่ระบุ ระบบจะไม่สนใจตัวแปรนั้น |
value |
ไม่บังคับ ค่าที่จะจัดเก็บสำหรับตัวแปรที่กำหนดเอง |
ปลายทาง
ผลิตภัณฑ์ Google ที่คุณส่งข้อมูลไปให้ เช่น บัญชี Google Ads
ช่อง | |
---|---|
reference |
ไม่บังคับ รหัสสำหรับทรัพยากร |
login_account |
ไม่บังคับ บัญชีที่ใช้ในการเรียก API นี้ หากต้องการเพิ่มหรือนำข้อมูลออกจาก |
linked_account |
ไม่บังคับ บัญชีที่ |
operating_account |
ต้องระบุ บัญชีที่จะส่งข้อมูลไปหรือนำข้อมูลออกจาก |
product_destination_id |
ต้องระบุ ออบเจ็กต์ภายในบัญชีผลิตภัณฑ์ที่จะนำเข้า เช่น รหัสกลุ่มเป้าหมาย Google Ads หรือรหัสกลุ่มเป้าหมาย Display & Video 360 |
DeviceInfo
ข้อมูลเกี่ยวกับอุปกรณ์ที่ใช้ (หากมี) เมื่อเกิดเหตุการณ์
ช่อง | |
---|---|
user_agent |
ไม่บังคับ สตริง User Agent ของอุปกรณ์สำหรับบริบทที่ระบุ |
ip_address |
ไม่บังคับ ที่อยู่ IP ของอุปกรณ์สำหรับบริบทที่ระบุ |
การเข้ารหัส
ประเภทการเข้ารหัสของข้อมูลระบุตัวตนที่แฮช
Enum | |
---|---|
ENCODING_UNSPECIFIED |
ประเภทการเข้ารหัสที่ไม่ได้ระบุ ไม่ควรใช้ |
HEX |
การเข้ารหัสฐาน 16 |
BASE64 |
การเข้ารหัส Base64 |
EncryptionInfo
ข้อมูลการเข้ารหัสสำหรับข้อมูลที่กำลังส่งผ่านข้อมูล
ช่อง | |
---|---|
ฟิลด์ Union wrapped_key คีย์ที่ห่อที่ใช้เข้ารหัสข้อมูล wrapped_key ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
gcp_wrapped_key_info |
ข้อมูลคีย์ที่ปกปิดของ Google Cloud Platform |
กิจกรรม
เหตุการณ์ที่แสดงการโต้ตอบของผู้ใช้กับเว็บไซต์หรือแอปของผู้ลงโฆษณา
ช่อง | |
---|---|
destination_references[] |
ไม่บังคับ สตริงอ้างอิงที่ใช้ในการกำหนดปลายทาง |
transaction_id |
ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับเหตุการณ์นี้ |
event_timestamp |
ต้องระบุ เวลาที่เกิดเหตุการณ์ |
last_updated_timestamp |
ไม่บังคับ ครั้งล่าสุดที่มีการอัปเดตกิจกรรม |
user_data |
ไม่บังคับ ชิ้นส่วนของข้อมูลที่ได้จากผู้ใช้ ซึ่งแสดงถึงผู้ใช้ที่เชื่อมโยงกับเหตุการณ์ |
consent |
ไม่บังคับ ข้อมูลเกี่ยวกับว่าผู้ใช้ที่เชื่อมโยงได้ให้ความยินยอมประเภทต่างๆ หรือไม่ |
ad_identifiers |
ไม่บังคับ ตัวระบุและข้อมูลอื่นๆ ที่ใช้เพื่อจับคู่เหตุการณ์ Conversion กับกิจกรรมออนไลน์อื่นๆ (เช่น การคลิกโฆษณา) |
currency |
ไม่บังคับ รหัสสกุลเงินที่เชื่อมโยงกับมูลค่าทางการเงินทั้งหมดภายในเหตุการณ์นี้ |
conversion_value |
ไม่บังคับ มูลค่า Conversion ที่เชื่อมโยงกับเหตุการณ์สําหรับ Conversion ตามมูลค่า |
event_source |
ไม่บังคับ สัญญาณที่ระบุตำแหน่งที่เกิดเหตุการณ์ (เว็บ แอป ในร้านค้า ฯลฯ) |
event_device_info |
ไม่บังคับ ข้อมูลที่รวบรวมเกี่ยวกับอุปกรณ์ที่ใช้ (หากมี) เมื่อเกิดเหตุการณ์ |
cart_data |
ไม่บังคับ ข้อมูลเกี่ยวกับธุรกรรมและสินค้าที่เชื่อมโยงกับกิจกรรม |
custom_variables[] |
ไม่บังคับ ข้อมูลคู่คีย์/ค่าเพิ่มเติมที่จะส่งไปยังคอนเทนเนอร์ Conversion (การกระทําที่ถือเป็น Conversion หรือกิจกรรม FL) |
experimental_fields[] |
ไม่บังคับ รายการคู่คีย์/ค่าสำหรับฟิลด์ทดลองที่อาจได้รับการเลื่อนขั้นให้เป็นส่วนหนึ่งของ API ในอนาคต |
EventSource
แหล่งที่มาของเหตุการณ์
Enum | |
---|---|
EVENT_SOURCE_UNSPECIFIED |
EventSource ที่ไม่ได้ระบุ ไม่ควรใช้ |
WEB |
กิจกรรมสร้างขึ้นจากเว็บเบราว์เซอร์ |
ExperimentalField
ฟิลด์ทดลองที่แสดงฟิลด์ที่ไม่เป็นทางการ
ช่อง | |
---|---|
field |
ไม่บังคับ ชื่อของช่องที่จะใช้ |
value |
ไม่บังคับ ค่าของช่องที่จะตั้งค่า |
GcpWrappedKeyInfo
ข้อมูลเกี่ยวกับคีย์ที่ห่อไว้ของ Google Cloud Platform
ช่อง | |
---|---|
key_type |
ต้องระบุ ประเภทของอัลกอริทึมที่ใช้ในการเข้ารหัสข้อมูล |
wip_provider |
ต้องระบุ ผู้ให้บริการพูล Workload Identity ที่จำเป็นต้องใช้ KEK |
kek_uri |
ต้องระบุ รหัสทรัพยากร Cloud Key Management Service ของ Google Cloud Platform |
encrypted_dek |
ต้องระบุ คีย์การเข้ารหัสข้อมูลที่เข้ารหัสซึ่งเข้ารหัส Base64 |
KeyType
ประเภทของอัลกอริทึมที่ใช้ในการเข้ารหัสข้อมูล
Enum | |
---|---|
KEY_TYPE_UNSPECIFIED |
ประเภทคีย์ที่ไม่ได้ระบุ ไม่ควรใช้ |
XCHACHA20_POLY1305 |
อัลกอริทึม XChaCha20-Poly1305 |
IngestAudienceMembersRequest
ขออัปโหลดสมาชิกในกลุ่มเป้าหมายไปยังปลายทางที่ระบุ แสดงผล IngestAudienceMembersResponse
ช่อง | |
---|---|
destinations[] |
ต้องระบุ รายการปลายทางที่จะส่งสมาชิกในกลุ่มเป้าหมายไป |
audience_members[] |
ต้องระบุ รายชื่อผู้ใช้ที่จะส่งไปยังปลายทางที่ระบุ ส่งทรัพยากร |
consent |
ไม่บังคับ ความยินยอมระดับคำขอที่จะใช้กับผู้ใช้ทั้งหมดในคำขอ ความยินยอมระดับผู้ใช้จะลบล้างความยินยอมระดับคำขอ และระบุได้ในแต่ละ |
validate_only |
ไม่บังคับ เพื่อการทดสอบ หากเป็น |
encoding |
ไม่บังคับ ต้องระบุสำหรับการอัปโหลด |
encryption_info |
ไม่บังคับ ข้อมูลการเข้ารหัสสำหรับการอัปโหลดของ |
terms_of_service |
ไม่บังคับ ข้อกำหนดในการให้บริการที่ผู้ใช้ยอมรับ/ปฏิเสธ |
IngestAudienceMembersResponse
คำตอบจาก IngestAudienceMembersRequest
ช่อง | |
---|---|
request_id |
รหัสที่สร้างขึ้นโดยอัตโนมัติของคำขอ |
IngestEventsRequest
ขออัปโหลดสมาชิกในกลุ่มเป้าหมายไปยังปลายทางที่ระบุ แสดงผล IngestEventsResponse
ช่อง | |
---|---|
destinations[] |
ต้องระบุ รายการปลายทางที่จะส่งเหตุการณ์ไป |
events[] |
ต้องระบุ รายการเหตุการณ์ที่จะส่งไปยังปลายทางที่ระบุ ส่งทรัพยากร |
consent |
ไม่บังคับ ความยินยอมระดับคำขอที่จะใช้กับผู้ใช้ทั้งหมดในคำขอ ความยินยอมระดับผู้ใช้จะลบล้างความยินยอมระดับคำขอ และระบุได้ในแต่ละ |
validate_only |
ไม่บังคับ เพื่อการทดสอบ หากเป็น |
encoding |
ไม่บังคับ ต้องระบุสำหรับการอัปโหลด |
encryption_info |
ไม่บังคับ ข้อมูลการเข้ารหัสสำหรับการอัปโหลดของ |
IngestEventsResponse
คำตอบจาก IngestEventsRequest
ช่อง | |
---|---|
request_id |
รหัสที่สร้างขึ้นโดยอัตโนมัติของคำขอ |
รายการ
แสดงสินค้าในรถเข็นที่เชื่อมโยงกับเหตุการณ์
ช่อง | |
---|---|
merchant_product_id |
ไม่บังคับ รหัสผลิตภัณฑ์ภายในบัญชี Merchant Center |
quantity |
ไม่บังคับ หมายเลขของสินค้าที่เชื่อมโยงกับเหตุการณ์ |
unit_price |
ไม่บังคับ ราคาต่อหน่วยไม่รวมภาษี ค่าจัดส่ง และส่วนลดธุรกรรมระดับใดๆ |
MobileData
รหัสอุปกรณ์เคลื่อนที่สําหรับกลุ่มเป้าหมาย ต้องระบุรหัสอุปกรณ์เคลื่อนที่อย่างน้อย 1 รายการ
ช่อง | |
---|---|
mobile_ids[] |
ต้องระบุ รายการรหัสอุปกรณ์เคลื่อนที่ (รหัสโฆษณา/IDFA) ระบุ |
PairData
รหัส PAIR สำหรับกลุ่มเป้าหมาย ต้องระบุรหัสคู่ (PAIR ID) อย่างน้อย 1 รายการ
ช่อง | |
---|---|
pair_ids[] |
ต้องระบุ ข้อมูล PII ที่ได้จากคลีนรูม ซึ่งแฮชด้วย SHA256 และเข้ารหัสด้วยการเข้ารหัสลับแบบสลับที่ใช้ EC โดยใช้คีย์ผู้เผยแพร่โฆษณาสำหรับรายชื่อผู้ใช้ PAIR ระบุ |
ผลิตภัณฑ์
แสดงถึงผลิตภัณฑ์ของ Google ที่เฉพาะเจาะจง ใช้เพื่อค้นหาบัญชีและปลายทาง
Enum | |
---|---|
PRODUCT_UNSPECIFIED |
ผลิตภัณฑ์ที่ไม่ได้ระบุ ไม่ควรใช้ |
GOOGLE_ADS |
Google Ads |
DISPLAY_VIDEO_PARTNER |
พาร์ทเนอร์ Display & Video 360 |
DISPLAY_VIDEO_ADVERTISER |
ผู้ลงโฆษณา Display & Video 360 |
DATA_PARTNER |
พาร์ทเนอร์ด้านข้อมูล |
ProductAccount
แสดงถึงบัญชีที่เฉพาะเจาะจง
ช่อง | |
---|---|
product |
ต้องระบุ ผลิตภัณฑ์ที่บัญชีเป็นของ เช่น |
account_id |
ต้องระบุ รหัสของบัญชี เช่น รหัสบัญชี Google Ads |
RemoveAudienceMembersRequest
คำขอให้นำผู้ใช้ออกจากกลุ่มเป้าหมายในปลายทางที่ระบุ แสดงผล RemoveAudienceMembersResponse
ช่อง | |
---|---|
destinations[] |
ต้องระบุ รายการปลายทางที่จะนำผู้ใช้ออกจาก |
audience_members[] |
ต้องระบุ รายชื่อผู้ใช้ที่จะนำออก |
validate_only |
ไม่บังคับ เพื่อการทดสอบ หากเป็น |
encoding |
ไม่บังคับ ต้องระบุสำหรับการอัปโหลด |
encryption_info |
ไม่บังคับ ข้อมูลการเข้ารหัสสำหรับการอัปโหลดของ |
RemoveAudienceMembersResponse
คำตอบจาก RemoveAudienceMembersRequest
ช่อง | |
---|---|
request_id |
รหัสที่สร้างขึ้นโดยอัตโนมัติของคำขอ |
TermsOfService
ข้อกำหนดในการให้บริการที่ผู้ใช้ยอมรับ/ปฏิเสธ
ช่อง | |
---|---|
customer_match_terms_of_service_status |
ไม่บังคับ ข้อกำหนดในการให้บริการของการจับคู่ข้อมูลลูกค้า: https://support.google.com/adspolicy/answer/6299717 คุณต้องยอมรับข้อกำหนดนี้สำหรับการอัปโหลดทั้งหมดไปยังรายชื่อผู้ใช้สำหรับการจับคู่ข้อมูลลูกค้า |
TermsOfServiceStatus
แสดงการตัดสินใจของผู้โทรว่าจะยอมรับหรือปฏิเสธข้อกำหนดในการให้บริการ
Enum | |
---|---|
TERMS_OF_SERVICE_STATUS_UNSPECIFIED |
ไม่ได้ระบุ |
ACCEPTED |
สถานะที่ระบุว่าผู้โทรเลือกที่จะยอมรับข้อกำหนดในการให้บริการ |
REJECTED |
สถานะที่บ่งบอกว่าผู้โทรเลือกที่จะปฏิเสธข้อกำหนดในการให้บริการ |
UserData
ข้อมูลที่ระบุตัวตนผู้ใช้ ต้องระบุตัวระบุอย่างน้อย 1 รายการ
ช่อง | |
---|---|
user_identifiers[] |
ต้องระบุ ตัวระบุสำหรับผู้ใช้ คุณระบุข้อมูลประเภทเดียวกันได้หลายรายการ (เช่น อีเมลหลายรายการ) ระบุตัวระบุให้มากที่สุดเท่าที่จะเป็นไปได้เพื่อเพิ่มโอกาสในการจับคู่ ระบุ |
UserIdentifier
ตัวระบุเดียวสำหรับผู้ใช้
ช่อง | |
---|---|
ฟิลด์ Union identifier ต้องระบุอย่างใดอย่างหนึ่งเท่านั้น identifier ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
email_address |
อีเมลที่แฮชโดยใช้ฟังก์ชันแฮช SHA-256 หลังจากทําการแปลงให้เป็นรูปแบบมาตรฐาน |
phone_number |
หมายเลขโทรศัพท์ที่แฮชโดยใช้ฟังก์ชันแฮช SHA-256 หลังจากทำการทำให้เป็นมาตรฐาน (มาตรฐาน E164) |
address |
องค์ประกอบที่ทราบของที่อยู่ของผู้ใช้ มีกลุ่มของตัวระบุที่ตรงกันทั้งหมดในครั้งเดียว |