- คำขอ HTTP
- เนื้อหาคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- AdEvent
- EventType
- EventSubtype
- AdType
- AdFormat
- AdPlacement
- TargetingType
- PlatformType
- แพลตฟอร์ม
- AttributionHint
- ViewabilityInfo
- ViewType
- MediaQuartile
- ลองใช้งาน
อัปโหลดรายการAdEventไปยัง Google Analytics
ฟีเจอร์นี้พร้อมใช้งานสำหรับบัญชีในรายการที่อนุญาตเท่านั้น
คำขอ HTTP
POST https://datamanager.googleapis.com/v1/adEvents:ingest
URL ใช้ไวยากรณ์การแปลงรหัส gRPC
เนื้อความของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
|---|
{ "adEvents": [ { object ( |
| ช่อง | |
|---|---|
adEvents[] |
ต้องระบุ ต้องระบุ (อย่างน้อย 1 รายการ) รายการเหตุการณ์โฆษณา |
encryptionInfo |
ไม่บังคับ ข้อมูลเกี่ยวกับคีย์การเข้ารหัสที่ใช้เพื่อเข้ารหัสข้อมูล |
validateOnly |
ไม่บังคับ หากเป็นจริง ระบบจะตรวจสอบคำขอ แต่จะไม่ดำเนินการ |
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะว่างเปล่า
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/datamanager
AdEvent
เหตุการณ์โฆษณา
| การแสดง JSON |
|---|
{ "advertiserId": string, "eventType": enum ( |
| ช่อง | |
|---|---|
advertiserId |
ต้องระบุ รหัสของผู้ลงโฆษณาสําหรับเหตุการณ์โฆษณา โดยต้องตรงกับรหัสที่ส่งในขั้นตอนการลิงก์ |
eventType |
ต้องระบุ ประเภทของเหตุการณ์ |
timestamp |
ต้องระบุ เวลาที่เกิดเหตุการณ์ ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น |
eventId |
ไม่บังคับ รหัสที่ผู้โทรสร้างและจัดการซึ่งระบุเหตุการณ์นี้โดยไม่ซ้ำกัน ต้องระบุหากต้องการขจัดเหตุการณ์โฆษณาที่ซ้ำกันซึ่งรวมอยู่ในคำขอหลายรายการ หรือจะเว้นช่องนี้ว่างไว้ก็ได้ |
userData |
ไม่บังคับ ข้อมูลที่ได้จากผู้ใช้หลายรายการซึ่งแสดงถึงผู้ใช้ที่เชื่อมโยงกับเหตุการณ์ คุณสามารถระบุข้อมูลประเภทเดียวกันได้หลายอินสแตนซ์ (เช่น อีเมล) ยิ่งให้ข้อมูลมากเท่าใด ก็ยิ่งมีโอกาสพบรายการที่ตรงกันมากขึ้นเท่านั้น |
deviceInfo |
ไม่บังคับ ข้อมูลที่รวบรวมเกี่ยวกับอุปกรณ์ที่ใช้เมื่อเกิดเหตุการณ์โฆษณา |
mobileDeviceId |
ไม่บังคับ รหัสอุปกรณ์ของอุปกรณ์ที่โฆษณาแสดง |
campaignId |
ต้องระบุ รหัสของแคมเปญที่เชื่อมโยง |
campaignName |
ต้องระบุ ชื่อแคมเปญที่เชื่อมโยง |
adGroupId |
ไม่บังคับ รหัสของกลุ่มโฆษณาที่เชื่อมโยง |
adId |
ไม่บังคับ รหัสของโฆษณาที่เชื่อมโยงภายในกลุ่ม |
adHeight |
ไม่บังคับ ความสูงของโฆษณาในหน่วยพิกเซล |
adWidth |
ไม่บังคับ ความกว้างของโฆษณาในหน่วยพิกเซล |
regionCode |
ต้องระบุ ประเทศและเขตย่อยตามมาตรฐาน ISO 3166-2 |
source |
ต้องระบุ แหล่งที่มาของแพลตฟอร์มของโฆษณา ซึ่งคล้ายกับแหล่งที่มาของ Google Analytics |
medium |
ต้องระบุ สื่อของโฆษณา ซึ่งคล้ายกับสื่อของ Google Analytics |
attributionHint |
ไม่บังคับ สถานะการระบุแหล่งที่มาที่พาร์ทเนอร์ถือว่ามีสำหรับเหตุการณ์โฆษณานี้ ซึ่งจะทําหน้าที่เป็นเพียงสัญญาณสําหรับวิธีที่พาร์ทเนอร์สันนิษฐานว่าการระบุแหล่งที่มาทํางาน และไม่ได้บังคับให้ผลลัพธ์สุดท้ายปรากฏในรายงานขั้นสุดท้าย |
viewabilityInfo |
ต้องระบุ รายละเอียดการมองเห็นโฆษณาที่แสดง |
ฟิลด์ Union ระบบยอมรับสตริงดิบเพื่อจัดการค่าอื่นๆ นอกเหนือจาก Enum ที่แท้จริง หากเป็นไปได้ ให้ใช้ Enum |
|
eventSubtype |
ค่า Enum สำหรับประเภทย่อยของกิจกรรม |
eventSubtypeString |
ค่าสตริงสำหรับประเภทย่อยของกิจกรรม |
ฟิลด์ Union ระบบยอมรับสตริงดิบเพื่อจัดการค่าอื่นๆ นอกเหนือจาก Enum ที่แท้จริง หากเป็นไปได้ ให้ใช้ Enum |
|
adType |
ค่า Enum สำหรับประเภทโฆษณา |
adTypeString |
ค่าสตริงสำหรับประเภทโฆษณา |
ฟิลด์ Union ระบบยอมรับสตริงดิบเพื่อจัดการค่าอื่นๆ นอกเหนือจาก Enum ที่แท้จริง หากเป็นไปได้ ให้ใช้ Enum |
|
adFormat |
ค่า Enum สำหรับรูปแบบโฆษณา |
adFormatString |
ค่าสตริงสำหรับรูปแบบโฆษณา |
ฟิลด์ Union ระบบยอมรับสตริงดิบเพื่อจัดการค่าอื่นๆ นอกเหนือจาก Enum ที่แท้จริง หากเป็นไปได้ ให้ใช้ Enum |
|
adPlacement |
ค่า Enum สำหรับตําแหน่งโฆษณา |
adPlacementString |
ค่าสตริงสำหรับตําแหน่งโฆษณา |
ฟิลด์ Union ระบบยอมรับสตริงดิบเพื่อจัดการค่าอื่นๆ นอกเหนือจาก Enum ที่แท้จริง หากเป็นไปได้ ให้ใช้ Enum |
|
targetingType |
ค่า Enum สำหรับประเภทการกำหนดเป้าหมาย |
targetingTypeString |
ค่าสตริงสำหรับประเภทการกำหนดเป้าหมาย |
ฟิลด์ Union ระบบยอมรับสตริงดิบเพื่อจัดการค่าอื่นๆ นอกเหนือจาก Enum ที่แท้จริง หากเป็นไปได้ ให้ใช้ Enum |
|
platformType |
ค่า Enum สำหรับประเภทแพลตฟอร์ม |
platformTypeString |
ค่าสตริงสำหรับประเภทแพลตฟอร์ม |
ฟิลด์ Union ระบบยอมรับสตริงดิบเพื่อจัดการค่าอื่นๆ นอกเหนือจาก Enum ที่แท้จริง หากเป็นไปได้ ให้ใช้ Enum |
|
platform |
ค่า Enum สำหรับแพลตฟอร์ม |
platformString |
ค่าสตริงสำหรับแพลตฟอร์ม |
measurementAllowed |
ไม่บังคับ แสดงว่าแถวได้รับอนุญาตให้ใช้เพื่อวัตถุประสงค์ในการวัดผลหรือไม่ ตามที่กฎหมายว่าด้วยความเป็นส่วนตัวที่เกี่ยวข้องภายในเขตอำนาจศาลระดับภูมิภาคอยู่ในบังคับ |
EventType
ประเภทของเหตุการณ์
| Enum | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
ประเภทเหตุการณ์ที่ไม่ได้ระบุ |
EVENT_TYPE_VIEW |
ดูกิจกรรม |
EVENT_TYPE_CLICK |
กิจกรรมการคลิก |
EventSubtype
การแยกประเภทเพิ่มเติมเกี่ยวกับประเภทเหตุการณ์โฆษณา
| Enum | |
|---|---|
EVENT_SUBTYPE_UNSPECIFIED |
ประเภทย่อยของเหตุการณ์ที่ไม่ได้ระบุ |
EVENT_SUBTYPE_IMPRESSION |
เหตุการณ์การแสดงผล |
EVENT_SUBTYPE_ENGAGED_VIEW |
เหตุการณ์การดูอย่างมีส่วนร่วม |
EVENT_SUBTYPE_ONSITE_CLICK |
กิจกรรมการคลิกในเว็บไซต์ |
EVENT_SUBTYPE_OUTBOUND_CLICK |
กิจกรรมการคลิกขาออก |
AdType
ประเภทโฆษณาที่แสดง
| Enum | |
|---|---|
AD_TYPE_UNSPECIFIED |
ประเภทโฆษณาที่ไม่ได้ระบุ |
AD_TYPE_DISPLAY |
โฆษณา Display |
AD_TYPE_TEXT |
โฆษณาแบบข้อความ |
AD_TYPE_IMAGE |
โฆษณาแบบรูปภาพ |
AD_TYPE_RICH_MEDIA |
โฆษณาแบบริชมีเดีย |
AD_TYPE_HTML |
โฆษณา HTML |
AD_TYPE_AUDIO |
โฆษณาเสียง |
AD_TYPE_VIDEO |
โฆษณาวิดีโอ |
AdFormat
รูปแบบของโฆษณาที่แสดง
| Enum | |
|---|---|
AD_FORMAT_UNSPECIFIED |
รูปแบบโฆษณาที่ไม่ได้ระบุ |
AD_FORMAT_AR |
โฆษณา AR |
AD_FORMAT_AUDIO |
โฆษณาเสียง |
AD_FORMAT_BANNER |
โฆษณาแบนเนอร์ |
AD_FORMAT_BUMPER |
โฆษณาบัมเปอร์ |
AD_FORMAT_CAROUSEL |
โฆษณา Carousel |
AD_FORMAT_COLLECTION |
โฆษณาคอลเล็กชัน |
AD_FORMAT_IMAGE |
โฆษณาแบบรูปภาพ |
AD_FORMAT_INTERACTIVE |
โฆษณาแบบอินเทอร์แอกทีฟ |
AD_FORMAT_INTERSTITIAL |
โฆษณาคั่นระหว่างหน้า |
AD_FORMAT_IN_FEED |
โฆษณาในฟีด |
AD_FORMAT_IN_STREAM |
โฆษณาในสตรีม |
AD_FORMAT_IN_STREAM_SKIPPABLE |
โฆษณาในสตรีมแบบข้ามได้ |
AD_FORMAT_IN_STREAM_NON_SKIPPABLE |
โฆษณาในสตรีมแบบข้ามไม่ได้ |
AD_FORMAT_NATIVE |
โฆษณาเนทีฟ |
AD_FORMAT_SHORTS |
โฆษณา Shorts |
AD_FORMAT_STORY |
โฆษณาแบบเล่าเรื่อง |
AD_FORMAT_SPONSORED |
โฆษณาที่ได้รับการสนับสนุน |
AD_FORMAT_VIDEO |
โฆษณาวิดีโอ |
AdPlacement
ตําแหน่งของโฆษณาที่แสดง
| Enum | |
|---|---|
AD_PLACEMENT_UNSPECIFIED |
ตำแหน่งโฆษณาที่ไม่ระบุ |
AD_PLACEMENT_DISCOVER |
ค้นพบตำแหน่ง |
AD_PLACEMENT_FEED |
การจัดวางฟีด |
AD_PLACEMENT_FOOTER |
ตำแหน่งของส่วนท้าย |
AD_PLACEMENT_HEADER |
ตำแหน่งส่วนหัว |
AD_PLACEMENT_HOME |
ตำแหน่งในหน้าแรก |
AD_PLACEMENT_IN_CONTENT |
ตำแหน่งในเนื้อหา |
AD_PLACEMENT_PROMOTED |
ตำแหน่งที่โปรโมต |
AD_PLACEMENT_SEARCH |
ตำแหน่งโฆษณา Search |
AD_PLACEMENT_STORY |
ตำแหน่งของเรื่องราว |
TargetingType
ประเภทของการกำหนดเป้าหมายที่ใช้ในการแสดงโฆษณา
| Enum | |
|---|---|
TARGETING_TYPE_UNSPECIFIED |
ประเภทการกำหนดเป้าหมายที่ไม่ได้ระบุ |
TARGETING_TYPE_AUDIENCE |
การกำหนดกลุ่มเป้าหมาย |
TARGETING_TYPE_CONTEXTUAL |
การกำหนดเป้าหมายตามบริบท |
TARGETING_TYPE_DEMOGRAPHIC |
การกำหนดเป้าหมายตามข้อมูลประชากร |
TARGETING_TYPE_DEVICE |
การกำหนดอุปกรณ์เป้าหมาย |
TARGETING_TYPE_GEO |
การกำหนดเป้าหมายตามภูมิศาสตร์ |
TARGETING_TYPE_INTEREST |
การกำหนดเป้าหมายตามความสนใจ |
TARGETING_TYPE_PURCHASE_INTENT |
การกำหนดเป้าหมายตามความตั้งใจในการซื้อ |
TARGETING_TYPE_REMARKETING |
การกำหนดเป้าหมายรีมาร์เก็ตติ้ง |
PlatformType
ประเภทของแพลตฟอร์มที่แสดงโฆษณา
| Enum | |
|---|---|
PLATFORM_TYPE_UNSPECIFIED |
ประเภทแพลตฟอร์มที่ไม่ได้ระบุ |
PLATFORM_TYPE_MOBILE |
แพลตฟอร์มอุปกรณ์เคลื่อนที่ |
PLATFORM_TYPE_DESKTOP |
แพลตฟอร์มเดสก์ท็อป |
PLATFORM_TYPE_CTV |
แพลตฟอร์ม CTV |
PLATFORM_TYPE_PHONE |
แพลตฟอร์มโทรศัพท์ |
PLATFORM_TYPE_TABLET |
แพลตฟอร์มแท็บเล็ต |
แพลตฟอร์ม
รายละเอียดเพิ่มเติมของแพลตฟอร์มที่แสดงโฆษณา
| Enum | |
|---|---|
PLATFORM_UNSPECIFIED |
แพลตฟอร์มที่ไม่ได้ระบุ |
PLATFORM_IOS |
แพลตฟอร์ม iOS |
PLATFORM_ANDROID |
แพลตฟอร์ม Android |
PLATFORM_WEB |
แพลตฟอร์มเว็บ |
AttributionHint
สถานะการระบุแหล่งที่มาที่พาร์ทเนอร์ถือว่ามีสำหรับเหตุการณ์โฆษณานี้
| Enum | |
|---|---|
ATTRIBUTION_HINT_UNSPECIFIED |
สถานะการระบุแหล่งที่มาที่ไม่รู้จัก |
ATTRIBUTION_HINT_CONVERTED |
สถานะที่แปลงแล้ว |
ATTRIBUTION_HINT_NOT_CONVERTED |
สถานะ "ยังไม่ได้แปลง" |
ViewabilityInfo
รายละเอียดการมองเห็นโฆษณาที่แสดง
| การแสดง JSON |
|---|
{ "viewType": enum ( |
| ช่อง | |
|---|---|
viewType |
ต้องระบุ ประเภทของเหตุการณ์ |
viewablePercent |
ไม่บังคับ เปอร์เซ็นต์ตัวเลข (0-100) ของพิกเซลที่มองเห็นได้ |
viewableDuration |
ไม่บังคับ ระยะเวลาที่โฆษณามองเห็นได้ ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย " |
mediaSkippable |
ไม่บังคับ สื่อโฆษณาข้ามได้หรือไม่ |
mediaQuartile |
ไม่บังคับ ปริมาณของสื่อที่เล่นเป็นควอไทล์แบบไม่ต่อเนื่อง |
mediaDuration |
ไม่บังคับ ระยะเวลาของสื่อโฆษณา ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย " |
mediaVolumePercent |
ไม่บังคับ เปอร์เซ็นต์ตัวเลข (0-100) ของระดับเสียงการเล่นสื่อ |
playbackDuration |
ไม่บังคับ ระยะเวลาการเล่นสื่อโฆษณา ไม่ว่าจะมองเห็นได้หรือไม่ก็ตาม ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย " |
ViewType
ประเภทของเหตุการณ์
| Enum | |
|---|---|
VIEW_TYPE_UNSPECIFIED |
ประเภทมุมมองที่ไม่ได้ระบุ |
VIEW_TYPE_MRC_VIEWED |
MRC viewed. |
VIEW_TYPE_MRC_RENDERED |
MRC แสดงผล |
MediaQuartile
ปริมาณของสื่อที่เล่นเป็นควอไทล์แบบไม่ต่อเนื่อง
| Enum | |
|---|---|
MEDIA_QUARTILE_UNSPECIFIED |
ควอไทล์สื่อที่ไม่ได้ระบุ |
MEDIA_QUARTILE_START |
เริ่ม |
MEDIA_QUARTILE_FIRST_QUARTILE |
ควอไทล์แรก |
MEDIA_QUARTILE_MIDPOINT |
จุดกึ่งกลาง |
MEDIA_QUARTILE_THIRD_QUARTILE |
ควอร์ไทล์ที่ 3 |
MEDIA_QUARTILE_COMPLETE |
เสร็จสมบูรณ์ |