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
  • ความสนใจ
  • locales
  • สถานที่ตั้ง
  • ของช่อง
  • miscKeywords
  • names
  • ชื่อเล่น
  • อาชีพ
  • organizations
  • phoneNumbers
  • ความสัมพันธ์
  • sipAddresses
  • urls
  • userDefined
readMask

string (FieldMask format)

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

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

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