จัดการกลุ่ม

หน้านี้จะอธิบายวิธีจัดการ Google Groups ด้วย Directory API

  • สร้างกลุ่ม
  • อัปเดตกลุ่ม
  • เพิ่มชื่อแทนของกลุ่ม
  • เรียกข้อมูลกลุ่ม
  • ดึงข้อมูลกลุ่มทั้งหมดสำหรับโดเมนหรือบัญชี
  • เรียกข้อมูลกลุ่มทั้งหมดของสมาชิก
  • เรียกข้อมูลชื่อแทนของกลุ่มทั้งหมด
  • ลบชื่อแทนของกลุ่ม
  • ลบกลุ่ม

สร้างกลุ่ม

หากต้องการสร้างกลุ่ม ให้ใช้POSTคำขอต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ คุณสร้างกลุ่มสำหรับโดเมนใดก็ได้ที่เชื่อมโยงกับบัญชี ดูสตริงการค้นหา คำขอ และพร็อพเพอร์ตี้การตอบกลับได้ที่เมธอด groups.insert 

POST https://admin.googleapis.com/admin/directory/v1/groups

คำขอ JSON ต่อไปนี้แสดงตัวอย่างเนื้อหาของคำขอที่สร้างกลุ่ม อีเมลของกลุ่มคือ sales_group@example.com 

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

การตอบกลับที่สำเร็จจะแสดงHTTP 201รหัสสถานะและพร็อพเพอร์ตี้สำหรับกลุ่มใหม่

อัปเดตกลุ่ม

หากต้องการอัปเดตการตั้งค่าของกลุ่ม ให้ใช้PUTคำขอต่อไปนี้และ รวมการให้สิทธิ์ที่อธิบายไว้ใน ให้สิทธิ์ คำขอ groupKey คืออีเมลของกลุ่ม อีเมลของอีเมลแทนของกลุ่ม หรือ id ที่ไม่ซ้ำกันของกลุ่ม ดูสตริงการค้นหา คำขอ และพร็อพเพอร์ตี้การตอบกลับได้ที่เมธอด groups.update

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey

โดยทั่วไป เราขอแนะนำไม่ให้ใช้อีเมลของกลุ่มเป็นคีย์ สำหรับข้อมูลถาวร เนื่องจากอีเมลอาจมีการเปลี่ยนแปลง

โดยทั่วไป เราขอแนะนำไม่ให้ใช้อีเมลของกลุ่มเป็นคีย์ สำหรับข้อมูลถาวร เนื่องจากอีเมลอาจมีการเปลี่ยนแปลง

ในตัวอย่างต่อไปนี้ groupKeyที่ไม่ซ้ำกันคือ nnn และชื่อกลุ่มคือ APAC Sales Group 

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

สำหรับคำขออัปเดต คุณเพียงแค่ต้องส่งข้อมูลที่อัปเดตแล้วในคำขอ คุณไม่จำเป็นต้องป้อนพร็อพเพอร์ตี้ทั้งหมดของกลุ่มในคำขอ

ด้วย

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ201 HTTP และพร็อพเพอร์ตี้สำหรับกลุ่มใหม่ ดังนี้ 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases": [
     {
        "alias": "liz@test.com"
     }
    ]
}

เพิ่มชื่อแทนของกลุ่ม

หากต้องการเพิ่มนามแฝงกลุ่ม ให้ใช้คำขอ POST ต่อไปนี้และ รวมการให้สิทธิ์ที่อธิบายไว้ใน ให้สิทธิ์ คำขอ groupKey คืออีเมลของกลุ่ม อีเมลของอีเมลแทนของกลุ่ม หรือ id ที่ไม่ซ้ำกันของกลุ่ม ดูสตริงการค้นหา คำขอ และพร็อพเพอร์ตี้การตอบกลับได้ที่ groups แหล่งข้อมูล

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

โดยทั่วไป Google ไม่แนะนำให้ใช้อีเมลของกลุ่มเป็นคีย์ สำหรับข้อมูลที่คงอยู่ เนื่องจากอีเมลอาจมีการเปลี่ยนแปลง

คำขอ JSON ต่อไปนี้แสดงคำขอตัวอย่างเพื่อสร้างชื่อแทนของกลุ่ม groupKey คือ id ที่ไม่ซ้ำกันของกลุ่มซึ่งแสดงโดย NNNN

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 201 และพร็อพเพอร์ตี้สำหรับนามแฝงกลุ่มใหม่

เรียกข้อมูลกลุ่ม

