Chrome Management Telemetry API के लिए कोड सैंपल

इस लिंक पर जाएँ Chrome Management टेलीमेट्री एपीआई देखें.

नीचे दिखाए गए सभी अनुरोध, इन वैरिएबल का इस्तेमाल करते हैं:

  • $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"
}

संगठन की किसी एक इकाई के लिए टेलीमेट्री डिवाइस के डेटा की सूची बनाना

संगठन की किसी एक इकाई के टेलीमेट्री डेटा को सूची में शामिल करने के लिए, filter पैरामीटर में orgUnitId वैल्यू का इस्तेमाल करें.

अनुरोध

  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 बताया गया है.

इस फ़िल्टर का इस्तेमाल करने के लिए, filter में reports_timestamp वैल्यू डालें पैरामीटर और मिलीसेकंड में Unix Epoch के लिए, टाइमस्टैंप वैल्यू शामिल करें (जैसे, 1679288169623) या आरएफ़सी 3339 "ज़ुलु" फ़ॉर्मैट किया गया समय (ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंक यानी "2023-02-15T11:18:51.383Z") फ़ॉर्मैट इस्तेमाल कर सकते हैं. टाइमस्टैंप एपीआई, यूटीसी टाइमज़ोन में है. इसलिए, 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"
        }
      ]
    }
  ]
}

एक से ज़्यादा फ़िल्टर इस्तेमाल करके टेलीमेट्री डिवाइस के डेटा की सूची बनाएं (कंजक्शन फ़िल्टर करने की सुविधा)

एपीआई से मिले जवाब को सटीक बनाने के लिए, एक से ज़्यादा फ़िल्टर इस्तेमाल करने के लिए, filter पैरामीटर में AND कीवर्ड का इस्तेमाल करें. साथ ही, फ़िल्टर करने की कई शर्तें शामिल करें.

अनुरोध

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

संगठन की किसी एक इकाई के लिए, टेलीमेट्री उपयोगकर्ता के डेटा की सूची बनाना

संगठन की किसी एक इकाई के टेलीमेट्री डेटा को सूची में शामिल करने के लिए, filter पैरामीटर में orgUnitId वैल्यू का इस्तेमाल करें.

अनुरोध

  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 कम से कम एक इवेंट टाइप वाला पैरामीटर ज़रूरी है.

डिफ़ॉल्ट तौर पर, इवेंट के 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"
  • event_type
    • 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>"
}