WebhookNotification

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

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

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

string

ไม่บังคับ ที่อยู่เว็บที่จะได้รับการแจ้งเตือนเว็บฮุค ที่อยู่นี้จะได้รับคำขอ POST เมื่อสถานะของทรัพยากรการดำเนินการที่ใช้เวลานานมีการเปลี่ยนแปลง คำขอ POST จะมีทั้งเวอร์ชัน JSON ของทรัพยากรการดำเนินการที่ใช้เวลานานในเนื้อหาและช่อง sentTimestamp การประทับเวลาที่ส่งจะระบุยูนิกซ์ไมโครวินาทีนับตั้งแต่ 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 ของเว็บฮุค

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