Method: forms.batchUpdate

Wprowadź w formularzu serię 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

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)

Wymagane. Żądania aktualizacji tej grupy.

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)

Na podstawie pola żądania logicznego includeFormInResponse zwracany jest formularz ze wszystkimi zastosowanymi mutacjami lub aktualizacjami. Może on być późniejszy niż identyfikator wersji utworzony w wyniku tych zmian.

replies[]

object (Response)

Odpowiedź na aktualizacje. Wynika z tego 1:1 żądania aktualizacji, chociaż odpowiedzi na niektóre z nich mogą być puste.

writeControl

object (WriteControl)

Zaktualizowany element sterujący zapisu po zastosowaniu żądania.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.

Żądanie

Rodzaje możliwych żądań aktualizacji.

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 prośby. kind może mieć tylko jedną z tych wartości:
updateFormInfo

object (UpdateFormInfoRequest)

Zaktualizuj dane 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 dane formularza.

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

object (Info)

Informacje do zaktualizowania.

updateMask

string (FieldMask format)

Wymagane. Zmieniane są tylko wartości nazwane w tej masce. Musisz określić co najmniej jedno pole. Poziom główny info jest domniemany i nie należy go określać. Pojedynczych pól "*" można używać jako skrótów służących do aktualizowania każdego pola.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".

UpdateSettingsRequest

Zaktualizuj pole FormSettings formularza.

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

object (FormSettings)

Wymagane. Ustawienia używane do aktualizacji.

updateMask

string (FieldMask format)

Wymagane. Zmieniane są tylko wartości nazwane w tej masce. Musisz określić co najmniej jedno pole. Poziom główny settings jest domniemany i nie należy go określać. Pojedynczych pól "*" można używać jako skrótów służących do aktualizowania każdego pola.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych 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)

Wymagane. Element do utworzenia.

location

object (Location)

Wymagane. Miejsce umieszczenia nowego elementu.

Lokalizacja

Konkretne miejsce 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. 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

Przenieś element w formularzu.

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

object (Location)

Wymagane. Lokalizacja elementu do przeniesienia.

newLocation

object (Location)

Wymagane. Nowa lokalizacja elementu.

DeleteItemRequest

Usuwanie elementu w formularzu.

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

object (Location)

Wymagane. Lokalizacja elementu do usunięcia.

UpdateItemRequest

Zaktualizuj element w formularzu.

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

object (Item)

Wymagane. Nowe wartości dla elementu. Pamiętaj, że używane są identyfikatory elementów i pytań, o ile są podane (i znajdują się w masce pola). Jeśli identyfikator jest pusty (i w masce pola), jest generowany nowy identyfikator. Oznacza to, że możesz zmodyfikować element, pobierając formularz z elementu forms.get, modyfikując lokalną kopię elementu zgodnie ze swoimi potrzebami i korzystając z UpdateItemRequest w celu odpisania elementu. Identyfikatory muszą być takie same (lub nie znajdować się w masce pola).

location

object (Location)

Wymagane. Lokalizacja identyfikująca element, który ma zostać zaktualizowany.

updateMask

string (FieldMask format)

Wymagane. Zmieniane są tylko wartości nazwane w tej masce.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych 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órego mają zostać zastosowane zmiany, oraz sposób zachowania żądania, jeśli ta 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 prośbę o zapis. Jeśli nie jest to najnowsza wersja formularza, żądanie nie zostanie przetworzone i zwróci błąd 400.

targetRevisionId

string

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

Jeśli po tej wersji wprowadzono jakieś zmiany, zmiany w tej prośbie o aktualizację zostaną uwzględnione w tych zmianach. Spowoduje to utworzenie nowej wersji formularza, która będzie uwzględniać zarówno zmiany z żądania, jak i odpowiadające im zmiany, przy czym serwer usunie sprzeczne zmiany.

Identyfikatora wersji docelowej można używać tylko do zapisywania najnowszych wersji formularza. Jeśli wersja docelowa jest zbyt daleko w stosunku do najnowszej wersji, żądanie nie zostanie przetworzone i zwróci błąd 400 (Nieprawidłowe żądanie). Po przeczytaniu najnowszej wersji formularza możesz spróbować ponownie. W większości przypadków identyfikator wersji docelowej pozostaje ważny 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 tworzenia elementu.

CreateItemResponse

Wynik tworzenia 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 identyfikator wszystkich pytań utworzonych na potrzeby tego elementu.