نماذج الرموز لواجهة برمجة تطبيقات إدارة Chrome / تفاصيل الإضافات

زيارة الموقع واجهة برمجة التطبيقات لتفاصيل تطبيق إدارة Chrome للحصول على نظرة عامة حول ميزات واجهة برمجة التطبيقات.

تستخدِم جميع الطلبات الموضّحة أدناه المتغيّرات التالية:

  • $TOKEN - رمز OAuth 2 المميز
  • $CUSTOMER - رقم تعريف العميل أو الحرف my_customer

الحصول على تفاصيل حول أحد تطبيقات أو إضافات Chrome

لعرض تفاصيل حول تطبيق معيّن في Chrome، استخدِم نقطة نهاية /apps/chrome/{app_id}@{app_version}.

الطلب

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/apps/chrome/abcdefghijklmnopqrstuvwxyzabcdef@1.2.3"

الرد

{
    "name": "customers/<customer>/apps/chrome/abcdefghijklmnopqrstuvwxyzabcdef@1.2.3",
    "displayName": "Sample Google Chrome Extension",
    "description": "A sample Google Chrome extension.",
    "revisionId": "1.2.3",
    "type": "CHROME",
    "iconUri": "https://sample.chrome.extension.google.com/icon.png",
    "detailUri": "https://chrome.google.com/webstore/detail/abcdefghijklmnopqrstuvwxyzabcdef",
    "firstPublishTime": "2010-10-10T10:10:10.123456Z",
    "latestPublishTime": "2020-10-10T10:10:10.123456Z",
    "publisher": "sample.com",
    "homepageUri": "http://sample.chrome.extension.google.com/home",
    "reviewNumber": "10000",
    "reviewRating": 4.5,
    "chromeAppInfo": {
        "supportEnabled": false,
        "minUserCount": 6000000,
        "permissions": [
            {
                "type": "content_security_policy",
                "documentationUri": "https://developer.chrome.com/extensions/contentSecurityPolicy",
                "accessUserData": false
            },
            {
                "type": "contextmenus",
                "documentationUri": "https://developer.chrome.com/extensions/contextMenus",
                "accessUserData": false
            },
        ],
        "siteAccess": [
            {
                "hostMatch": "<all_urls>"
            }
        ],
        "isTheme": false,
        "googleOwned": true,
        "isCwsHosted": true
    }
}

الحصول على تفاصيل تطبيق Android

لعرض تفاصيل حول تطبيق Android معيّن، استخدم نقطة نهاية /apps/android/{app_id}@{app_version}.

الطلب

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/apps/android/com.google.android.sample@1.2.3"

الرد

{
    "name": "customers/<customer>/apps/android/com.google.android.sample@1.2.3",
    "displayName": "Sample Android App",
    "description": "A sample Android app.",
    "appId": "com.google.android.sample",
    "revisionId": "1.2.3",
    "type": "ANDROID",
    "iconUri": "https://sample.android.app.google.com/icon.png",
    "detailUri": "https://play.google.com/store/apps/details?id=com.google.android.sample",
    "firstPublishTime": "2010-10-10T10:10:10.123456Z",
    "latestPublishTime": "2020-10-10T10:10:10.123456Z",
    "publisher": "Google LLC",
    "isPaidApp": true,
    "homepageUri": "http://sample.android.app.google.com/home",
    "privacyPolicyUri": "http://sample.android.app.google.com/privacy",
    "reviewNumber": "10000",
    "reviewRating": 4.5,
    "androidAppInfo": {
        "permissions": [
            {
                "type": "android.permission.CAMERA"
            },
        ]
    }
}

الحصول على تفاصيل تطبيق ويب تقدّمي

للاطّلاع على تفاصيل عن تطبيق ويب Prgoressive معيّن، استخدِم نقطة نهاية /apps/web/{app_id}. يُرجى العِلم أنّ معرّف التطبيق هو الصفحة الرئيسية للتطبيق مرمّزًا بعنوان URL.

