Method: forms.batchUpdate

Wprowadź zmiany w formularzu partiami aktualizacji.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
formId

string

To pole jest wymagane. Identyfikator formularza.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "includeFormInResponse": boolean,
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Pola
includeFormInResponse

boolean

Określa, czy w odpowiedzi zwrócić zaktualizowaną wersję modelu.
requests[]

object (Request)

To pole jest wymagane. Żądania aktualizacji tego wsadu.
writeControl

object (WriteControl)

Zapewnia kontrolę nad sposobem wykonywania żądań zapisu.

Treść odpowiedzi

Odpowiedź na żądanie BatchUpdateFormRequest.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "form": {
    object (Form)
  },
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Pola
form

object (Form)

W zależności od pola żądania wartości logicznej includeFormInResponse zwracany jest formularz ze wszystkimi zastosowanymi mutacjami/aktualizacjami. Ta wartość może być późniejsza niż identyfikator wersji utworzony przez te zmiany.
replies[]

object (Response)

Odpowiedź na aktualizacje. Żądania aktualizacji są mapowane 1:1, chociaż odpowiedzi na niektóre prośby mogą być puste.
writeControl

object (WriteControl)

Zaktualizowana kontrola zapisu po zastosowaniu żądania.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

Prośba

Rodzaje żądań aktualizacji, jakie można wysłać.

Zapis 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.
}
Pola
Pole sumy kind. Rodzaj żądania. kind może mieć tylko jedną z tych wartości:
updateFormInfo

object (UpdateFormInfoRequest)

Zaktualizuj informacje formularza.
updateSettings

object (UpdateSettingsRequest)

Aktualizuje ustawienia formularza.
createItem

object (CreateItemRequest)

Tworzenie nowego elementu.
moveItem

object (MoveItemRequest)

Przenieść element do określonej lokalizacji.
deleteItem

object (DeleteItemRequest)

Usuń element.
updateItem

object (UpdateItemRequest)

Zaktualizuj element.

UpdateFormInfoRequest

Zaktualizuj informacje formularza.

Zapis JSON 
{
  "info": {
    object (Info)
  },
  "updateMask": string
}
Pola
info

object (Info)

Informacje do zaktualizowania.
updateMask

string (FieldMask format)

To pole jest wymagane. Zmienione zostaną tylko wartości wymienione w tej masce. Musisz określić co najmniej jedno pole. Element główny info jest domniemany i nie należy go określać. Pojedyncza właściwość "*" może służyć jako skrót do aktualizowania każdego pola.

Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

UpdateSettingsRequest

Zaktualizuj pole FormSettings formularza.

Zapis JSON 
{
  "settings": {
    object (FormSettings)
  },
  "updateMask": string
}
Pola
settings

object (FormSettings)

To pole jest wymagane. Ustawienia, których dotyczy aktualizacja.
updateMask

string (FieldMask format)

To pole jest wymagane. Zmienione zostaną tylko wartości wymienione w tej masce. Musisz określić co najmniej jedno pole. Element główny settings jest domniemany i nie należy go określać. Pojedyncza właściwość "*" może służyć jako skrót do aktualizowania każdego pola.

Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

CreateItemRequest

Utwórz element w formularzu.

Zapis JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
Pola
item

object (Item)

To pole jest wymagane. Element do utworzenia.
location

object (Location)

To pole jest wymagane. Gdzie umieścić nowy element.

Lokalizacja

Określona lokalizacja w formularzu.

Zapis JSON 
{

  // Union field where can be only one of the following:
  "index": integer
  // End of list of possible types for union field where.
}
Pola
Pole sumy where. To pole jest wymagane. Określ lokalizację w formularzu. where może mieć tylko jedną z tych wartości:
index

integer

Indeks elementu w formularzu. Musi się mieścić w zakresie

[0..N)

, gdzie N to liczba elementów formularza.

MoveItemRequest

Przenoszenie elementu formularza.

