डायरेक्ट्री एपीआई: Chrome डिवाइस

किसी खाते के लिए सभी Chrome डिवाइस फिर से पाएं

किसी खाते को असाइन किए गए सभी Chrome डिवाइसों की सूची लौटाने के लिए, नीचे दिए गए GET अनुरोध का इस्तेमाल करें और अनुमति वाले अनुरोध में बताया गया अनुमति शामिल करें. आसानी से पढ़े जा सकें, इसके लिए इस कोड सैंपल में लाइन रिटर्न शामिल हैं: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?projection={BASIC|FULL}&query=query
&orderBy=orderBy category&sortOrder={ASCENDING|DESCENDING}
&pageToken=token for next results page, if applicable
&maxResults=max number of results per page

  • customerId, ग्राहक के Google खाते का यूनीक आइडेंटिफ़ायर होता है.
  • खाते के एडमिन के तौर पर, आपके पास my_customer स्ट्रिंग का इस्तेमाल करने का भी विकल्प होता है. यह स्ट्रिंग, आपके खाते की customerId के बारे में बताती है. customerId वैल्यू पाने का एक और तरीका, उपयोगकर्ता को वापस पाना कार्रवाई का इस्तेमाल करना है. कार्रवाई के userKey पाथ पैरामीटर में, अपने एडमिन ईमेल पते या अपने एडमिन के यूनीक उपयोगकर्ता id की वैल्यू का इस्तेमाल करें.

क्वेरी स्ट्रिंग, अनुरोध, और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें.

उदाहरण: उपयोगकर्ता के हिसाब से डिवाइसों को फ़िल्टर करना

यह उदाहरण query=user:help desk का इस्तेमाल करके किसी खास उपयोगकर्ता की खोज करता है. रिस्पॉन्स में एक chromeosdevice रिसॉर्स शामिल है, जिसमें annotatedUser help desk है:

JSON अनुरोध

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=user:help desk&orderBy=status
&sortOrder=ASCENDING&maxResults=100

JSON का रिस्पॉन्स

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "etag": "1234567890"
       "deviceId": "def456",
       "serialNumber": "234567",
       "status": "ACTIVE",
       "lastSync": "2013-03-05T17:30:04.325Z",
       "supportEndDate": "2014-04-05T17:30:04.325Z",
       "annotatedUser": "help desk",
       "annotatedLocation": "Mountain View help desk Chromebook",
       "annotatedAssetId": "1234567890",
       "notes": "Loaned from support",
       "orderNumber": "1234",
       "willAutoRenew": true,
       "osVersion": "Browser Version 18.0",
       "platformVersion": "Platform Version 1415.2.0",
       "firmwareVersion": "Firmware Version 1.2.3.4",
       "bootMode": "validated",
       "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
       "orgUnitPath": "corp/engineering",
       "recentUsers": [
         {
           "type": "USER_TYPE_MANAGED",
           "email": "user@customer.com"
         }
       ],
       "activeTimeRanges": [
         {
           "date": "2012-04-05",
           "activeTime": "3600000"
         }
       ],
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

उदाहरण: डिवाइसों को सीरियल नंबर के हिसाब से फ़िल्टर करना

इस उदाहरण में, query=id:123456 का इस्तेमाल करके किसी खास सीरियल नंबर की खोज की जाती है. इसमें 123456, डिवाइस का सीरियल नंबर है. यहां दिए गए रिस्पॉन्स में एक ही जवाब शामिल है. इसमें serialNumber प्रॉपर्टी, खोज की वैल्यू से मेल खाती है.

JSON अनुरोध

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=id:123456&orderBy=status
&sortOrder=ASCENDING&maxResults=100

JSON का रिस्पॉन्स

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "deviceId": "abc123",
       "serialNumber": "123456",
       "status": "SHIPPED",
       "supportEndDate": "1404457200000",
       "model": "model_value",
       "meid": "meid_value",
       "macAddress": "mac_address_value",
       "orderNumber": "1234",
       "willAutoRenew": true
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

रिस्पॉन्स के इस उदाहरण में model, meid, और macAddress प्रॉपर्टी शामिल हैं. अगर किसी डिवाइस में ये प्रॉपर्टी नहीं हैं, तो उन्हें रिस्पॉन्स में शामिल नहीं किया जाता है. पूरी जानकारी के लिए, Chromeosdevices का रिसॉर्स रिप्रज़ेंटेशन देखें.

MEID सूची एक्सपोर्ट करना

