عيّنات التعليمات البرمجية لواجهة Connectors API

اطّلِع على Connectors API للحصول على معلومات حول ميزات واجهة برمجة التطبيقات.

تستخدِم جميع الطلبات في هذه الصفحة المتغيّرات التالية:

• ‫$TOKEN - رمز OAuth 2.0 المميز
• ‫$CUSTOMER - معرّف العميل أو القيمة الحرفية my_customer
• ‫$PAGE_TOKEN: الرمز المميز للصفحة الذي تم الحصول عليه من ردود الصفحة السابقة
• استبدِل $CONNECTOR_CONFIG_ID برقم تعريف إعدادات الموصّل. تكون المعرّفات التي يتم إنشاؤها على شكل معرّفات فريدة عالميًا (UUID) بأحرف كبيرة (على سبيل المثال، 550E8400-E29B-41D4-A716-446655440000).

إدراج إعدادات الموصل

لعرض قائمة بإعدادات الموصل لنطاق العميل، استخدِم الطريقة list. يمكنك اختياريًا تقديم مَعلمتَي طلب البحث page_size (أو pageSize) وpage_token (أو pageToken) عند تقسيم النتائج إلى صفحات:

• ‫page_size / pageSize: الحدّ الأقصى لعدد إعدادات الموصل التي سيتم عرضها. حجم الصفحة التلقائي هو 50 إذا لم يتم تحديد حجم، والحد الأقصى هو 100.
• page_token / pageToken: رمز مميّز للصفحة تم تلقّيه من طلب list سابق.

طلب

curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs?page_size=50&page_token=$PAGE_TOKEN"

الردّ

{
  "connectorConfigs": [
    {
      "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
      "displayName": "Configuration 1",
      "type": "REPORTING",
      "details": {
        "googleSecOpsConfig": {
          "host": "example.googlesecops.com",
          "reportingSettings": {
            "enabledDefaultEvents": [
              "ALL_DEFAULT_EVENTS"
            ],
            "enabledOptInEvents": [
              "PASSWORD_BREACH_EVENT",
              "URL_NAVIGATION_EVENT"
            ],
            "enabledDeviceEvents": [
              "ALL_DEVICE_EVENTS"
            ]
          }
        }
      },
      "status": {
        "state": "ENABLED"
      }
    }
  ],
  "nextPageToken": "<next_page_token>"
}

الحصول على إعدادات ضبط موصّل

لاسترداد إعدادات موصّل معيّن حسب المعرّف، استخدِم طريقة get.

طلب

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

الردّ

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "Configuration 1",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledDefaultEvents": [
          "ALL_DEFAULT_EVENTS"
        ],
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT",
          "URL_NAVIGATION_EVENT"
        ],
        "enabledDeviceEvents": [
          "ALL_DEVICE_EVENTS"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

إنشاء إعدادات الموصل

لإنشاء إعدادات موصِّل جديدة لنطاق العميل، استخدِم طريقة create. يمكنك اختياريًا تقديم معرّف مخصّص من خلال ضبط مَعلمة طلب البحث connector_config_id (أو connectorConfigId). في حال عدم توفير معرّف، سينشئ الخادم معرّفًا فريدًا عالميًا (UUID) بأحرف كبيرة.

طلب

curl -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Configuration 1",
    "type": "REPORTING",
    "details": {
      "googleSecOpsConfig": {
        "apiKey": "api-key",
        "host": "example.googlesecops.com",
        "reportingSettings": {
          "enabledDefaultEvents": [
            "ALL_DEFAULT_EVENTS"
          ],
          "enabledOptInEvents": [
            "PASSWORD_BREACH_EVENT"
          ],
          "enabledDeviceEvents": [
            "ALL_DEVICE_EVENTS"
          ]
        }
      }
    }
  }' \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs?connector_config_id=$CONNECTOR_CONFIG_ID"

الردّ

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "Configuration 1",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledDefaultEvents": [
          "ALL_DEFAULT_EVENTS"
        ],
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT"
        ],
        "enabledDeviceEvents": [
          "ALL_DEVICE_EVENTS"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

تعديل إعدادات موصّل

يمكن تعديل إعدادات الموصل بإحدى الطرق التالية:

• عدم توفّر قناع تعديل: في حال عدم توفير مَعلمة طلب البحث updateMask، سيتم تعديل جميع الحقول التي تم ضبطها في الطلب.
• باستخدام قناع التعديل: إذا تم تحديد مَعلمة طلب البحث updateMask، سيتم تعديل الحقول المُدرَجة في القناع فقط.
• باستخدام قناع التعديل الذي يتوافق مع *: إذا تم ضبط updateMask على *، سيتم التعامل مع التعديل على أنّه استبدال كامل (أي ما يعادل عملية الإنشاء).

المثال 1: استهداف قناع التعديل فقط displayName

في هذا الخيار، يضمن توفير updateMask=displayName تعديل displayName فقط، حتى إذا تم توفير حقول إضافية في النص الأساسي.

طلب

curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Updated name"
  }' \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID?updateMask=displayName"

الردّ

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "Updated name",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledDefaultEvents": [
          "BROWSER_EXTENSION_INSTALL_EVENT"
        ],
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT"
        ],
        "enabledDeviceEvents": [
          "LOGIN_LOGOUT_EVENT"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

المثال 2: عدم توفّر قناع تعديل (يعدّل جميع الحقول في الطلب)

في حال حذف updateMask من سلسلة طلب البحث، سيتم تعديل جميع الحقول المقدَّمة في حمولة JSON.

طلب

curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Updated again",
    "details": {
      "googleSecOpsConfig": {
        "reportingSettings": {
          "enabledDefaultEvents": [
            "BROWSER_EXTENSION_INSTALL_EVENT",
            "CONTENT_TRANSFER_EVENT",
            "CONTENT_UNSCANNED_EVENT",
            "DATA_ACCESS_CONTROL_EVENT",
            "MALWARE_TRANSFER_EVENT"
          ]
        }
      }
    }
  }' \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID"

الردّ

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "Updated again",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledDefaultEvents": [
          "BROWSER_EXTENSION_INSTALL_EVENT",
          "CONTENT_TRANSFER_EVENT",
          "CONTENT_UNSCANNED_EVENT",
          "DATA_ACCESS_CONTROL_EVENT",
          "MALWARE_TRANSFER_EVENT"
        ],
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT"
        ],
        "enabledDeviceEvents": [
          "ALL_DEVICE_EVENTS"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

المثال 3: قناع التعديل * (استبدال كامل)

يستبدل الإعداد updateMask=* التهيئة الحالية بالكامل بالحِمل المقدَّم في نص الطلب.

طلب

curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "New Updated Display Name",
    "type": "REPORTING",
    "details": {
      "googleSecOpsConfig": {
        "apiKey": "api-key",
        "host": "example.googlesecops.com",
        "reportingSettings": {
          "enabledOptInEvents": [
            "PASSWORD_BREACH_EVENT"
          ]
        }
      }
    }
  }' \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID?updateMask=*"

الردّ

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "New Updated Display Name",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

حذف إعدادات موصِّل

لحذف إعدادات أداة ربط، استخدِم طريقة delete.

طلب

curl -X DELETE \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID"

الردّ

{}