Enterprises: pullNotificationSet

ดึงและแสดงชุดการแจ้งเตือนสําหรับองค์กรที่เชื่อมโยงกับบัญชีบริการที่ตรวจสอบสิทธิ์สําหรับคําขอ ชุดการแจ้งเตือนอาจ ว่างเปล่าหากไม่มีการแจ้งเตือนรอดำเนินการ
คุณต้องรับทราบชุดการแจ้งเตือนที่แสดงผลภายใน 20 วินาที โดยการเรียกใช้ Enterprises.AcknowledgeNotificationSet เว้นแต่ ชุดการแจ้งเตือนว่างเปล่า
การแจ้งเตือนที่ไม่มีการรับทราบภายใน 20 วินาทีจะ ในท้ายที่สุด จะรวมอีกครั้งในการตอบสนองของ PullNotificationSet อื่น และรายการที่ไม่เคยตอบรับจะถูกลบออกในท้ายที่สุด ตามนโยบายระบบ Pub/Sub ของ Google Cloud Platform
อาจมีการดำเนินการส่งคำขอหลายรายการพร้อมกันเพื่อเรียกข้อมูล การแจ้งเตือน ซึ่งในกรณีนี้ การแจ้งเตือนที่รอดำเนินการ (ถ้ามี) จะเป็น แยกตามผู้โทรแต่ละราย หากมีผู้โทรที่รอดำเนินการอยู่
หากไม่มีการแจ้งเตือน ระบบจะแสดงรายการแจ้งเตือนที่ว่างเปล่า คำขอที่ตามมาอาจส่งคืนการแจ้งเตือนมากขึ้นเมื่อคำขอนั้นกลายเป็น พร้อมใช้งาน

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/androidenterprise/v1/enterprises/pullNotificationSet

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์การค้นหาที่ไม่บังคับ
requestMode string โหมดคำขอสำหรับดึงการแจ้งเตือน
การระบุ waitForNotifications จะทำให้คำขอ บล็อกและรอจนกว่าจะมีการแจ้งเตือนอย่างน้อย 1 รายการ หรือแสดง รายการแจ้งเตือนที่ว่างเปล่า หากไม่มีการแจ้งเตือนแสดงอยู่หลังจากผ่านไประยะหนึ่ง
การระบุ returnImmediately จะทำให้คำขอ แสดงการแจ้งเตือนที่รอดำเนินการทันที หรือแสดงรายการที่ว่างเปล่าถ้าไม่มี ปรากฏขึ้น
หากไม่ระบุ ระบบจะใช้ค่าเริ่มต้นเป็น waitForNotifications

ค่าที่ยอมรับได้ มีดังนี้
  • "returnImmediately"
  • "waitForNotifications"

การให้สิทธิ์

คำขอนี้ต้องได้รับการให้สิทธิ์ตามขอบเขตต่อไปนี้

ขอบเขต
https://www.googleapis.com/auth/androidenterprise

สำหรับข้อมูลเพิ่มเติม โปรดดูที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

เนื้อหาของคำขอ

โปรดอย่าให้เนื้อหาคำขอตามวิธีนี้

คำตอบ

หากสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับซึ่งมีโครงสร้างต่อไปนี้

