ตัวอย่างโค้ดสำหรับ Chrome Management Telemetry API

ไปที่เว็บไซต์ Chrome Management Telemetry API เพื่อดูภาพรวมฟีเจอร์ของ API

คำขอทั้งหมดที่แสดงด้านล่างใช้ตัวแปรต่อไปนี้

  • $TOKEN - โทเค็น OAuth 2
  • $CUSTOMER - รหัสของลูกค้าหรือรหัสของลูกค้า my_customer

แสดงรายการข้อมูลอุปกรณ์จากทางไกล

หากต้องการแสดงรายการการวัดและส่งข้อมูลทางไกลสำหรับอุปกรณ์ Chrome ให้ใช้ อุปกรณ์ปลายทาง /telemetry/devices พารามิเตอร์ readMask ใช้เพื่อระบุพารามิเตอร์ แสดงฟิลด์อุปกรณ์ คุณสามารถควบคุมการใส่เลขหน้าของผลลัพธ์โดยใช้ พารามิเตอร์ pageSize และ pageToken ระบุ filter เพื่อจำกัดขอบเขตให้แคบลง ผลลัพธ์ตามเกณฑ์ของอุปกรณ์หรือการรายงาน

ส่งคำขอ

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/telemetry/devices?readMask=name,customer,orgUnitId,deviceId,serialNumber,cpuInfo,cpuStatusReport,memoryInfo,memoryStatusReport,osUpdateStatus&pageSize=2"

คำตอบ

{
  "devices": [
    {
      "name": "customers/<customer>/telemetry/devices/<deviceId>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "deviceId": "<deviceId>",
      "serialNumber": "0A2B213CDEFG",
      "cpuStatusReport": [
        {
          "reportTime": "2021-04-25T13:23:55.880Z",
          "cpuUtilizationPct": 76
        },
        {
          "reportTime": "2021-04-25T18:25:55.880Z",
          "cpuTemperatureInfo": [
            {
              "temperatureCelsius": 38,
              "label": "Core"
            },
          ]
        }
      ],
      "memoryStatusReport": [
        {
          "reportTime": "2021-04-25T13:23:55.880Z",
          "systemRamFreeBytes": "14358468900"
        }
      ],
      "osUpdateStatus": [
        {
          "lastUpdateTime": "2021-04-25T11:18:51.383Z",
          "lastUpdateCheckTime": "1970-01-01T00:00:00Z",
          "lastRebootTime": "2021-04-25T11:18:51.383Z"
        }
      ]
    },
    {
      "name": "customers/<customer>/telemetry/devices/<deviceId>",
      "customer": "customers/<customer>",
      "orgUnitId": "FEDCBA",
      "deviceId": "<deviceId>",
      "serialNumber": "1B3D817LKUH",
      "cpuStatusReport": [
        {
          "reportTime": "2021-05-25T13:23:55.880Z",
          "cpuUtilizationPct": 50
        },
      ],
      "memoryStatusReport": [
        {
          "reportTime": "2021-05-25T13:23:55.880Z",
          "systemRamFreeBytes": "14358468900"
        }
      ],
      "osUpdateStatus": [
        {
          "lastUpdateTime": "2021-05-25T11:18:51.383Z",
          "lastUpdateCheckTime": "1970-01-01T00:00:00Z",
          "lastRebootTime": "2021-05-25T11:18:51.383Z"
        }
      ]
    }
  ],
  "nextPageToken": "PAGE_TOKEN"
}

แสดงรายการข้อมูลอุปกรณ์ทางไกลสำหรับหน่วยขององค์กรเดียว

หากต้องการแสดงรายการการวัดและส่งข้อมูลทางไกลสำหรับหน่วยขององค์กรเดียว ให้ใช้ค่า orgUnitId ในพารามิเตอร์ filter

ส่งคำขอ

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/telemetry/devices?readMask=name,customer,orgUnitId,deviceId,serialNumber,cpuInfo,cpuStatusReport,memoryInfo,memoryStatusReport,osUpdateStatus&filter=orgUnitId=ABCDEFG"

คำตอบ

{
  "devices": [
    {
      "name": "customers/<customer>/telemetry/devices/<deviceId>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "deviceId": "<deviceId>",
      "serialNumber": "0A2B213CDEFG",
      "cpuStatusReport": [
        {
          "reportTime": "2021-04-25T13:23:55.880Z",
          "cpuUtilizationPct": 76
        },
        {
          "reportTime": "2021-04-25T18:25:55.880Z",
          "cpuTemperatureInfo": [
            {
              "temperatureCelsius": 38,
              "label": "Core"
            },
          ]
        }
      ],
      "memoryStatusReport": [
        {
          "reportTime": "2021-04-25T13:23:55.880Z",
          "systemRamFreeBytes": "14358468900"
        }
      ],
      "osUpdateStatus": [
        {
          "lastUpdateTime": "2021-04-25T11:18:51.383Z",
          "lastUpdateCheckTime": "1970-01-01T00:00:00Z",
          "lastRebootTime": "2021-04-25T11:18:51.383Z"
        }
      ]
    }
  ]
}