หากต้องการดึงข้อมูลกลุ่ม ให้ใช้คำขอ GET ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในให้สิทธิ์คำขอ groupKey คืออีเมลของกลุ่ม อีเมลของอีเมลแทนของกลุ่ม หรือ id ที่ไม่ซ้ำกันของกลุ่ม ดูสตริงการค้นหา คำขอ และพร็อพเพอร์ตี้การตอบกลับได้ที่เมธอด groups.get 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey

โดยทั่วไป Google ไม่แนะนำให้ใช้อีเมลของกลุ่มเป็นคีย์ สำหรับข้อมูลที่คงอยู่ เนื่องจากอีเมลอาจมีการเปลี่ยนแปลง

ในตัวอย่างต่อไปนี้ รหัส groupKey ที่ไม่ซ้ำกันคือ nnnn 

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ 200 HTTP และการตั้งค่าของกลุ่ม 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases": [
     {
        "alias": "liz@test.com"
     }
    ]
}

ดึงข้อมูลกลุ่มทั้งหมดสำหรับโดเมนหรือบัญชี

หากต้องการดึงข้อมูลกลุ่มทั้งหมดสำหรับโดเมนหรือบัญชีที่เฉพาะเจาะจง ให้ใช้คำขอ GET ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ ดูสตริงการค้นหา คำขอ และพร็อพเพอร์ตี้การตอบกลับได้ที่ เมธอด groups.list ตัวอย่างนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

เมื่อดึงข้อมูลกลุ่มทั้งหมดสำหรับโดเมนหรือบัญชี ให้พิจารณาสิ่งต่อไปนี้

  • กลุ่มทั้งหมดสำหรับโดเมนย่อย: ใช้อาร์กิวเมนต์ domain กับชื่อโดเมน
  • กลุ่มทั้งหมดสำหรับบัญชี: ใช้อาร์กิวเมนต์ customer กับ my_customer หรือค่า customerId ของบัญชี ในฐานะผู้ดูแลบัญชี ให้ใช้สตริง my_customer เพื่อแสดง customerId ของบัญชี หากคุณเป็นตัวแทนจำหน่าย ที่เข้าถึงบัญชีของลูกค้าที่ซื้อจากพาร์ทเนอร์ ให้ใช้ customerId ของบัญชีที่ซื้อจากพาร์ทเนอร์ สำหรับค่า customerId ให้ใช้ชื่อโดเมนหลักของบัญชีในคำขอของ การดำเนินการดึงข้อมูล ผู้ใช้ทั้งหมดในโดเมน การตอบกลับที่ได้จะมีค่า customerId
  • การใช้อาร์กิวเมนต์ domain และ customer Directory API จะแสดงกลุ่มทั้งหมดสำหรับ domain
  • ไม่ใช้อาร์กิวเมนต์ domain และ customer Directory API จะแสดงกลุ่มทั้งหมดสำหรับบัญชีที่เชื่อมโยง กับ my_customer นี่คือบัญชี customerId ของ ผู้ดูแลระบบที่ส่งคำขอ
  • การใช้อาร์กิวเมนต์ customer และ userKey พร้อมกัน Directory API จะแสดงข้อผิดพลาด คุณต้องส่งคำขอ 2 รายการแยกกัน โดยใช้อาร์กิวเมนต์เหล่านี้

ในตัวอย่างต่อไปนี้ ผู้ดูแลบัญชีใช้ my_customer เพื่อขอรายชื่อกลุ่มทั้งหมดของบัญชี

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

