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

bookmark_border จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ

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

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

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

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

คุณสามารถสร้างแอปพลิเคชัน Webhook ตัวอย่างโดยใช้ 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}`);
  });

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

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

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

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

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

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

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

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

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

ตัวอย่างคําขอที่ใช้ Webhook มีดังนี้

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 ซึ่งยืนยันว่า Webhook ที่ระบุตอบกลับภายใน 5 วินาที

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

{
  "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"
  }
}

ประมวลผลการแจ้งเตือน Webhook

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

ระบบจะส่งคําขอ POST 1 หรือ 2 รายการไปยัง Webhook ในระหว่างการสร้างรายการกลุ่มเป้าหมาย

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

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