แสดงรายการข้อมูลอุปกรณ์จากทางไกลโดยใช้ตัวกรองการประทับเวลา

ตัวกรองการประทับเวลาจะแสดงอุปกรณ์ทั้งหมด แต่จะมีเฉพาะรายงานที่สอดคล้องกับเท่านั้น ลงในตัวกรองการประทับเวลาและระบุ read_mask

หากต้องการใช้ตัวกรองนี้ ให้ระบุค่า reports_timestamp ใน filter และระบุค่าการประทับเวลาใน Unix Epoch ในหน่วยมิลลิวินาที (ได้แก่ 1679288169623) หรือ RFC 3339 "Zulu" เวลาที่จัดรูปแบบ (สูงสุดเก้าเศษส่วน ตัวเลข ได้แก่ "2023-02-15T11:18:51.383Z") การประทับเวลาที่แสดงผลโดย API อยู่ในเขตเวลา UTC ดังนั้นค่าตัวกรอง reports_timestamp จึงควรเป็น ในเขตเวลา UTC โอเปอเรเตอร์การเปรียบเทียบตัวเลขมาตรฐานทั้งหมด รองรับ (<, >, <=, >=, =)

แสดงรายการรายงานทั้งหมด

เนื่องจากระบบจะแสดงผลรายงานล่าสุดเมื่อไม่มีค่า reports_timestamp เท่านั้น ที่ระบุ การเรียกต่อไปนี้สามารถใช้เพื่อเรียกดูรายงานอุปกรณ์ทั้งหมดได้ ที่รวมอยู่ในread_maskสำหรับอุปกรณ์ทั้งหมด

ส่งคำขอ

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/telemetry/devices?readMask=name,customer,orgUnitId,deviceId,serialNumber,audioStatusReport,cpuStatusReport,heartbeatStatusReport,memoryStatusReport&filter=reports_timestamp>=0"

คำตอบ

{
  "devices": [
    {
      "name": "customers/<customer>/telemetry/devices/<deviceId>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "deviceId": "<deviceId>",
      "serialNumber": "0A2B213CDEFG",
      "audioStatusReport": [
        {
          "reportTime": "2009-01-01T12:37:51.383Z",
          "inputMute": true,
          "inputDevice": "example input device 2009",
        },
        {
          "reportTime": "2010-02-01T12:37:51.383Z",
          "inputMute": false,
          "inputDevice": "example input device 2010",
        },
        {
          "reportTime": "2011-03-01T12:37:51.383Z",
          "inputMute": true,
          "inputDevice": "example input device 2011",
        },
        {
          "reportTime": "2024-01-01T12:37:51.383Z",
          "inputMute": false,
          "inputDevice": "example input device 2024",
        }
      ],
      "cpuStatusReport": [
        {
          "reportTime": "1960-10-15T01:18:51.383Z",
          "cpuUtilizationPct": 76
        },
        {
          "reportTime": "1997-10-31T11:18:51.383Z",
          "cpuTemperatureInfo": [
            {
              "temperatureCelsius": 38,
              "label": "Core"
            },
          ]
        }
      ]
    },
    {
      "name": "customers/<customer>/telemetry/devices/<deviceId 1>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "deviceId": "<deviceId 1>",
      "serialNumber": "HGFEDCBA",
      "heartbeatStatusReport": [
        {
          "reportTime": "2001-02-15T11:18:51.383Z",
          "state": "ONLINE"
        },
        {
          "reportTime": "2002-07-22T11:18:51.383Z",
          "state": "OFFLINE"
        },
        {
          "reportTime": "2012-01-04T11:18:51.383Z",
          "state": "UNKNOWN"
        },
        {
          "reportTime": "2024-02-29T11:18:51.383Z",
          "state": "ONLINE"
        }
      ],
      "memoryStatusReport": [
        {
          "reportTime": "2024-03-20T11:18:51.383Z",
          "systemRamFreeBytes": "112233445566778"
        }
      ]
    }
  ]
}

แสดงรายการรายงานหลังจากการประทับเวลาที่ระบุ

หากต้องการส่งคำขอการค้นหารายงานหลังจากการประทับเวลาที่เจาะจง ให้ใช้เมธอด reports_timestamp ดังที่แสดงในตัวอย่างต่อไปนี้

ส่งคำขอ

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/telemetry/devices?readMask=name,customer,orgUnitId,deviceId,serialNumber,cpuStatusReport,memoryStatusReport,osUpdateStatus&filter=reports_timestamp>=\"2023-02-15T11:18:51.383Z\""

