Method: contactGroups.update

อัปเดตชื่อของกลุ่มรายชื่อติดต่อที่มีอยู่ซึ่งเป็นของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

ชื่อกลุ่มรายชื่อติดต่อที่อัปเดตต้องไม่ซ้ำกับกลุ่มรายชื่อติดต่อของผู้ใช้ การพยายามสร้างกลุ่มที่มีชื่อซ้ำจะแสดงข้อผิดพลาด HTTP 409

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

คำขอ HTTP

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
contactGroup.resourceName

string

ชื่อทรัพยากรสำหรับกลุ่มรายชื่อติดต่อที่เซิร์ฟเวอร์กำหนด สตริง ASCII ในรูปแบบ contactGroups/{contactGroupId}

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
ช่อง
contactGroup.etag

string

แท็กเอนทิตี HTTP ของทรัพยากร ใช้สําหรับการตรวจสอบเว็บแคช
contactGroup.metadata

object (ContactGroupMetadata)

เอาต์พุตเท่านั้น ข้อมูลเมตาเกี่ยวกับกลุ่มรายชื่อติดต่อ
contactGroup.groupType

enum (GroupType)

เอาต์พุตเท่านั้น ประเภทกลุ่มรายชื่อติดต่อ
contactGroup.name

string

ชื่อกลุ่มรายชื่อติดต่อที่เจ้าของกลุ่มกำหนดหรือชื่อที่ระบบกำหนดสำหรับกลุ่มของระบบ

สำหรับ contactGroups.create หรือ contactGroups.update ชื่อต้องไม่ซ้ำกับกลุ่มรายชื่อติดต่อของผู้ใช้ การพยายามสร้างกลุ่มที่มีชื่อซ้ำจะแสดงข้อผิดพลาด HTTP 409
contactGroup.formattedName

string

เอาต์พุตเท่านั้น ชื่อจะแปลและจัดรูปแบบในภาษาของบัญชีหรือภาษาของส่วนหัว HTTP Accept-Language สำหรับชื่อกลุ่มระบบ ชื่อกลุ่มที่เจ้าของตั้งเหมือนกับชื่อ
contactGroup.memberResourceNames[]

string

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

integer

เอาต์พุตเท่านั้น จำนวนรายชื่อติดต่อทั้งหมดในกลุ่มโดยไม่คำนึงถึงจำนวนสมาชิกสูงสุดที่ระบุไว้ในคำขอ
contactGroup.clientData[]

object (GroupClientData)

ข้อมูลไคลเอ็นต์ของกลุ่ม
updateGroupFields

string (FieldMask format)

ไม่บังคับ มาสก์ของช่องเพื่อจํากัดการอัปเดตช่องในกลุ่ม คุณสามารถระบุหลายฟิลด์ได้โดยคั่นด้วยเครื่องหมายคอมมา ค่าเริ่มต้นเป็น name หากไม่ได้ตั้งค่าหรือตั้งค่าเป็นว่างเปล่า แทนที่ช่องที่อัปเดต ค่าที่ใช้ได้มีดังนี้

  • clientData
  • ชื่อ
readGroupFields

string (FieldMask format)

ไม่บังคับ มาสก์ฟิลด์เพื่อจำกัดการแสดงผลฟิลด์ในกลุ่ม ค่าเริ่มต้นเป็น metadata, groupType และ name หากไม่ได้ตั้งค่าหรือตั้งค่าเป็นว่างเปล่า ช่องที่ถูกต้องมีดังนี้

  • clientData
  • groupType
  • memberCount
  • ข้อมูลเมตา
  • ชื่อ

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ ContactGroup

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/contacts

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์