{
  "kind": "androidenterprise#notificationSet",
  "notificationSetId": string,
  "notification": [
    {
      "enterpriseId": string,
      "timestampMillis": long,
      "notificationType": string,
      "productApprovalEvent": {
        "productId": string,
        "approved": string
      },
      "installFailureEvent": {
        "productId": string,
        "deviceId": string,
        "userId": string,
        "failureReason": string,
        "failureDetails": string
      },
      "appUpdateEvent": {
        "productId": string
      },
      "newPermissionsEvent": {
        "productId": string,
        "requestedPermissions": [
          string
        ],
        "approvedPermissions": [
          string
        ]
      },
      "appRestrictionsSchemaChangeEvent": {
        "productId": string
      },
      "productAvailabilityChangeEvent": {
        "productId": string,
        "availabilityStatus": string
      },
      "newDeviceEvent": {
        "userId": string,
        "deviceId": string,
        "managementType": string,
        "dpcPackageName": string
      },
      "deviceReportUpdateEvent": {
        "userId": string,
        "deviceId": string,
        "report": {
          "lastUpdatedTimestampMillis": long,
          "appState": [
            {
              "packageName": string,
              "keyedAppState": [
                {
                  "key": string,
                  "stateTimestampMillis": long,
                  "severity": string,
                  "message": string,
                  "data": string
                }
              ]
            }
          ]
        }
      }
    }
  ]
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
notificationSetId string รหัสชุดการแจ้งเตือน ซึ่งต้องทำเครื่องหมายการแจ้งเตือนว่าได้รับด้วย Enterprises.AcknowledgeNotification API ส่วนนี้จะถูกละไว้ถ้าไม่มีการแจ้งเตือน
notification[] list การแจ้งเตือนที่ได้รับ หรือว่างเปล่าหากไม่มีการแจ้งเตือน
notification[].enterpriseId string รหัสขององค์กรที่จะส่งการแจ้งเตือน ซึ่งจะแสดงเสมอ
notification[].timestampMillis long เวลาที่เผยแพร่การแจ้งเตือนเป็นมิลลิวินาทีตั้งแต่ 1970-01-01T00:00:00Z ซึ่งจะแสดงเสมอ
notification[].productApprovalEvent nested object การแจ้งเตือนเกี่ยวกับการเปลี่ยนแปลงสถานะการอนุมัติของผลิตภัณฑ์
notification[].productApprovalEvent.productId string รหัสของผลิตภัณฑ์ (เช่น "app:com.google.android.gm") ที่มีการเปลี่ยนแปลงสถานะการอนุมัติ ช่องนี้จะแสดงอยู่เสมอ
notification[].productApprovalEvent.approved string ผลิตภัณฑ์ได้รับอนุมัติหรือไม่ได้รับอนุมัติ ช่องนี้จะปรากฏเสมอ

ค่าที่ยอมรับได้ มีดังนี้
  • "approved"
  • "unapproved"
  • "unknown"
notification[].installFailureEvent nested object การแจ้งเตือนเกี่ยวกับการติดตั้งแอปที่ไม่สำเร็จ
notification[].installFailureEvent.productId string รหัสของผลิตภัณฑ์ (เช่น "app:com.google.android.gm") ที่ทำให้เกิดเหตุการณ์การติดตั้งไม่สำเร็จ ช่องนี้จะปรากฏเสมอ
notification[].installFailureEvent.deviceId string รหัส Android ของอุปกรณ์ ช่องนี้จะปรากฏเสมอ
notification[].installFailureEvent.userId string รหัสผู้ใช้ ช่องนี้จะแสดงอยู่เสมอ
notification[].installFailureEvent.failureReason string สาเหตุที่ติดตั้งไม่สำเร็จ ช่องนี้จะแสดงอยู่เสมอ

ค่าที่ยอมรับได้ มีดังนี้
  • "timeout"
  • "unknown"
notification[].installFailureEvent.failureDetails string รายละเอียดเพิ่มเติมเกี่ยวกับความล้มเหลว (หากมี)
notification[].appUpdateEvent nested object การแจ้งเตือนเกี่ยวกับการอัปเดตแอป
notification[].appUpdateEvent.productId string รหัสของผลิตภัณฑ์ (เช่น "app:com.google.android.gm") ที่อัปเดต ช่องนี้จะแสดงอยู่เสมอ
notification[].newPermissionsEvent nested object การแจ้งเตือนเกี่ยวกับสิทธิ์ใหม่ของแอป
notification[].newPermissionsEvent.productId string รหัสของผลิตภัณฑ์ (เช่น "app:com.google.android.gm") ที่เพิ่มสิทธิ์ใหม่ ช่องนี้จะแสดงอยู่เสมอ
notification[].newPermissionsEvent.requestedPermissions[] list ชุดของสิทธิ์ที่แอปกำลังขอในปัจจุบัน ใช้ Permissions.Get ใน EMM API เพื่อเรียกข้อมูลรายละเอียดเกี่ยวกับสิทธิ์เหล่านี้
notification[].newPermissionsEvent.approvedPermissions[] list ชุดสิทธิ์ที่ผู้ดูแลระบบขององค์กรอนุมัติให้แอปพลิเคชันนี้แล้ว ใช้ "สิทธิ์" จาก EMM API เพื่อเรียกดูรายละเอียดเกี่ยวกับสิทธิ์เหล่านี้
notification[].appRestrictionsSchemaChangeEvent nested object การแจ้งเตือนเกี่ยวกับการเปลี่ยนแปลงสคีมาข้อจำกัดแอปใหม่
notification[].appRestrictionsSchemaChangeEvent.productId string รหัสของผลิตภัณฑ์ (เช่น "app:com.google.android.gm") ที่มีการเปลี่ยนแปลงสคีมาข้อจำกัดของแอป ช่องนี้จะแสดงอยู่เสมอ
notification[].productAvailabilityChangeEvent nested object การแจ้งเตือนเกี่ยวกับการเปลี่ยนแปลงความพร้อมจำหน่ายผลิตภัณฑ์
notification[].productAvailabilityChangeEvent.productId string รหัสของผลิตภัณฑ์ (เช่น "app:com.google.android.gm") ที่มีการเปลี่ยนแปลงความพร้อมจำหน่ายผลิตภัณฑ์ ช่องนี้จะปรากฏเสมอ
notification[].productAvailabilityChangeEvent.availabilityStatus string สถานะใหม่ของผลิตภัณฑ์ ช่องนี้จะแสดงอยู่เสมอ

ค่าที่ยอมรับได้ มีดังนี้
  • "available"
  • "removed"
  • "unknown"
  • "unpublished"
notification[].newDeviceEvent nested object การแจ้งเตือนเกี่ยวกับอุปกรณ์ใหม่
notification[].newDeviceEvent.userId string รหัสผู้ใช้ ช่องนี้จะปรากฏเสมอ
notification[].newDeviceEvent.deviceId string รหัส Android ของอุปกรณ์ ช่องนี้จะปรากฏเสมอ
notification[].newDeviceEvent.managementType string ระบุระดับที่อุปกรณ์ได้รับการควบคุมจาก EMM ของ Android ในการกำหนดค่าต่างๆ ของการติดตั้งใช้งาน

ค่าที่เป็นไปได้ ได้แก่
  • "managedDevice" อุปกรณ์ที่ตั้งค่า DPC เป็นเจ้าของอุปกรณ์
  • "managedProfile" ซึ่งเป็นอุปกรณ์ที่ตั้งค่า DPC เป็นเจ้าของโปรไฟล์


ค่าที่ยอมรับมีดังนี้
  • "managedDevice"
  • "managedProfile"
notification[].notificationType string ประเภทการแจ้งเตือน

ค่าที่ยอมรับได้ มีดังนี้
  • "appRestricionsSchemaChange"
  • "appUpdate"
  • "deviceReportUpdate"
  • "installFailure"
  • "newDevice"
  • "newPermissions"
  • "productApproval"
  • "productAvailabilityChange"
  • "testNotification"
  • "unknown"
notification[].newDeviceEvent.dpcPackageName string แอปนโยบายในอุปกรณ์
notification[].deviceReportUpdateEvent nested object การแจ้งเตือนเกี่ยวกับการอัปเดตรายงานอุปกรณ์
notification[].deviceReportUpdateEvent.userId string รหัสผู้ใช้ ช่องนี้จะปรากฏเสมอ
notification[].deviceReportUpdateEvent.deviceId string รหัส Android ของอุปกรณ์ ช่องนี้จะปรากฏเสมอ
notification[].deviceReportUpdateEvent.report nested object รายงานอุปกรณ์มีการอัปเดตสถานะแอปล่าสุด ช่องนี้จะแสดงอยู่เสมอ
notification[].deviceReportUpdateEvent.report.lastUpdatedTimestampMillis long การประทับเวลาของการอัปเดตรายงานล่าสุดเป็นมิลลิวินาทีนับตั้งแต่ Epoch ช่องนี้จะปรากฏเสมอ
notification[].deviceReportUpdateEvent.report.appState[] list รายการสถานะของแอปที่แอปที่มีการจัดการในอุปกรณ์กำหนด นักพัฒนาแอปเป็นผู้กำหนดสถานะแอป ช่องนี้จะปรากฏเสมอ
notification[].deviceReportUpdateEvent.report.appState[].packageName string ชื่อแพ็กเกจของแอป ช่องนี้จะปรากฏอยู่เสมอ
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[] list รายการสถานะแอปที่มีคีย์ ช่องนี้จะปรากฏเสมอ
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].key string คีย์ที่ระบุสถานะของแอป นักพัฒนาแอปเป็นผู้กำหนดเนื้อหาของคีย์ เราขอแนะนำให้นำ HTML ออกจากคีย์ก่อนแสดง XSS ช่องนี้จะแสดงอยู่เสมอ
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].stateTimestampMillis long การประทับเวลาที่แอปตั้งค่าสถานะเป็นมิลลิวินาทีตั้งแต่ Epoch ช่องนี้จะปรากฏเสมอ
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].severity string ความรุนแรงของสถานะแอป ช่องนี้จะปรากฏเสมอ

ค่าที่ยอมรับได้ มีดังนี้
  • "severityError"
  • "severityInfo"
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].message string ข้อความรูปแบบอิสระที่มนุษย์อ่านได้ซึ่งอธิบายถึงสถานะของแอป เช่น ข้อความแสดงข้อผิดพลาด เราขอแนะนำให้นำ HTML ออกจากข้อความก่อนแสดงเพื่อป้องกัน XSS
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].data string ช่องเพิ่มเติมสำหรับข้อมูลที่เครื่องอ่านได้ เช่น ตัวเลขหรือออบเจ็กต์ JSON เราขอแนะนำให้นำ HTML ออกจากข้อมูลก่อนแสดงผลเพื่อป้องกัน XSS
kind string