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)

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

  • ที่อยู่
  • ชีวประวัติ
  • วันเกิด
  • calendarUrls
  • clientData
  • emailAddresses
  • กิจกรรม
  • externalIds
  • เพศ
  • imClients
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • miscKeywords
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • phoneNumbers
  • ความสัมพันธ์
  • sipAddresses
  • URL
  • userDefined
readMask

string (FieldMask format)

ต้องระบุ มาสก์ของช่องเพื่อจำกัดการแสดงผลช่องของผู้ใช้แต่ละคน คุณสามารถระบุหลายฟิลด์ได้โดยคั่นด้วยเครื่องหมายคอมมา หาก Read Mask เว้นว่างไว้ ระบบจะข้าม Post-Mutate-get และจะไม่มีการแสดงผลข้อมูลใดๆ ในการตอบกลับ ค่าที่ใช้ได้มีดังนี้

  • ที่อยู่
  • ageRanges
  • ชีวประวัติ
  • วันเกิด
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • กิจกรรม
  • externalIds
  • เพศ
  • imClients
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • miscKeywords
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • phoneNumbers
  • รูปภาพ
  • ความสัมพันธ์
  • sipAddresses
  • ทักษะ
  • URL
  • userDefined
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

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