Chrome डिवाइस में 3G मोबाइल कार्ड का meid, मोबाइल इक्विपमेंट आइडेंटिफ़ायर (MEID) होता है. आम तौर पर, MEID का इस्तेमाल तब किया जाता है, जब डिवाइस को वायरलेस मोबाइल और इंटरनेट सेवा देने वाली कंपनी के पोस्ट-पे सेवा प्लान में जोड़ा जाता है. MEID की सूची एक्सपोर्ट करने के लिए, यहां दिए गए GET अनुरोध और nextPageToken वैल्यू का इस्तेमाल करें. इससे MEID की पूरी सूची वापस लाई जा सकेगी. आसानी से समझ में आने के लिए, इस कोड सैंपल में लाइन रिटर्न शामिल हैं: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?fields=nextPageToken,chromeosdevices(meid)

Chrome डिवाइस वापस पाना

Chrome डिवाइस की प्रॉपर्टी वापस पाने के लिए, नीचे दिए गए GET अनुरोध का इस्तेमाल करें और अनुमति वाले अनुरोध में बताया गया अनुमति शामिल करें. आसानी से पढ़े जा सकें, इसके लिए इस कोड सैंपल में लाइन रिटर्न शामिल हैं: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId, ग्राहक के Google खाते का यूनीक आइडेंटिफ़ायर होता है.
  • खाते के एडमिन के तौर पर, आपके पास my_customer स्ट्रिंग का इस्तेमाल करने का भी विकल्प होता है. यह स्ट्रिंग, आपके खाते की customerId के बारे में बताती है. customerId वैल्यू पाने का एक और तरीका, उपयोगकर्ता को वापस पाना कार्रवाई का इस्तेमाल करना है. कार्रवाई के userKey पाथ पैरामीटर में, अपने एडमिन ईमेल पते या अपने एडमिन के यूनीक उपयोगकर्ता id की वैल्यू का इस्तेमाल करें.
  • deviceId, किसी डिवाइस का यूनीक आइडेंटिफ़ायर होता है. यह सभी Chrome डिवाइसों को वापस पाएं कार्रवाई के जवाब में मिलता है.

क्वेरी स्ट्रिंग, अनुरोध, और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें.

JSON अनुरोध

अनुरोध का एक उदाहरण. आसानी से पढ़े जा सकें, इसके लिए इस कोड सैंपल में लाइन रिटर्न शामिल है: 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

JSON का रिस्पॉन्स

अनुरोध स्वीकार होने पर, एचटीटीपी 200 स्टेटस कोड दिखता है. स्टेटस कोड के साथ-साथ रिस्पॉन्स, Chrome डिवाइस की प्रॉपर्टी दिखाता है: 

{
  "kind": "directory#chromeosdevice",
  "deviceId": "device_id_value",
  "serialNumber": "device_serial_number",
  "status": "ACTIVE",
  "lastSync": "2012-04-05T17:30:04.325Z",
  "supportEndDate": "2014-04-05T17:30:04.325Z",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "12345667890",
  "notes": "Loaned from support",
  "orderNumber": "123456",
  "willAutoRenew": true,
  "osVersion": "Browser Version 18.0",
  "platformVersion": "Platform Version 1415.2.0",
  "firmwareVersion": "Firmware Version 1.2.3.4",
  "bootMode": "validated"
  "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
  "orgUnitPath": "corp/engineering"
}

Chrome डिवाइस को अपडेट करना

किसी Chrome डिवाइस को अपडेट करने के लिए, यहां दिए गए PUT अनुरोध का इस्तेमाल करें और अनुमति वाले अनुरोध में बताया गया अनुमति शामिल करें. आसानी से पढ़े जा सकें, इसके लिए इस कोड सैंपल में लाइन रिटर्न शामिल हैं: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId, ग्राहक के Google खाते का यूनीक आइडेंटिफ़ायर होता है.
  • खाते के एडमिन के तौर पर, आपके पास my_customer स्ट्रिंग का इस्तेमाल करने का भी विकल्प होता है. यह स्ट्रिंग, आपके खाते की customerId के बारे में बताती है. customerId वैल्यू पाने का एक और तरीका, उपयोगकर्ता को वापस पाना कार्रवाई का इस्तेमाल करना है. कार्रवाई के userKey पाथ पैरामीटर में, अपने एडमिन ईमेल पते या अपने एडमिन के यूनीक उपयोगकर्ता id की वैल्यू का इस्तेमाल करें.
  • deviceId, किसी डिवाइस का यूनीक आइडेंटिफ़ायर होता है. यह सभी Chrome डिवाइसों को वापस पाएं कार्रवाई के जवाब में मिलता है.

