WebhookNotification

กำหนดค่าทรัพยากรการดำเนินการที่ใช้เวลานานเพื่อส่งการแจ้งเตือนเว็บฮุคจาก Google Analytics Data API ไปยังเซิร์ฟเวอร์เว็บฮุคเมื่อทรัพยากรอัปเดต

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

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

string

ไม่บังคับ ที่อยู่เว็บที่จะรับการแจ้งเตือนของเว็บฮุค ที่อยู่นี้จะได้รับคำขอ POST เมื่อมีการเปลี่ยนแปลงทรัพยากรการดำเนินการที่ใช้เวลานาน คำขอ POST จะมีทั้งเวอร์ชัน JSON ของทรัพยากรการดำเนินการที่ใช้เวลานานในส่วนเนื้อหาและช่อง sentTimestamp การประทับเวลาที่ส่งจะระบุไมโครวินาทีของ Uniix ตั้งแต่ Epoch ที่มีการส่งคำขอ ซึ่งช่วยให้คุณระบุการแจ้งเตือนที่เล่นซ้ำได้

URI ตัวอย่างคือ https://us-central1-example-project-id.cloudfunctions.net/example-function-1

URI ต้องใช้ HTTPS และชี้ไปยังเว็บไซต์ที่มีใบรับรอง SSL ที่ถูกต้องในเว็บเซิร์ฟเวอร์ URI ต้องมีความยาวสตริงสูงสุด 128 อักขระและใช้เฉพาะอักขระที่อนุญาตจาก RFC 1738 เท่านั้น

เมื่อเซิร์ฟเวอร์เว็บฮุคได้รับการแจ้งเตือน เซิร์ฟเวอร์เว็บฮุคจะตอบกลับด้วยรหัสสถานะการตอบกลับ HTTP เป็น 200 ภายใน 5 วินาที

ต้องมี URI เพื่อใช้การแจ้งเตือนเว็บฮุค

คำขอไปยังเซิร์ฟเวอร์เว็บฮุคนี้จะมีโทเค็นรหัสสำหรับตรวจสอบสิทธิ์บัญชีบริการ google-analytics-audience-export@system.gserviceaccount.com ดูข้อมูลเพิ่มเติมเกี่ยวกับโทเค็นรหัสได้ที่ https://cloud.google.com/docs/authentication/token-types#id สำหรับ Google Cloud Functions คุณจะกำหนดค่าฟังก์ชันให้ต้องมีการตรวจสอบสิทธิ์ได้ ใน Cloud IAM คุณจะต้องให้สิทธิ์บัญชีบริการกับบทบาทผู้เรียกใช้ Cloud Run (roles/run.invoker) และผู้เรียกใช้ Cloud Functions (roles/cloudfunctions.invoker) สำหรับคำขอโพสต์ของเว็บฮุคเพื่อผ่านการตรวจสอบสิทธิ์ Google Cloud Functions API นี้ส่งการแจ้งเตือนของเว็บฮุคไปยัง URI ที่กำหนดเองได้ สำหรับเซิร์ฟเวอร์เว็บฮุคที่ไม่ใช่ Google Cloud Functions โปรดละเว้นโทเค็นรหัสนี้ในส่วนหัวของผู้รับการให้สิทธิ์หากไม่จำเป็น
channelToken

string

ไม่บังคับ โทเค็นแชแนลเป็นค่าสตริงที่กําหนดเองและต้องมีความยาวสตริงสูงสุด 64 อักขระ โทเค็นของช่องช่วยให้คุณยืนยันแหล่งที่มาของการแจ้งเตือนเว็บฮุคได้ ซึ่งจะช่วยป้องกันข้อความที่ปลอมแปลง โทเค็นช่องจะระบุอยู่ในส่วนหัว HTTP X-Goog-Channel-Token ของคำขอ POST ของเว็บฮุค

ไม่จำเป็นต้องมีโทเค็นช่องเพื่อใช้การแจ้งเตือนเว็บฮุค