ในตัวอย่างต่อไปนี้ คำขอของผู้ดูแลระบบตัวแทนจำหน่ายจะแสดงกลุ่มทั้งหมด สำหรับบัญชีที่ขายต่อพร้อมกับ customerId C03az79cb ผลลัพธ์สูงสุดที่แสดงต่อหน้าการตอบกลับคือ 2 มีnextPageTokenสำหรับรายชื่อผู้ใช้ที่ติดตามในคำตอบนี้ 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP และกลุ่มตามลำดับตัวอักษรของอีเมลกลุ่ม ดังนี้200 

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support@sales.com",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "travel@sales.com",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "best_sales_group@example.com"
       }
      ],
      "nonEditableAliases": [
       {
         "alias": "liz@test.com"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

เรียกข้อมูลกลุ่มทั้งหมดของสมาชิก

หากต้องการดึงข้อมูลกลุ่มทั้งหมดที่สมาชิกมีการสมัครใช้บริการ ให้ใช้GETคำขอต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ ตัวอย่างนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
&pageToken=pagination token
&maxResults=maximum results per response page
  • สมาชิกอาจเป็นผู้ใช้หรือกลุ่มก็ได้
  • userKey อาจเป็นอีเมลหลักของผู้ใช้ อีเมลแทนของผู้ใช้ อีเมลหลักของกลุ่ม อีเมลแทนของกลุ่ม หรือidที่ไม่ซ้ำของผู้ใช้ ซึ่งดูได้โดยใช้การดำเนินการดึงข้อมูล ผู้ใช้
  • ผู้ใช้หรือกลุ่มที่ระบุใน userKey ต้องอยู่ในโดเมนของคุณ
  • ใช้สตริงการค้นหา pageToken สำหรับการตอบกลับที่มีกลุ่มจำนวนมาก ในกรณีของการแบ่งหน้า การตอบกลับจะแสดงพร็อพเพอร์ตี้ nextPageToken ซึ่งให้โทเค็นสำหรับผลการตอบกลับในหน้าถัดไป คำขอถัดไปจะใช้โทเค็นนี้เป็น ค่าสตริงการค้นหา pageToken
  • การใช้อาร์กิวเมนต์ customer และ userKey พร้อมกัน Directory API จะแสดงข้อผิดพลาด คุณต้องส่งคำขอ 2 รายการแยกกัน โดยใช้อาร์กิวเมนต์เหล่านี้

ดูพร็อพเพอร์ตี้ของคำขอและการตอบกลับได้ใน groups.list เมธอด

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 และรายการข้อมูลสมาชิก

  • ระบบจะแสดงกลุ่มทั้งหมดที่สมาชิกมีการสมัครใช้บริการ รวมถึงกลุ่มจากภายนอกโดเมนของผู้ใช้
  • ระบบจะแสดงกลุ่มตามลำดับตัวอักษรของอีเมลของแต่ละกลุ่ม
  • ในเนื้อหาของการตอบกลับ id คือรหัสที่ไม่ซ้ำกันของกลุ่ม
  • ในการตอบกลับ รายการกลุ่มจากภายนอกโดเมนของผู้ใช้ จะไม่รวมนามแฝงของกลุ่มภายนอก 
{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "sales_group@example.com",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPageToken": "NNNNN"
}

เรียกข้อมูลชื่อแทนของกลุ่มทั้งหมด

หากต้องการดึงข้อมูลนามแฝงทั้งหมดของกลุ่ม ให้ใช้คำขอ GET ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ใน คำขอสิทธิ์ groupKey อาจเป็นอีเมลหลักของกลุ่ม id ที่ไม่ซ้ำกันของกลุ่ม หรืออีเมลแทนของกลุ่ม ก็ได้ ดูพร็อพเพอร์ตี้คำขอและการตอบกลับได้ที่ groups แหล่งข้อมูล 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

การตอบกลับที่สำเร็จจะแสดงHTTP 201รหัสสถานะและรายการนามแฝงของกลุ่ม

ลบชื่อแทนของกลุ่ม

หากต้องการลบชื่อแทนของกลุ่ม ให้ใช้DELETEคำขอต่อไปนี้และ รวมการให้สิทธิ์ที่อธิบายไว้ใน ให้สิทธิ์ คำขอ groupKey อาจเป็นอีเมลหลักของกลุ่ม id ที่ไม่ซ้ำกันของกลุ่ม หรืออีเมลแทนของกลุ่ม ก็ได้ aliasId คือชื่อแทนที่กำลังจะถูกลบ ดูพร็อพเพอร์ตี้คำขอ และการตอบกลับได้ใน groups แหล่งข้อมูล 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 201

ลบกลุ่ม

หากต้องการลบกลุ่ม ให้ใช้คำขอ DELETE ต่อไปนี้และรวม การให้สิทธิ์ที่อธิบายไว้ใน ให้สิทธิ์ คำขอ groupKey คือ id ที่ไม่ซ้ำกันของกลุ่ม 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey

เช่น DELETE คำขอนี้จะลบกลุ่มที่มีnnnnกลุ่มidต่อไปนี้

DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200

เมื่อลบกลุ่มแล้ว ระบบจะดำเนินการต่อไปนี้

  • ระบบจะลบสมาชิกทั้งหมดในกลุ่ม ระบบจะไม่ลบบัญชีผู้ใช้ของสมาชิก
  • ระบบจะลบที่เก็บถาวรของกลุ่ม
  • ระบบจะไม่นำส่งข้อความที่ส่งไปยังอีเมลของกลุ่มที่ถูกลบ แต่ผู้ส่งจะได้รับข้อความตีกลับแทน