क्वेरी स्ट्रिंग, अनुरोध, और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें.

JSON अनुरोध

नीचे दिया गया JSON अनुरोध, Chrome डिवाइस की annotatedUser, annotatedLocation, annotatedAssetId, notes, और orgUnitPath प्रॉपर्टी को अपडेट करता है. आसानी से पढ़े जा सकें, इसके लिए इस कोड सैंपल में लाइन रिटर्न शामिल हैं: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
अनुरोध के मुख्य हिस्से का उदाहरण: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

अपडेट के अनुरोध के लिए, अपने अनुरोध में सिर्फ़ अपडेट की गई वैल्यू वाली प्रॉपर्टी शामिल करें.

अनुरोध स्वीकार होने पर, एचटीटीपी 200 स्टेटस कोड दिखता है. स्टेटस कोड के साथ-साथ रिस्पॉन्स, अपडेट किए गए Chrome डिवाइस के लिए प्रॉपर्टी दिखाता है.

Chrome डिवाइसों को इस्तेमाल से बाहर करना या बंद करना

Chrome डिवाइसों को इस्तेमाल से बाहर करने या बंद करने के लिए, यहां दिए गए POST अनुरोध का इस्तेमाल करें. साथ ही, अनुमति वाले अनुरोध में दी गई अनुमति को शामिल करें. आसानी से पढ़े जा सकें, इसके लिए इस कोड सैंपल में लाइन रिटर्न शामिल हैं: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/
devices/chromeos:batchChangeStatus

  • customerId, ग्राहक के Google खाते का यूनीक आइडेंटिफ़ायर होता है.
  • खाते के एडमिन के तौर पर, आपके पास my_customer स्ट्रिंग का इस्तेमाल करने का भी विकल्प होता है. यह स्ट्रिंग, आपके खाते की customerId के बारे में बताती है. customerId वैल्यू पाने का एक और तरीका, उपयोगकर्ता को वापस पाना कार्रवाई का इस्तेमाल करना है. कार्रवाई के userKey पाथ पैरामीटर में, अपने एडमिन ईमेल पते या अपने एडमिन के यूनीक उपयोगकर्ता id की वैल्यू का इस्तेमाल करें.

अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें.

JSON अनुरोध

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

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
किसी सैंपल को इस्तेमाल से बाहर करने के लिए, अनुरोध का मुख्य हिस्सा यह है: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
बंद करने के लिए अनुरोध का मुख्य हिस्सा: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

अनुरोध स्वीकार होने पर, एचटीटीपी 200 स्टेटस कोड दिखता है.

Chrome डिवाइसों को संगठन की इकाई में ले जाएं

किसी संगठन इकाई में ज़्यादा से ज़्यादा 50 Chrome डिवाइसों को ले जाने के लिए, यहां दिए गए POST अनुरोध का इस्तेमाल करें. साथ ही, अनुमति वाले अनुरोध में बताई गई अनुमति को शामिल करें. आसानी से पढ़े जा सकें, इसके लिए इस कोड सैंपल में लाइन रिटर्न शामिल हैं: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId, ग्राहक के Google खाते का यूनीक आइडेंटिफ़ायर होता है.
  • खाते के एडमिन के तौर पर, आपके पास my_customer स्ट्रिंग का इस्तेमाल करने का भी विकल्प होता है. यह स्ट्रिंग, आपके खाते की customerId के बारे में बताती है. customerId वैल्यू पाने का एक और तरीका है, उपयोगकर्ता को वापस पाना कार्रवाई का इस्तेमाल करना. कार्रवाई के userKey पाथ पैरामीटर में, अपने एडमिन ईमेल पते या अपने एडमिन के यूनीक उपयोगकर्ता id की वैल्यू का इस्तेमाल करें.

अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई का रेफ़रंस देखें.

JSON अनुरोध

नीचे दिया गया JSON अनुरोध, तीन Chrome डिवाइसों को /Marketing नाम वाली संगठन इकाई में ले जाने के अनुरोध का एक सैंपल दिखाता है: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/chromeos/moveDevicesToOu?orgUnitPath=/Marketing

डिवाइस को ट्रांसफ़र करने के लिए, अनुरोध का मुख्य हिस्सा यह है:

{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"]
}

अनुरोध स्वीकार होने पर, एचटीटीपी 200 स्टेटस कोड दिखता है.