الطلب

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/apps/web/http%3A%2F%2Fsample.web.app.google.com%2F"

الرد

{
    "name": "customers/<customer>/apps/web/http%3A%2F%sample.web.app.google.com%2F",
    "displayName": "sample.web.app.google.com",
    "description": "A sample Progressive Web App.",
    "appId": "http://sample.web.app.google.com/",
    "type": "WEB",
    "iconUri": "http://sample.web.app.google.com/icon.png"
}

إدراج إضافات Chrome المطلوبة

لإدراج تطبيقات Chrome المطلوبة، استخدِم نقطة نهاية /apps:countChromeAppRequests.

الطلب

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/apps:countChromeAppRequests"

الرد

{
  "requestedApps": [
    {
      "appId": "abcdefghijklmnopqrstuvwxyzabcdef",
      "displayName": "Sample Google Chrome Extension",
      "appDetails": "customers/<customer>/apps/chrome/abcdefghijklmnopqrstuvwxyzabcdef",
      "iconUri": "https://sample.chrome.extension.google.com/icon.png",
      "detailUri": "https://chrome.google.com/webstore/detail/abcdefghijklmnopqrstuvwxyzabcdef",
      "requestCount": "1",
      "latestRequestTime": "2020-10-10T10:10:10.123456Z"
    },
  ],
  "totalSize": 1
}

اتّخاذ إجراءات بشأن طلبات الإضافات

لاتخاذ الإجراء المناسب بشأن طلبات التطبيق من المستخدمين النهائيين، عليك استخدام Chrome Policy API. اتّبِع دليل الإعداد للوصول إلى واجهة برمجة التطبيقات. بعد ذلك، ستتمكّن من تقديم طلبات إلى واجهة برمجة التطبيقات هذه لتنفيذ إجراءات مختلفة. يمكن العثور هنا على نماذج لتقديم الطلبات المتعلّقة بالتطبيقات. في ما يلي أمثلة على الإجراءات الشائعة التي يمكنك اتّخاذها عند طلب أحد التطبيقات.

الموافقة على طلب الإضافة للتثبيت اليدوي من قِبل المستخدم أو الأجهزة ضمن وحدة تنظيمية

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        requests: [{
                policyTargetKey: {
                        targetResource: "orgunits/04fatzly4jbjho9",
                        additionalTargetKeys: {"app_id": "chrome:abcdefghijklmnopqrstuvwxyzabcdef"}
                        },
                policyValue: {
                        policySchema: "chrome.users.apps.InstallType",
                        value: {appInstallType: "ALLOWED"}
                        },
                updateMask: {paths: "appInstallType"}
                }]
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchModify"

يجب أن يكون الرد الناجح فارغًا:

{}

رفض طلب الإضافة لجميع المستخدمين/الأجهزة ضمن وحدة تنظيمية

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        requests: [{
                policyTargetKey: {
                        targetResource: "orgunits/04fatzly4jbjho9",
                        additionalTargetKeys: {"app_id": "chrome:abcdefghijklmnopqrstuvwxyzabcdef"}
                        },
                policyValue: {
                        policySchema: "chrome.users.apps.InstallType",
                        value: {appInstallType: "BLOCKED"}
                        },
                updateMask: {paths: "appInstallType"}
                }]
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchModify"

يجب أن يكون الرد الناجح فارغًا:

{}

تثبيت الإضافة تلقائيًا لجميع المستخدمين/الأجهزة ضمن وحدة تنظيمية

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        requests: [{
                policyTargetKey: {
                        targetResource: "orgunits/04fatzly4jbjho9",
                        additionalTargetKeys: {"app_id": "chrome:abcdefghijklmnopqrstuvwxyzabcdef"}
                        },
                policyValue: {
                        policySchema: "chrome.users.apps.InstallType",
                        value: {appInstallType: "FORCED"}
                        },
                updateMask: {paths: "appInstallType"}
                }]
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchModify"

يجب أن يكون الرد الناجح فارغًا:

{}