คำตอบ

{
  "devices": [
    {
      "name": "customers/<customer>/telemetry/devices/<deviceId>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "deviceId": "<deviceId>",
      "serialNumber": "0A2B213CDEFG",
      "cpuStatusReport": [
        {
          "reportTime": "2023-02-15T11:18:51.383Z",
          "cpuUtilizationPct": 76
        },
        {
          "reportTime": "2023-03-19T11:18:51.383Z",
          "cpuTemperatureInfo": [
            {
              "temperatureCelsius": 38,
              "label": "Core"
            },
          ]
        }
      ],
      "memoryStatusReport": [
        {
          "reportTime": "2023-04-19T11:18:51.383Z",
          "systemRamFreeBytes": "14358468900"
        }
      ]
    },
    {
      "name": "customers/<customer>/telemetry/devices/<deviceId 1>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "deviceId": "<deviceId 1>",
      "serialNumber": "HGFEDCBA",
      "memoryStatusReport": [
        {
          "reportTime": "2024-02-15T11:18:51.383Z",
          "systemRamFreeBytes": "112233445566778"
        }
      ]
    }
  ]
}

แสดงรายการข้อมูลอุปกรณ์จากทางไกลโดยใช้ตัวกรองหลายรายการ (การกรองด้วยคำสรรพนาม)

หากต้องการใช้ตัวกรองหลายรายการเพื่อจำกัดการตอบกลับที่ API แสดงผล ให้ใช้คีย์เวิร์ด AND ในพารามิเตอร์ filter และรวมเกณฑ์การกรองหลายรายการ

ส่งคำขอ

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/telemetry/devices?readMask=name,customer,orgUnitId,deviceId,serialNumber,cpuStatusReport,memoryStatusReport,osUpdateStatus&filter=reports_timestamp=\"2023-02-15T11:18:51.383Z\" AND serialNumber=HGFEDCBA"

คำตอบ

{
  "devices": [
    {
      "name": "customers/<customer>/telemetry/devices/<deviceId 1>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "deviceId": "<deviceId 1>",
      "serialNumber": "HGFEDCBA",
      "memoryStatusReport": [
        {
          "reportTime": "2023-02-15T11:18:51.383Z",
          "systemRamFreeBytes": "112233445566778"
        }
      ]
    }
  ]
}

แสดงรายการข้อมูลผู้ใช้การวัดและส่งข้อมูลทางไกล

หากต้องการแสดงรายการการวัดและส่งข้อมูลทางไกลสำหรับอุปกรณ์ Chrome ให้ใช้ อุปกรณ์ปลายทาง /telemetry/users พารามิเตอร์ readMask ใช้เพื่อระบุพารามิเตอร์ แสดงฟิลด์อุปกรณ์ คุณสามารถควบคุมการใส่เลขหน้าของผลลัพธ์โดยใช้ พารามิเตอร์ pageSize และ pageToken

ส่งคำขอ

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/telemetry/users?readMask=name,customer,orgUnitId,userId,userEmail,user_device.device_id,user_device.audio_status_report,user_device.peripherals_report&pageSize=2"

คำตอบ

