Method: forms.batchUpdate

Thay đổi biểu mẫu bằng một loạt nội dung cập nhật.

Yêu cầu HTTP

POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
formId

string

Bắt buộc. Mã biểu mẫu.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "includeFormInResponse": boolean,
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Trường
includeFormInResponse

boolean

Liệu có trả về phiên bản cập nhật của mô hình trong phản hồi hay không.
requests[]

object (Request)

Bắt buộc. Các yêu cầu cập nhật của lô này.
writeControl

object (WriteControl)

Cung cấp quyền kiểm soát cách thực thi các yêu cầu ghi.

Nội dung phản hồi

Phản hồi cho một BatchUpdateFormRequest.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "form": {
    object (Form)
  },
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Trường
form

object (Form)

Dựa trên trường yêu cầu bool includeFormInResponse, hệ thống sẽ trả về một biểu mẫu có tất cả các đột biến/nội dung cập nhật đã áp dụng hay không. Mã này có thể trễ hơn mã sửa đổi được tạo bởi những thay đổi này.
replies[]

object (Response)

Nội dung trả lời về nội dung cập nhật. Phương thức này liên kết 1:1 với các yêu cầu cập nhật, mặc dù nội dung trả lời cho một số yêu cầu có thể trống.
writeControl

object (WriteControl)

Chế độ kiểm soát quyền ghi đã cập nhật sau khi áp dụng yêu cầu.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/forms.body

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

Yêu cầu

Các loại yêu cầu cập nhật có thể được thực hiện.

Biểu diễn dưới dạng JSON 
{

  // Union field kind can be only one of the following:
  "updateFormInfo": {
    object (UpdateFormInfoRequest)
  },
  "updateSettings": {
    object (UpdateSettingsRequest)
  },
  "createItem": {
    object (CreateItemRequest)
  },
  "moveItem": {
    object (MoveItemRequest)
  },
  "deleteItem": {
    object (DeleteItemRequest)
  },
  "updateItem": {
    object (UpdateItemRequest)
  }
  // End of list of possible types for union field kind.
}
Trường
Trường hợp hợp nhất kind. Loại yêu cầu. kind chỉ có thể là một trong những giá trị sau:
updateFormInfo

object (UpdateFormInfoRequest)

Cập nhật thông tin của biểu mẫu.
updateSettings

object (UpdateSettingsRequest)

Cập nhật chế độ cài đặt của Biểu mẫu.
createItem

object (CreateItemRequest)

Tạo một mục mới.
moveItem

object (MoveItemRequest)

Di chuyển một mục đến một vị trí đã chỉ định.
deleteItem

object (DeleteItemRequest)

Xoá một mục.
updateItem

object (UpdateItemRequest)

Cập nhật một mục.

UpdateFormInfoRequest

Cập nhật thông tin của biểu mẫu.

Biểu diễn dưới dạng JSON 
{
  "info": {
    object (Info)
  },
  "updateMask": string
}
Trường
info

object (Info)

Thông tin cần cập nhật.
updateMask

string (FieldMask format)

Bắt buộc. Chỉ những giá trị được đặt tên trong mặt nạ này mới thay đổi. Bạn phải chỉ định ít nhất một trường. info gốc được ngụ ý và không được chỉ định. Bạn có thể sử dụng một "*" để viết tắt việc cập nhật mọi trường.

Đây là danh sách tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

UpdateSettingsRequest

Cập nhật FormSettings của Biểu mẫu.

Biểu diễn dưới dạng JSON 
{
  "settings": {
    object (FormSettings)
  },
  "updateMask": string
}
Trường
settings

object (FormSettings)

Bắt buộc. Chế độ cài đặt cần cập nhật.
updateMask

string (FieldMask format)

Bắt buộc. Chỉ những giá trị được đặt tên trong mặt nạ này mới thay đổi. Bạn phải chỉ định ít nhất một trường. settings gốc được ngụ ý và không được chỉ định. Bạn có thể sử dụng một "*" để viết tắt việc cập nhật mọi trường.

Đây là danh sách tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

CreateItemRequest

Tạo một mục trong biểu mẫu.

Biểu diễn dưới dạng JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
Trường
item

object (Item)

Bắt buộc. Mục cần tạo.
location

object (Location)

Bắt buộc. Vị trí đặt mục mới.

Vị trí

Một vị trí cụ thể trong biểu mẫu.

Biểu diễn dưới dạng JSON 
{

  // Union field where can be only one of the following:
  "index": integer
  // End of list of possible types for union field where.
}
Trường
Trường hợp hợp nhất where. Bắt buộc. Chỉ định một vị trí trong biểu mẫu. where chỉ có thể là một trong những giá trị sau:
index

integer

