نمونه‌های کد برای Chrome Management Chrome Browsers API

برای دیدن نمای کلی ویژگی‌های API، به Chrome Management Chrome Browsers API مراجعه کنید.

همه درخواست‌های نشان‌داده‌شده در این صفحه از متغیرهای زیر استفاده می‌کنند:

  • $TOKEN - کد OAuth 2.0
  • $CUSTOMER - شناسه مشتری یا my_customer تحت‌اللفظی

فهرست کردن مرورگرهای Chrome ثبت‌شده

برای فهرست کردن مرورگرهای Chrome ثبت‌شده، از نقطه پایانی /chromeBrowsers استفاده کنید. می‌توانید صفحه‌بندی را بااستفاده از پارامترهای pageSize (حداکثر و پیش‌فرض ۱۰۰) و pageToken کنترل کنید. از orderBy برای مشخص کردن ترتیب نتایج استفاده کنید. برای محدود کردن نتایج، filter را مشخص کنید. ماسک خواندن را می‌توان با پارامتر پُرسمان fields مشخص کرد.

تطابق نویسه عام (*) (پیشوند prefix*، پسوند *suffix، رشته فرعی *substring*، یا حضور *) با = و : فقط در فیلدهای machine_name، annotated_asset_id، و browser_version پشتیبانی می‌شود.

جستجوی نوشتار سراسری (بدون مشخص کردن نام فیلد) در همه فیلدهای نوشتاری نمایه‌شده جستجو می‌کند. وقتی چند عبارت با AND یا فاصله (برای مثال، filter=machine AND 73 یا filter=machine 73) ازهم جدا شده باشند، هر عبارت باید حداقل با یک فیلد نوشتاری نمایه‌شده در دستگاه مرورگر مطابقت داشته باشد (حتی در فیلدهای مختلف). قرار دادن چند کلمه در یک رشته نقل‌قول‌شده (برای مثال، filter="machine name") آن عبارت دقیق مجاور را در یک فیلد جستجو می‌کند.

نمونه پرسمان‌های فیلتر

# Filter by machine name prefix (using ':' or '=')
filter=machine_name:LIX*

# Filter by annotated asset ID suffix
filter=annotated_asset_id="*1001"

# Filter by browser version substring
filter=browser_version:"*6367*"

# Global search across all indexed text fields (matches browsers containing both "machine" and "73" across any fields)
filter=machine AND 73

# Global search with implicit AND (equivalent to `machine AND 73`)
filter=machine 73

# Filter by machine name prefix and registration time range
filter=machine_name:LIX* AND last_registration_time>=2024-01-01T00:00:00Z

# Filter by Organizational Unit path
filter=org_unit_path=/Marketing

درخواست

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers?pageSize=2&orderBy=lastActivityTime+desc&filter=os_platform=WINDOWS"

پاسخ

{
  "chromeBrowsers": [
    {
      "name": "customers/<customerId>/chromeBrowsers/<browserPermanentId1>",
      "browserPermanentId": "<browserPermanentId1>",
      "machineName": "CLIENT2024-01",
      "osPlatformType": "WINDOWS",
      "osVersion": "10.0.19045",
      "browserVersion": "124.0.6367.60",
      "annotatedUser": "user1@example.com",
      "annotatedLocation": "US-NYC",
      "annotatedAssetId": "ASSET-1001",
      "annotatedNotes": "Engineering workstation",
      "lastActivityTime": "2024-04-23T22:05:44.214362Z",
      "lastPolicySyncTime": "2024-04-23T22:00:00.000Z",
      "lastStatusReportTime": "2024-04-23T22:05:44.214362Z",
      "enrollmentDate": "2024-01-15T10:30:00.000Z",
      "orgUnitPath": "/Engineering",
      "policyCount": 15,
      "extensionCount": 8
    },
    {
      "name": "customers/<customerId>/chromeBrowsers/<browserPermanentId2>",
      "browserPermanentId": "<browserPermanentId2>",
      "machineName": "CLIENT2024-02",
      "osPlatformType": "WINDOWS",
      "osVersion": "11.0.22631",
      "browserVersion": "124.0.6367.60",
      "annotatedUser": "user2@example.com",
      "annotatedLocation": "US-MTV",
      "lastActivityTime": "2024-04-23T21:45:10.102000Z",
      "lastPolicySyncTime": "2024-04-23T21:40:00.000Z",
      "lastStatusReportTime": "2024-04-23T21:45:10.102000Z",
      "enrollmentDate": "2024-02-10T14:15:00.000Z",
      "orgUnitPath": "/Engineering",
      "policyCount": 12,
      "extensionCount": 5
    }
  ],
  "nextPageToken": "<nextPageToken>"
}