{
  "telemetryUsers": [
    {
      "name": "customers/<customer>/telemetry/users/<userId>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "userEmail": "<userId>",
      "userEmail": "user@mytestdomain.com",
      "userDevice": [
        {
          "deviceId": "HIJKLMNOP",
          "audioStatusReport": [
            {
              "reportTime": "2021-04-25T13:23:55.880Z",
              "outputMute": true,
              "inputMute": true,
            }
          ],
          "peripheralsReport": [
            {
              "reportTime": "2021-04-25T18:25:55.880Z",
              "usbPeripheralReport": [
                {
                  "vendor": "Vendor",
                  "name": "Microphone",
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "name": "customers/<customer>/telemetry/users/<userId>",
      "customer": "customers/<customer>",
      "orgUnitId": "QRSTUV",
      "userEmail": "<userId>",
      "userEmail": "user2@mytestdomain.com",
      "userDevice": [
        {
          "deviceId": "WXYZ",
          "audioStatusReport": [
            {
              "reportTime": "2021-04-25T13:23:55.880Z",
              "outputMute": true,
              "inputMute": true,
            }
          ],
          "peripheralsReport": [
            {
              "reportTime": "2021-04-25T18:25:55.880Z",
              "usbPeripheralReport": [
                {
                  "vendor": "Vendor",
                  "name": "Microphone",
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "nextPageToken": "PAGE_TOKEN"
}

แสดงรายการข้อมูลผู้ใช้การวัดและส่งข้อมูลทางไกลสำหรับหน่วยขององค์กรเดียว

หากต้องการแสดงรายการการวัดและส่งข้อมูลทางไกลสำหรับหน่วยขององค์กรเดียว ให้ใช้ค่า orgUnitId ในพารามิเตอร์ filter

ส่งคำขอ

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/telemetry/users?readMask=name,customer,orgUnitId,userId,userEmail,user_device.device_id,user_device.audio_status_report,user_device.peripherals_report&pageSize=2&filter=orgUnitId=ABCDEFG"

คำตอบ

{
  "telemetryUsers": [
    {
      "name": "customers/<customer>/telemetry/users/<userId>",
      "customer": "customers/<customer>",
      "orgUnitId": "ABCEDFG",
      "userEmail": "<userId>",
      "userEmail": "user@mytestdomain.com",
      "userDevice": [
        {
          "deviceId": "HIJKLMNOP",
          "audioStatusReport": [
            {
              "reportTime": "2021-04-25T13:23:55.880Z",
              "outputMute": true,
              "inputMute": true,
            }
          ],
          "peripheralsReport": [
            {
              "reportTime": "2021-04-25T18:25:55.880Z",
              "usbPeripheralReport": [
                {
                  "vendor": "Vendor",
                  "name": "Microphone",
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

แสดงรายการข้อมูลเหตุการณ์การวัดและส่งข้อมูลทางไกล

หากต้องการแสดงรายการเหตุการณ์การส่งข้อมูลทางไกลสำหรับลูกค้า ให้ใช้ปลายทาง /telemetry/events พารามิเตอร์ readMask ใช้เพื่อระบุช่องที่จะแสดง ในอนาคตอันใกล้ พารามิเตอร์ readMask จะกลายเป็นตัวเลือกที่ไม่บังคับ และ filter ต้องระบุพารามิเตอร์ที่มีประเภทเหตุการณ์อย่างน้อย 1 ประเภท

โดยค่าเริ่มต้น ช่อง name, report_time และ event_type ของเหตุการณ์จะรวมอยู่ในคำตอบ คุณควบคุมการใส่เลขหน้าของผลลัพธ์ได้โดยใช้พารามิเตอร์ pageSize และ pageToken นอกจากนี้ คุณยังกรองผลลัพธ์ด้วยพารามิเตอร์ต่อไปนี้ได้ด้วย

  • device_id
  • user_id
  • device_org_unit_id
  • user_org_unit_id
  • timestamp
    • ค่าที่ป้อนอาจเป็น EPOCH มิลลิวินาทีได้ เช่น timestamp<1667423821001 หรือ RFC 3339 กล่าวคือ วันที่ timestamp<"2022-11-02T20:08:32.386Z"
  • ประเภทเหตุการณ์
    • audio_severe_underrun
    • network_connection_state_change
    • usb_added
    • usb_removed
    • network_htps_latency_change

ส่งคำขอ

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/telemetry/events?readMask=device,usb_peripherals_event&filter=event_type=usb_added&pageSize=3"

คำตอบ

{
  "telemetryEvents": [
    {
      "name": "customers/<customer>/telemetry/events/<event id>",
      "device": {
        "deviceId": "<device id>",
        "orgUnitId": "<device’s org unit id>"
      },
      "reportTime": "2022-11-02T11:14:09.034Z",
      "eventType": "USB_ADDED",
      "usbPeripheralsEvent": {
        "usbPeripheralReport": [
          {
            "vendor": "Microdia",
            "name": "Integrated_Webcam_HD",
            "vid": <vid>,
            "pid": <pid>
          }
        ]
      }
    },
    {
      "name": "customers/<customer>/telemetry/events/<event id>",
      "device": {
        "deviceId": "<device id>",
        "orgUnitId": "<device’s org unit id>"
      },
      "reportTime": "2022-11-02T10:10:36.481Z",
      "eventType": "USB_ADDED",
      "usbPeripheralsEvent": {
        "usbPeripheralReport": [
          {
            "vendor": "Hewlett-Packard",
            "name": "x304m",
            "vid": <vid>,
            "pid": <pid>,
            "categories": [
              "Mass storage"
            ]
          }
        ]
      }
    },
    {
      "name": "customers/<customer>/telemetry/events/<event id>",
      "device": {
        "deviceId": "<device id>",
        "orgUnitId": "<device’s org unit id>"
      },
      "reportTime": "2022-11-02T09:58:48.249Z",
      "eventType": "USB_ADDED",
      "usbPeripheralsEvent": {
        "usbPeripheralReport": [
          {
            "vendor": "Realtek Semiconductor Corp.",
            "name": "USB 10/100/1000 LAN",
            "vid": <vid>,
            "pid": <pid>,
            "categories": [
              "Vendor Specific"
            ]
          }
        ]
      }
    }
  ],
  "nextPageToken": "<page token>"
}