Method: users.messages.batchModify

แก้ไขป้ายกำกับและค่าป้ายกำกับการแยกประเภทในข้อความที่ระบุ สำหรับผู้ดูแลระบบที่แก้ไขข้อความของผู้ใช้ในองค์กร คำขอต้องมีการให้สิทธิ์ด้วยบัญชีบริการที่มีสิทธิ์มอบสิทธิ์ทั่วทั้งโดเมนเพื่อแอบอ้างเป็นผู้ใช้ที่มีขอบเขตhttps://www.googleapis.com/auth/gmail.modify.restricted

คำขอ HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify

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

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

พารามิเตอร์
userId

string

อีเมลของผู้ใช้ คุณใช้ค่าพิเศษ me เพื่อระบุผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ได้

เนื้อหาคำขอ

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

การแสดง JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
ช่อง
ids[]

string

รหัสของข้อความที่จะแก้ไข คำขอ 1 รายการมีรหัสได้ไม่เกิน 1,000 รายการ
addLabelIds[]

string

รายการรหัสป้ายกำกับที่จะเพิ่มลงในข้อความ
removeLabelIds[]

string

รายการรหัสป้ายกำกับที่จะนำออกจากข้อความ
addClassificationLabels[]

object (ClassificationLabelValue)

รายการค่าป้ายกำกับการแยกประเภทที่จะเพิ่ม หากมีการใช้ป้ายกำกับการแยกประเภทที่มีรหัสป้ายกำกับเดียวกันกับข้อความอยู่แล้ว ระบบจะอัปเดตช่องที่มีรหัสช่องที่มีอยู่ และเพิ่มช่องที่มีรหัสช่องใหม่ คำขอ 1 รายการมีค่าป้ายกำกับการแยกประเภทได้ไม่เกิน 20 รายการ หากข้อความได้รับการแยกประเภทแล้วและจำนวนค่าป้ายกำกับการแยกประเภททั้งหมดสุดท้ายเกินจำนวนค่าป้ายกำกับการแยกประเภทสูงสุดที่อนุญาตต่อข้อความ การแก้ไขจะล้มเหลว
removeClassificationLabelIds[]

string

รายการค่าป้ายกำกับการแยกประเภทที่จะนำออกจากข้อความ

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นค่าว่าง

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.modify.restricted

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