Zapis JSON 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
Pola
originalLocation

object (Location)

To pole jest wymagane. Lokalizacja elementu do przeniesienia.
newLocation

object (Location)

To pole jest wymagane. Nowa lokalizacja elementu.

DeleteItemRequest

Usuwanie elementu formularza.

Zapis JSON 
{
  "location": {
    object (Location)
  }
}
Pola
location

object (Location)

To pole jest wymagane. Lokalizacja elementu do usunięcia.

UpdateItemRequest

Aktualizowanie elementu w formularzu.

Zapis JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
Pola
item

object (Item)

To pole jest wymagane. Nowe wartości elementu. Identyfikatory pytań i elementów są używane, jeśli zostały podane (i znajdują się w masce pola). Jeśli identyfikator jest pusty (i w masce pola), zostanie wygenerowany nowy identyfikator. Oznacza to, że możesz zmodyfikować element przez pobranie formularza za pomocą forms.get, zmodyfikowanie lokalnej kopii produktu zgodnie z oczekiwaniami i zapisanie go za pomocą UpdateItemRequest przy zachowaniu tych samych identyfikatorów (lub braku w masce pola).
location

object (Location)

To pole jest wymagane. Lokalizacja identyfikująca element do zaktualizowania.
updateMask

string (FieldMask format)

To pole jest wymagane. Zmienione zostaną tylko wartości wymienione w tej masce.

Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

WriteControl

Zapewnia kontrolę nad sposobem wykonywania żądań zapisu.

Zapis 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.
}
Pola
Pole sumy control. Określa wersję formularza, z której mają zostać zastosowane zmiany, oraz sposób działania żądania, jeśli dana wersja nie jest bieżącą wersją formularza. control może mieć tylko jedną z tych wartości:
requiredRevisionId

string

Identyfikator wersji formularza, do którego zastosowano żądanie zapisu. Jeśli nie jest to najnowsza wersja formularza, żądanie nie zostanie przetworzone i zwrócony zostanie błąd 400 „Nieprawidłowe żądanie”.
targetRevisionId

string

Identyfikator docelowej wersji formularza, do której zastosowano żądanie zapisu.

Jeśli po tej wersji wprowadzono zmiany, zmiany wprowadzone w tym żądaniu aktualizacji zostaną przekształcone w odpowiedzi na te zmiany. Spowoduje to utworzenie nowej wersji formularza, która obejmuje zarówno zmiany wprowadzone w żądaniu, jak i wprowadzane w nich zmiany, a serwer rozstrzygnie sprzeczne zmiany.

Identyfikatora wersji docelowej można używać tylko do zapisywania w najnowszych wersjach formularzy. Jeśli wersja docelowa jest zbyt daleko w tyle do najnowszej wersji, żądanie nie zostanie przetworzone i zwróci błąd 400 (Bad Request Error). Po przeczytaniu najnowszej wersji formularza można ponowić prośbę. W większości przypadków identyfikator wersji docelowej zachowuje ważność przez kilka minut po odczytaniu, ale w przypadku często edytowanych formularzy to okno może być krótsze.

Odpowiedź

Pojedyncza odpowiedź z aktualizacji.

Zapis JSON 
{

  // Union field kind can be only one of the following:
  "createItem": {
    object (CreateItemResponse)
  }
  // End of list of possible types for union field kind.
}
Pola
Pole sumy kind. Rodzaj reakcji. kind może mieć tylko jedną z tych wartości:
createItem

object (CreateItemResponse)

Wynik utworzenia elementu.

CreateItemResponse

Wynik utworzenia elementu.

Zapis JSON 
{
  "itemId": string,
  "questionId": [
    string
  ]
}
Pola
itemId

string

Identyfikator utworzonego elementu.
questionId[]

string

Identyfikator pytania utworzonego w ramach tego elementu. W przypadku grupy pytań zawiera on identyfikatory wszystkich pytań utworzonych na potrzeby tego elementu.