รับการแจ้งเตือนเว็บฮุคสำหรับรายการกลุ่มเป้าหมาย

คู่มือนี้อธิบายวิธีใช้เว็บฮุคเพื่อรับการแจ้งเตือนแบบอะซิงโครนัส เกี่ยวกับสถานะของคำขอส่งออกกลุ่มเป้าหมาย ฟีเจอร์นี้ใช้ได้เฉพาะ ใน Data API เวอร์ชัน v1alpha

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

หากไม่มี Webhook คุณจะต้องสำรวจ API เป็นระยะๆ เพื่อ พิจารณาว่าคำขอเสร็จสมบูรณ์เมื่อใด

สร้างแอปพลิเคชัน Webhook ตัวอย่างโดยใช้ Cloud Run

คุณสร้างแอปพลิเคชันเว็บฮุกตัวอย่างได้โดยใช้ Google Cloud โดยทำตาม บทแนะนำเริ่มต้นอย่างรวดเร็ว: ติดตั้งใช้งานบริการตัวอย่างใน Cloud Run

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

  import express from 'express';

  const app = express();
  app.use(express.json());

  app.post('/', (req, res) => {
    const channelToken = req.get('X-Goog-Channel-Token');
    const bodyJson = JSON.stringify(req.body);

    console.log(`channel token: ${channelToken}`);
    console.log(`notification body: ${bodyJson}`);

    res.sendStatus(200);
  });

  const port = parseInt(process.env.PORT) || 8080;
  app.listen(port, () => {
    console.log(`helloworld: listening on port ${port}`);
  });

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

เมื่อทำตามบทแนะนำการเริ่มต้นใช้งาน Cloud Run ฉบับย่อจนจบและติดตั้งใช้งาน แอปพลิเคชันเว็บฮุกโดยใช้คำสั่ง gcloud run deploy แล้ว ให้บันทึก URL ที่ติดตั้งใช้งานบริการ

URL ของบริการจะแสดงในคอนโซล เช่น

  Service URL: https://webhooks-test-abcdef-uc.a.run.app

นี่คือ URI การแจ้งเตือนเซิร์ฟเวอร์ ที่แอปพลิเคชันของคุณรับฟังการแจ้งเตือน Webhook จาก Google Analytics

สร้างรายการกลุ่มเป้าหมายและเปิดการแจ้งเตือน Webhook

หากต้องการขอรับการแจ้งเตือนผ่านเว็บฮุก ให้ระบุค่าต่อไปนี้ในออบเจ็กต์ webhookNotification

  • URI การแจ้งเตือนของเซิร์ฟเวอร์ ที่มีที่อยู่เว็บที่จะรับการแจ้งเตือนผ่านเว็บฮุก

  • (ไม่บังคับ) สตริงที่กำหนดเอง channelToken เพื่อป้องกันการปลอมแปลงข้อความ ระบุ channelToken ในX-Goog-Channel-Tokenส่วนหัว HTTP ของ คำขอ POST ของเว็บฮุค

ตัวอย่างคำขอที่ใช้เว็บฮุคมีดังนี้

คำขอ HTTP

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/audienceLists
{
  "webhookNotification": {
    "uri": "https://webhooks-test-abcdef-uc.a.run.app",
    "channelToken": "123456"
  },
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

การตอบกลับจากเมธอด audienceLists.create มีwebhookNotification ซึ่งยืนยันว่าเว็บฮุกที่ระบุตอบกลับสำเร็จภายใน 5 วินาที

ตัวอย่างการตอบกลับมีดังนี้

การตอบสนองของ HTTP

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceList",
    "name": "properties/1234567/audienceLists/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
    "creationQuotaTokensCharged": 51,
    "rowCount": 13956,
    "percentageCompleted": 100,
    "webhookNotification": {
      "uri": "https://webhooks-test-abcdef-uc.a.run.app",
      "channelToken": "123456"
    }
  }
}

หากเว็บฮุคตอบกลับไม่สำเร็จ หรือคุณระบุ URL ของบริการที่ไม่ถูกต้อง ระบบจะแสดงข้อความแสดงข้อผิดพลาดแทน

ตัวอย่างข้อผิดพลาดที่คุณอาจได้รับมีดังนี้

{
  "error": {
    "code": 400,
    "message": "Expected response code of 200 from webhook URI but instead
    '404' was received.",
    "status": "INVALID_ARGUMENT"
  }
}

ประมวลผลการแจ้งเตือนของเว็บฮุก

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

ระบบจะส่งคำขอ POST อย่างน้อย 1 รายการไปยังเว็บฮุคในระหว่างการสร้างรายการกลุ่มเป้าหมาย

  1. ระบบจะส่งคำขอ POST แรกทันที ซึ่งจะแสดงรายการกลุ่มเป้าหมายที่สร้างขึ้นใหม่ในสถานะ CREATING หากคำขอแรกไปยัง Webhook ไม่สำเร็จ audienceLists.create การดำเนินการจะแสดงข้อผิดพลาด และรายละเอียดความล้มเหลวของ Webhook
  2. ระบบจะส่งคำขอ POST ที่ 2 หลังจากสร้างรายการกลุ่มเป้าหมายเสร็จสมบูรณ์ การสร้างจะเสร็จสมบูรณ์เมื่อรายการกลุ่มเป้าหมายมีสถานะเป็นACTIVEหรือFAILED

ตัวอย่างการแจ้งเตือนแรกสำหรับรายการกลุ่มเป้าหมายในสถานะ CREATINGมีดังนี้

  {
    "sentTimestamp":"1718261355692983",
    "name": "properties/1234567/audienceLists/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName":"Purchasers",
    "dimensions":[{"dimensionName":"deviceId"}],
    "state":"CREATING",
    "beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
    "creationQuotaTokensCharged":0,
    "rowCount":0,
    "percentageCompleted":0,
    "webhookNotification":
      {
        "uri": "https://webhooks-test-abcdef-uc.a.run.app",
        "channelToken":"123456"
      }
  }

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

  {
    "sentTimestamp":"1718261355692983",
    "name": "properties/1234567/audienceLists/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName":"Purchasers",
    "dimensions":[{"dimensionName":"deviceId"}],
    "state":"ACTIVE",
    "beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
    "creationQuotaTokensCharged":68,
    "rowCount":13956,
    "percentageCompleted":100,
    "webhookNotification":
      {
        "uri": "https://webhooks-test-abcdef-uc.a.run.app",
        "channelToken":"123456"
      }
  }

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

หากต้องการทดสอบเว็บฮุกหลังจากเรียกใช้เมธอด audienceLists.create คุณสามารถ ตรวจสอบบันทึก ของแอปพลิเคชันเว็บฮุก Cloud Run ตัวอย่าง และดูเนื้อหา JSON ของการแจ้งเตือนทุกรายการที่ Google Analytics ส่ง