- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Prośba
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- Lokalizacja
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- Odpowiedź
- CreateItemResponse
- Wypróbuj
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 |
To pole jest wymagane. Identyfikator formularza. |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
Pola | |
---|---|
includeFormInResponse |
Określa, czy w odpowiedzi zwrócić zaktualizowaną wersję modelu. |
requests[] |
To pole jest wymagane. Żądania aktualizacji tego wsadu. |
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 ( |
Pola | |
---|---|
form |
W zależności od pola żądania wartości logicznej |
replies[] |
Odpowiedź na aktualizacje. Żądania aktualizacji są mapowane 1:1, chociaż odpowiedzi na niektóre prośby mogą być puste. |
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 |
Pola | |
---|---|
Pole sumy kind . Rodzaj żądania. kind może mieć tylko jedną z tych wartości: |
|
updateFormInfo |
Zaktualizuj informacje formularza. |
updateSettings |
Aktualizuje ustawienia formularza. |
createItem |
Tworzenie nowego elementu. |
moveItem |
Przenieść element do określonej lokalizacji. |
deleteItem |
Usuń element. |
updateItem |
Zaktualizuj element. |
UpdateFormInfoRequest
Zaktualizuj informacje formularza.
Zapis JSON |
---|
{
"info": {
object ( |
Pola | |
---|---|
info |
Informacje do zaktualizowania. |
updateMask |
To pole jest wymagane. Zmienione zostaną tylko wartości wymienione w tej masce. Musisz określić co najmniej jedno pole. Element główny Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: |
UpdateSettingsRequest
Zaktualizuj pole FormSettings
formularza.
Zapis JSON |
---|
{
"settings": {
object ( |
Pola | |
---|---|
settings |
To pole jest wymagane. Ustawienia, których dotyczy aktualizacja. |
updateMask |
To pole jest wymagane. Zmienione zostaną tylko wartości wymienione w tej masce. Musisz określić co najmniej jedno pole. Element główny Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: |
CreateItemRequest
Utwórz element w formularzu.
Zapis JSON |
---|
{ "item": { object ( |
Pola | |
---|---|
item |
To pole jest wymagane. Element do utworzenia. |
location |
To pole jest wymagane. Gdzie umieścić nowy element. |
Lokalizacja
Określona lokalizacja w formularzu.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy where . To pole jest wymagane. Określ lokalizację w formularzu. where może mieć tylko jedną z tych wartości: |
|
index |
Indeks elementu w formularzu. Musi się mieścić w zakresie
, gdzie N to liczba elementów formularza. |
MoveItemRequest
Przenoszenie elementu formularza.
Zapis JSON |
---|
{ "originalLocation": { object ( |
Pola | |
---|---|
originalLocation |
To pole jest wymagane. Lokalizacja elementu do przeniesienia. |
newLocation |
To pole jest wymagane. Nowa lokalizacja elementu. |
DeleteItemRequest
Usuwanie elementu formularza.
Zapis JSON |
---|
{
"location": {
object ( |
Pola | |
---|---|
location |
To pole jest wymagane. Lokalizacja elementu do usunięcia. |
UpdateItemRequest
Aktualizowanie elementu w formularzu.
Zapis JSON |
---|
{ "item": { object ( |
Pola | |
---|---|
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ą |
location |
To pole jest wymagane. Lokalizacja identyfikująca element do zaktualizowania. |
updateMask |
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: |
WriteControl
Zapewnia kontrolę nad sposobem wykonywania żądań zapisu.
Zapis JSON |
---|
{ // Union field |
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 |
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 |
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 |
Pola | |
---|---|
Pole sumy kind . Rodzaj reakcji. kind może mieć tylko jedną z tych wartości: |
|
createItem |
Wynik utworzenia elementu. |
CreateItemResponse
Wynik utworzenia elementu.
Zapis JSON |
---|
{ "itemId": string, "questionId": [ string ] } |
Pola | |
---|---|
itemId |
Identyfikator utworzonego elementu. |
questionId[] |
Identyfikator pytania utworzonego w ramach tego elementu. W przypadku grupy pytań zawiera on identyfikatory wszystkich pytań utworzonych na potrzeby tego elementu. |