Connectors API के लिए कोड सैंपल

एपीआई की सुविधाओं के बारे में जानने के लिए, Connectors API देखें.

इस पेज पर मौजूद सभी अनुरोध, इन वैरिएबल का इस्तेमाल करते हैं:

• $TOKEN - OAuth 2.0 टोकन
• $CUSTOMER - ग्राहक का आईडी या लिटरल my_customer
• $PAGE_TOKEN - पिछले पेज के जवाबों से मिला पेज टोकन
• $CONNECTOR_CONFIG_ID - कनेक्टर कॉन्फ़िगरेशन का आईडी. जनरेट किए गए आईडी, कैपिटल लेटर वाले यूयूआईडी के फ़ॉर्म में होते हैं. उदाहरण के लिए, 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) क्वेरी पैरामीटर सेट करके, कस्टम आईडी दिया जा सकता है. हालांकि, यह ज़रूरी नहीं है. अगर कोई आईडी नहीं दिया जाता है, तो सर्वर, कैपिटल लेटर वाला यूयूआईडी जनरेट करेगा.

अनुरोध

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

दूसरा उदाहरण: कोई अपडेट मास्क नहीं है (अनुरोध में मौजूद सभी फ़ील्ड अपडेट करता है)

अगर अनुरोध क्वेरी स्ट्रिंग से 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"
  }
}

तीसरा उदाहरण: * का अपडेट मास्क (पूरी तरह से बदलना)

सेटिंग 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"

जवाब

{}