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
  • name
readGroupFields

string (FieldMask format)

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

  • ClientData
  • ประเภทกลุ่ม
  • จํานวนสมาชิก
  • ข้อมูลเมตา
  • name

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

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

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

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

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

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