Chỉ mục của một mục trong biểu mẫu. Giá trị này phải nằm trong phạm vi

[0..N)

, trong đó N là số mục trong biểu mẫu.

MoveItemRequest

Di chuyển một mục trong biểu mẫu.

Biểu diễn dưới dạng JSON 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
Trường
originalLocation

object (Location)

Bắt buộc. Vị trí của mục cần di chuyển.
newLocation

object (Location)

Bắt buộc. Vị trí mới của mặt hàng.

DeleteItemRequest

Xoá một mục trong biểu mẫu.

Biểu diễn dưới dạng JSON 
{
  "location": {
    object (Location)
  }
}
Trường
location

object (Location)

Bắt buộc. Vị trí của mục cần xoá.

UpdateItemRequest

Cập nhật một mục trong biểu mẫu.

Biểu diễn dưới dạng JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
Trường
item

object (Item)

Bắt buộc. Giá trị mới cho mục. Xin lưu ý rằng mã mặt hàng và mã câu hỏi sẽ được sử dụng nếu bạn cung cấp (và mã mặt hàng và mã câu hỏi nằm trong mặt nạ trường). Nếu một mã nhận dạng để trống (và trong mặt nạ trường), hệ thống sẽ tạo một mã nhận dạng mới. Điều này có nghĩa là bạn có thể sửa đổi một mục bằng cách lấy biểu mẫu thông qua forms.get, sửa đổi bản sao cục bộ của mục đó theo ý muốn và sử dụng UpdateItemRequest để ghi lại mục đó, với mã nhận dạng giống nhau (hoặc không có trong mặt nạ trường).
location

object (Location)

Bắt buộc. Vị trí xác định mục cần cập nhật.
updateMask

string (FieldMask format)

Bắt buộc. Chỉ những giá trị được đặt tên trong mặt nạ này mới thay đổi.

Đây là danh sách tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

WriteControl

Cung cấp quyền kiểm soát cách thực thi các yêu cầu ghi.

Biểu diễn dưới dạng JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Trường
Trường hợp hợp nhất control. Xác định bản sửa đổi của biểu mẫu mà các thay đổi sẽ được áp dụng và cách yêu cầu hoạt động nếu bản sửa đổi đó không phải là bản sửa đổi hiện tại của biểu mẫu. control chỉ có thể là một trong những giá trị sau:
requiredRevisionId

string

Mã sửa đổi của biểu mẫu mà yêu cầu ghi được áp dụng. Nếu đây không phải là bản sửa đổi mới nhất của biểu mẫu, yêu cầu sẽ không được xử lý và trả về lỗi 400 yêu cầu không hợp lệ.
targetRevisionId

string

Mã sửa đổi mục tiêu của biểu mẫu mà yêu cầu ghi được áp dụng.

Nếu có thay đổi sau bản sửa đổi này, thì các thay đổi trong yêu cầu cập nhật này sẽ được chuyển đổi theo các thay đổi đó. Điều này dẫn đến một bản sửa đổi mới của biểu mẫu kết hợp cả các thay đổi trong yêu cầu và các thay đổi can thiệp, trong đó máy chủ sẽ giải quyết các thay đổi xung đột.

Bạn chỉ có thể dùng mã bản sửa đổi mục tiêu để ghi vào các phiên bản gần đây của một biểu mẫu. Nếu bản sửa đổi mục tiêu quá xa bản sửa đổi mới nhất, yêu cầu sẽ không được xử lý và trả về mã 400 (Lỗi yêu cầu không hợp lệ). Bạn có thể thử lại yêu cầu sau khi đọc phiên bản mới nhất của biểu mẫu. Trong hầu hết trường hợp, mã sửa đổi mục tiêu vẫn hợp lệ trong vài phút sau khi được đọc, nhưng đối với các biểu mẫu thường xuyên được chỉnh sửa, khoảng thời gian này có thể ngắn hơn.

Phản hồi

Một phản hồi từ một nội dung cập nhật.

Biểu diễn dưới dạng JSON 
{

  // Union field kind can be only one of the following:
  "createItem": {
    object (CreateItemResponse)
  }
  // End of list of possible types for union field kind.
}
Trường
Trường hợp hợp nhất kind. Loại phản hồi. kind chỉ có thể là một trong những giá trị sau:
createItem

object (CreateItemResponse)

Kết quả của việc tạo một mục.

CreateItemResponse

Kết quả của việc tạo một mục.

Biểu diễn dưới dạng JSON 
{
  "itemId": string,
  "questionId": [
    string
  ]
}
Trường
itemId

string

Mã của mặt hàng đã tạo.
questionId[]

string

Mã của câu hỏi được tạo trong mục này. Đối với nhóm câu hỏi, mã này liệt kê mã của tất cả câu hỏi được tạo cho mục này.