จัดการกลุ่ม

หน้านี้เกี่ยวข้องกับวิธีจัดการ 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

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

ในตัวอย่างต่อไปนี้ groupKey ที่ไม่ซ้ำกันคือ nnn และ ชื่อของกลุ่มฝ่ายขายประจำภูมิภาคเอเชียแปซิฟิก: 

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

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

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

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

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

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

{
    "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"
     }
  ],
   "nextPakeToken": "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

เมื่อลบกลุ่มแล้ว สิ่งต่อไปนี้จะเกิดขึ้น

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