ข้อความ Push

พร็อพเพอร์ตี้ที่จำเป็น

ในคำขอ watch แต่ละรายการ คุณจะต้องกรอกข้อมูลในช่องต่อไปนี้

• สตริงพร็อพเพอร์ตี้ id ที่ระบุค่านี้โดยไม่ซ้ำกัน ช่องทางการแจ้งเตือนใหม่ภายในโปรเจ็กต์ของคุณ เราขอแนะนำให้ใช้ ตัวระบุที่ไม่ซ้ำกันทั่วโลก (UUID) หรือรายการอื่นๆ ที่คล้ายกัน สตริงที่ไม่ซ้ำกัน ความยาวสูงสุด: 64 อักขระ

  ค่ารหัสที่คุณตั้งค่าไว้จะถูกสะท้อนกลับใน ส่วนหัว HTTP X-Goog-Channel-Id ของการแจ้งเตือนทั้งหมด ข้อความที่คุณได้รับจากช่องนี้

• ตั้งค่าสตริงพร็อพเพอร์ตี้ type เป็นค่าแล้ว web_hook

• ตั้งค่าสตริงพร็อพเพอร์ตี้ address เป็น URL ที่ฟังอยู่ และตอบกลับการแจ้งเตือนสำหรับช่องทางการแจ้งเตือนนี้ นี่คือ URL เรียกกลับของเว็บฮุคและต้องใช้ HTTPS

  โปรดทราบว่า Admin SDK API ส่งการแจ้งเตือนถึง ที่อยู่ HTTPS นี้ต่อเมื่อมีการติดตั้งใบรับรอง SSL ที่ถูกต้องไว้เท่านั้น ในเว็บเซิร์ฟเวอร์ของคุณ ใบรับรองที่ไม่ถูกต้อง ได้แก่

  • ใบรับรองแบบ Self-signed
  • ใบรับรองที่ลงนามโดยแหล่งที่มาที่ไม่น่าเชื่อถือ
  • ใบรับรองที่เพิกถอนไปแล้ว
  • ใบรับรองที่มีเรื่องที่ไม่ตรงกับเป้าหมาย ชื่อโฮสต์

พร็อพเพอร์ตี้ที่ไม่บังคับ

นอกจากนี้ คุณยังระบุช่องที่ไม่บังคับเหล่านี้ได้โดยใช้ คำขอwatch:

• พร็อพเพอร์ตี้ token ที่ระบุสตริงที่กําหนดเอง ค่าเพื่อใช้เป็นโทเค็นของแชแนล คุณสามารถใช้ช่องทางการแจ้งเตือน โทเค็นเพื่อวัตถุประสงค์ต่างๆ ตัวอย่างเช่น คุณสามารถใช้ เพื่อยืนยันว่าข้อความขาเข้าทั้งหมดมาจากช่องทางที่ สร้างแอปพลิเคชันแล้ว เพื่อให้มั่นใจว่า ปลอมแปลง หรือเพื่อกำหนดเส้นทางข้อความไปยังปลายทางที่ถูกต้องภายใน ใบสมัครของคุณตามวัตถุประสงค์ของช่องทางนี้ ความยาวสูงสุด: 256 อักขระ

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

  หากใช้โทเค็นช่องทางการแจ้งเตือน เราขอแนะนำให้ทำดังนี้

  • ใช้รูปแบบการเข้ารหัสที่ขยายได้ เช่น การค้นหา URL พารามิเตอร์ เช่น forwardTo=hr&createdBy=mobile

  • อย่าใส่ข้อมูลที่ละเอียดอ่อน เช่น โทเค็น OAuth

• ตั้งค่าสตริงพร็อพเพอร์ตี้ expiration เป็น การประทับเวลา Unix (เป็นมิลลิวินาที) ของวันที่และเวลาที่คุณต้องการให้ Admin SDK API ดำเนินการ หยุดส่งข้อความสำหรับช่องทางการแจ้งเตือนนี้

  หากแชแนลมีเวลาหมดอายุ ระบบจะนับเป็นค่า ของส่วนหัว HTTP X-Goog-Channel-Expiration (ในเวอร์ชันที่มนุษย์อ่านได้) ) ในข้อความแจ้งเตือนทุกรายการ ที่แอปพลิเคชันได้รับสำหรับช่องนี้

ดูการตอบกลับ

หากคำขอ watch สร้างการแจ้งเตือนสำเร็จ แชแนลจะแสดงรหัสสถานะ HTTP 200 OK

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

{
  "kind": "api#channel",
  "id": "reportsApiId", // ID you specified for this channel.
  "resourceId": "o3hgv1538sdjfh", // ID of the watched resource.
  "resourceUri": "https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 3600, // Actual expiration time as Unix timestamp (in ms), if applicable.
}

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

คุณสามารถส่งต่อข้อมูลที่ส่งคืนไปยังช่องทางการแจ้งเตือนอื่นๆ ได้ เช่น เมื่อคุณต้องการหยุดรับ การแจ้งเตือน

ดูรายละเอียดเพิ่มเติมเกี่ยวกับการตอบกลับได้ที่watch สำหรับทรัพยากร Activity ในการอ้างอิง API

ซิงค์ข้อความ

หลังจากสร้างช่องทางการแจ้งเตือนเพื่อดูแหล่งข้อมูลแล้ว Admin SDK API จะส่งข้อความ sync เพื่อระบุว่า การแจ้งเตือนต่างๆ เริ่มขึ้น HTTP ของ X-Goog-Resource-State ค่าส่วนหัวสำหรับข้อความเหล่านี้คือ sync เนื่องจากเครือข่าย เกิดปัญหาเกี่ยวกับเวลา คุณอาจได้รับข้อความ sync ก่อนที่คุณจะได้รับการตอบกลับเมธอด watch

