Method: people.batchUpdateContacts

อัปเดตกลุ่มรายชื่อติดต่อและแสดงผลแผนที่ชื่อทรัพยากรเป็น PersonResponses สําหรับรายชื่อติดต่อที่อัปเดต

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

คำขอ HTTP

POST https://people.googleapis.com/v1/people:batchUpdateContacts

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

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

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

การแสดง JSON
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
ช่อง
contacts

map (key: string, value: object (Person))

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

ออบเจ็กต์ที่มีรายการคู่คู่ "key": value ตัวอย่าง: { "name": "wrench", "mass": "1.3kg", "count": "3" }

updateMask

string (FieldMask format)

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

  • ที่อยู่
  • ชีวประวัติ
  • วันเกิด
  • URL ของปฏิทิน
  • ClientData
  • อีเมล
  • กิจกรรม
  • รหัสภายนอก
  • เพศ
  • imClients
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • คีย์เวิร์ดเบ็ดเตล็ด
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • หมายเลขโทรศัพท์
  • ความสัมพันธ์
  • ที่อยู่ SIP
  • URL
  • ผู้ใช้กําหนด
readMask

string (FieldMask format)

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

  • ที่อยู่
  • ช่วงอายุ
  • ชีวประวัติ
  • วันเกิด
  • URL ของปฏิทิน
  • ClientData
  • รูปภาพปก
  • อีเมล
  • กิจกรรม
  • รหัสภายนอก
  • เพศ
  • imClients
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • คีย์เวิร์ดเบ็ดเตล็ด
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • หมายเลขโทรศัพท์
  • รูปภาพ
  • ความสัมพันธ์
  • ที่อยู่ SIP
  • ทักษะ
  • URL
  • ผู้ใช้กําหนด
sources[]

enum (ReadSourceType)

ไม่บังคับ มาสก์ประเภทต้นทางที่จะแสดงผล ค่าเริ่มต้นจะเป็น READ_SOURCE_TYPE_CONTACT และ READ_SOURCE_TYPE_PROFILE หากไม่ได้ตั้งค่าไว้

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

หากไม่สําเร็จ แสดงผล BatchUpdateContactsErrorDetails ซึ่งเป็นรายการข้อผิดพลาดที่เกี่ยวข้องกับรายชื่อติดต่อแต่ละรายการ

การตอบกลับคําขอเพื่ออัปเดตกลุ่มรายชื่อติดต่อ

การแสดง JSON
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
ช่อง
updateResult

map (key: string, value: object (PersonResponse))

แผนที่ชื่อทรัพยากรกับรายชื่อติดต่อที่อัปเดตแล้ว เว้นแต่ว่าคําขอ readMask ว่างเปล่า

ออบเจ็กต์ที่มีรายการคู่คู่ "key": value ตัวอย่าง: { "name": "wrench", "mass": "1.3kg", "count": "3" }

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

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

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

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