بازیابی «مرورگر Chrome تحت مدیریت»

برای بازیابی یک مرورگر Chrome ثبت‌شده، از نقطه پایانی /chromeBrowsers/{browser_permanent_id} استفاده کنید. ماسک خواندن را می‌توان با پارامتر fields مشخص کرد.

درخواست

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers/<browserPermanentId1>"

پاسخ

{
  "name": "customers/<customerId>/chromeBrowsers/<browserPermanentId1>",
  "browserPermanentId": "<browserPermanentId1>",
  "machineName": "CLIENT2024-01",
  "osPlatformType": "WINDOWS",
  "osVersion": "10.0.19045",
  "browserVersion": "124.0.6367.60",
  "annotatedUser": "user1@example.com",
  "annotatedLocation": "US-NYC",
  "annotatedAssetId": "ASSET-1001",
  "annotatedNotes": "Engineering workstation",
  "lastActivityTime": "2024-04-23T22:05:44.214362Z",
  "lastPolicySyncTime": "2024-04-23T22:00:00.000Z",
  "lastStatusReportTime": "2024-04-23T22:05:44.214362Z",
  "enrollmentDate": "2024-01-15T10:30:00.000Z",
  "orgUnitPath": "/Engineering",
  "policyCount": 15,
  "extensionCount": 8
}

به‌روزرسانی اطلاعات حاشیه‌نویسی برای مرورگر Chrome

برای به‌روزرسانی فیلدهای حاشیه‌نویسی‌شده مرورگر Chrome ثبت‌شده، از نقطه پایانی /chromeBrowsers/{browser_permanent_id} با روش HTTP PATCH استفاده کنید و پارامتر پُرسمان updateMask را برای مشخص کردن فیلدهای موردنظر برای به‌روزرسانی ارائه دهید.

درخواست

  curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers/<browserPermanentId1>?updateMask=annotatedUser,annotatedNotes" \
  -d '{
    "annotatedUser": "newuser@example.com",
    "annotatedNotes": "Updated primary workstation"
  }'

پاسخ

{
  "name": "customers/<customerId>/chromeBrowsers/<browserPermanentId1>",
  "browserPermanentId": "<browserPermanentId1>",
  "machineName": "CLIENT2024-01",
  "osPlatformType": "WINDOWS",
  "osVersion": "10.0.19045",
  "browserVersion": "124.0.6367.60",
  "annotatedUser": "newuser@example.com",
  "annotatedLocation": "US-NYC",
  "annotatedAssetId": "ASSET-1001",
  "annotatedNotes": "Updated primary workstation",
  "lastActivityTime": "2024-04-23T22:05:44.214362Z",
  "orgUnitPath": "/Engineering"
}

انتقال مرورگرهای Chrome به واحد سازمانی جدید

برای انتقال مرورگرهای Chrome مدیریت‌شده از یک «واحد سازمانی» به واحدی دیگر، از نقطه پایانی /chromeBrowsers:move استفاده کنید. در هر درخواست، حداکثر ۶۰۰ مرورگر را می‌توان منتقل کرد. اگر خطایی در انتقال هریک از مرورگرها وجود داشته باشد، هیچ‌کدام از مرورگرهای مشخص‌شده منتقل نمی‌شوند.

درخواست

  curl -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers:move" \
  -d '{
    "destinationOrgUnitId": "03ph8a2z3v",
    "resourceIds": [
      "customers/$CUSTOMER/chromeBrowsers/<browserPermanentId1>",
      "customers/$CUSTOMER/chromeBrowsers/<browserPermanentId2>"
    ]
  }'

پاسخ

{}

حذف داده‌های جمع‌آوری‌شده از مرورگر Chrome

برای حذف داده‌های جمع‌آوری‌شده از مرورگر Chrome مدیریت‌شده، از نقطه پایانی /chromeBrowsers/{browser_permanent_id} با HTTP DELETE استفاده کنید.

درخواست

  curl -X DELETE \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers/<browserPermanentId1>"

پاسخ

{}