คุณจึงไม่ต้องสนใจการแจ้งเตือนของ sync แต่ ก็ใช้ได้ด้วย เช่น หากคุณตัดสินใจว่าไม่ต้องการเก็บ ช่องนั้น คุณจะสามารถใช้ X-Goog-Channel-ID และ X-Goog-Resource-ID ค่าในการเรียกไปยัง หยุดรับการแจ้งเตือน คุณยังสามารถใช้ การแจ้งเตือน sync ให้เริ่มดำเนินการเพื่อเตรียมพร้อม กิจกรรมหลังจากนี้

รูปแบบของข้อความ sync ที่ Admin SDK API ส่งไปถึง URL ผู้รับของคุณแสดงไว้ด้านล่างนี้

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

ข้อความที่ซิงค์จะมี X-Goog-Message-Number HTTP เสมอ ค่าส่วนหัว 1 การแจ้งเตือนที่ตามมาแต่ละรายการสำหรับช่องนี้ หมายเลขข้อความที่มากกว่าหมายเลขก่อนหน้านี้ แม้ว่าข้อความ จะไม่เรียงตามลำดับ

ต่ออายุช่องทางการแจ้งเตือน

ช่องทางการแจ้งเตือนอาจมีเวลาหมดอายุโดยมีค่า ซึ่งกำหนดโดยคำขอของคุณหรือจากขีดจำกัดภายในของ Admin SDK API หรือค่าเริ่มต้น (จะใช้ค่าที่มีการจำกัดมากกว่า) วันหมดอายุของช่อง เวลา หากมี จะรวมเป็นการประทับเวลา Unix (หน่วยเป็นมิลลิวินาที) ในข้อมูลที่แสดงผลโดยเมธอด watch นอกจากนี้ มีการระบุวันที่และเวลาหมดอายุ (ในรูปแบบที่มนุษย์อ่านได้) ในทุก ข้อความแจ้งเตือนที่แอปพลิเคชันได้รับสำหรับช่องนี้ใน ส่วนหัว HTTP ของ X-Goog-Channel-Expiration

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

ตีความรูปแบบข้อความแจ้งเตือน

ข้อความแจ้งเตือนทั้งหมดจะรวมชุดส่วนหัว HTTP ที่มี คำนำหน้า X-Goog- การแจ้งเตือนบางประเภทอาจมี เนื้อความ

ข้อความแจ้งเตือนสำหรับกิจกรรมมีข้อมูลต่อไปนี้ในเนื้อหาคำขอ

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName
X-Goog-Resource-State:  eventName
X-Goog-Message-Number: 10

{
  "kind": "admin#reports#activity",
  "id": {
    "time": datetime,
    "uniqueQualifier": long,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "callerType": string,
    "email": string,
    "profileId": long
  },
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "name": string,
          "value": string,
          "intValue": long,
          "boolValue": boolean
        }
      ]
    }
  ]
}

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 596
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret987df98743md8g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin?alt=json
X-Goog-Resource-State:  CREATE_USER
X-Goog-Message-Number: 23

{
  "kind": "admin#reports#activity",
  "id": {
    "time": "2013-09-10T18:23:35.808Z",
    "uniqueQualifier": "-0987654321",
    "applicationName": "admin",
    "customerId": "ABCD012345"
  },
  "actor": {
    "callerType": "USER",
    "email": "admin@example.com",
    "profileId": "0123456789987654321"
  },
  "ownerDomain": "apps-reporting.example.com",
  "ipAddress": "192.0.2.0",
  "events": [
    {
      "type": "USER_SETTINGS",
      "name": "CREATE_USER",
      "parameters": [
        {
          "name": "USER_EMAIL",
          "value": "liz@example.com"
        }
      ]
    }
  ]
}

ตอบสนองต่อการแจ้งเตือนต่างๆ

เพื่อแสดงถึงความสำเร็จ คุณสามารถส่งรหัสสถานะต่อไปนี้ 200, 201, 202, 204 หรือ 102

หากบริการของคุณใช้ไลบรารีไคลเอ็นต์ API ของ Google และแสดงผล 500,502, 503 หรือ 504 ซึ่งเป็น Admin SDK API ลองอีกครั้งโดยใช้ Exponential Backoff รหัสสถานะการคืนสินค้าอื่นๆ ทั้งหมดจะถือว่าเป็นข้อความล้มเหลว

ทำความเข้าใจเหตุการณ์การแจ้งเตือน Admin SDK API

ส่วนนี้จะให้รายละเอียดเกี่ยวกับข้อความการแจ้งเตือนที่คุณสามารถ ได้รับเมื่อใช้ข้อความ Push กับ Admin SDK API

ข้อความ Push API ของรายงานมีข้อความ 2 ประเภท ได้แก่ ข้อความซิงค์และการแจ้งเตือนกิจกรรม ประเภทข้อความจะระบุอยู่ในส่วนหัว HTTP X-Goog-Resource-State ค่าที่เป็นไปได้สำหรับการแจ้งเตือนกิจกรรมจะเหมือนกับเมธอด activities.list แต่ละแอปพลิเคชันมีเหตุการณ์ที่ไม่ซ้ำ:

• ผู้ดูแลระบบ
• ปฏิทิน
• ไดรฟ์
• กลุ่ม
• login
• อุปกรณ์เคลื่อนที่
• saml
• โทเค็น
• user_accounts