- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Wyślij prośbę
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- Lokalizacja
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- Odpowiedź
- CreateItemResponse
- Wypróbuj
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 |
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[] |
Wymagane. Żądania aktualizacji tej grupy. |
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 |
Na podstawie pola żądania logicznego |
replies[] |
Odpowiedź na aktualizacje. Wynika z tego 1:1 żądania aktualizacji, chociaż odpowiedzi na niektóre z nich mogą być puste. |
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 |
Pola | |
---|---|
Pole sumy kind . Rodzaj prośby. kind może mieć tylko jedną z tych wartości: |
|
updateFormInfo |
Zaktualizuj dane formularza. |
updateSettings |
aktualizuje ustawienia formularza. |
createItem |
Tworzenie nowego elementu. |
moveItem |
przenieść element do określonej lokalizacji; |
deleteItem |
Usuń element. |
updateItem |
Zaktualizuj element. |
UpdateFormInfoRequest
Zaktualizuj dane formularza.
Zapis JSON |
---|
{
"info": {
object ( |
Pola | |
---|---|
info |
Informacje do zaktualizowania. |
updateMask |
Wymagane. Zmieniane są tylko wartości nazwane w tej masce. Musisz określić co najmniej jedno pole. Poziom główny Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: |
UpdateSettingsRequest
Zaktualizuj pole FormSettings
formularza.
Zapis JSON |
---|
{
"settings": {
object ( |
Pola | |
---|---|
settings |
Wymagane. Ustawienia używane do aktualizacji. |
updateMask |
Wymagane. Zmieniane są tylko wartości nazwane w tej masce. Musisz określić co najmniej jedno pole. Poziom główny Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: |
CreateItemRequest
Utwórz element w formularzu.
Zapis JSON |
---|
{ "item": { object ( |
Pola | |
---|---|
item |
Wymagane. Element do utworzenia. |
location |
Wymagane. Miejsce umieszczenia nowego elementu. |
Lokalizacja
Konkretne miejsce w formularzu.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy where . 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
Przenieś element w formularzu.
Zapis JSON |
---|
{ "originalLocation": { object ( |
Pola | |
---|---|
originalLocation |
Wymagane. Lokalizacja elementu do przeniesienia. |
newLocation |
Wymagane. Nowa lokalizacja elementu. |
DeleteItemRequest
Usuwanie elementu w formularzu.
Zapis JSON |
---|
{
"location": {
object ( |
Pola | |
---|---|
location |
Wymagane. Lokalizacja elementu do usunięcia. |
UpdateItemRequest
Zaktualizuj element w formularzu.
Zapis JSON |
---|
{ "item": { object ( |
Pola | |
---|---|
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 |
location |
Wymagane. Lokalizacja identyfikująca element, który ma zostać zaktualizowany. |
updateMask |
Wymagane. Zmieniane są tylko wartości nazwane w tej masce. Jest to rozdzielana przecinkami lista w pełni kwalifikowanych 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ó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 |
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 |
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 |
Pola | |
---|---|
Pole sumy kind . rodzaj reakcji; kind może mieć tylko jedną z tych wartości: |
|
createItem |
Wynik tworzenia elementu. |
CreateItemResponse
Wynik tworzenia 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 identyfikator wszystkich pytań utworzonych na potrzeby tego elementu. |