Method: labels.delta

Aktualizuje pojedynczą etykietę przez zastosowanie zestawu żądań aktualizacji, co spowoduje utworzenie nowej wersji roboczej. Aktualizacja zbiorcza przebiega „wszystko albo nic”: jeśli którekolwiek z żądań aktualizacji jest nieprawidłowe, żadne zmiany nie są stosowane. Aby można było używać zmian w elementach na Dysku, powstała wersja robocza musi zostać opublikowana.

Żądanie HTTP

POST https://drivelabels.googleapis.com/v2beta/{name=labels/*}:delta

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

To pole jest wymagane. Nazwa zasobu etykiety do aktualizacji.

Treść żądania

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

Zapis JSON 
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
Pola
writeControl

object (WriteControl)

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

object (Request)

Lista aktualizacji, które mają być stosowane do etykiety. Żądania będą stosowane w kolejności, w jakiej zostały podane.
useAdminAccess

boolean

Ustaw wartość true, aby korzystać z danych logowania administratora. Przed zezwoleniem na dostęp serwer sprawdzi, czy użytkownik jest administratorem etykiety.
view

enum (LabelView)

Jeśli określisz to ustawienie, zwracane będą tylko niektóre pola należące do wskazanego widoku.
languageCode

string

Kod języka BCP-47 używany do oceny zlokalizowanych etykiet pól, gdy include_label_in_response ma wartość true.

Treść odpowiedzi

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

Odpowiedź na aktualizację etykiety.

Zapis JSON 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
Pola
responses[]

object (Response)

Odpowiedź na aktualizacje. Dane są mapowane w sposób 1:1 z aktualizacjami, ale odpowiedzi na niektóre żądania mogą być puste.
updatedLabel

object (Label)

Etykieta po zastosowaniu aktualizacji. Tę wartość ustawia się tylko wtedy, gdy [BatchUpdateLabelResponse2.include_label_in_response] ma wartość true i nie wystąpiły żadne błędy.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

Więcej informacji znajdziesz w przewodniku po autoryzacji.

Prośba

Jeden rodzaj aktualizacji do zastosowania do etykiety.

Zapis JSON 
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
Pola
Pole sumy kind. Rodzaj aktualizacji. Wymagane jest dokładnie jedno pole. kind może być tylko jedną z tych wartości:
updateLabel

object (UpdateLabelPropertiesRequest)

Aktualizuje właściwości etykiety.
createField

object (CreateFieldRequest)

Tworzy nowe pole.
updateField

object (UpdateFieldPropertiesRequest)

Aktualizuje podstawowe właściwości pola.
updateFieldType

object (UpdateFieldTypeRequest)

Zaktualizuj typ pola lub opcje typu.
enableField

object (EnableFieldRequest)

Włącza pole.
disableField

object (DisableFieldRequest)

Wyłącza pole.
deleteField

object (DeleteFieldRequest)

Usuwa pole z etykiety.
createSelectionChoice

object (CreateSelectionChoiceRequest)

Tworzy pole wyboru w polu wyboru.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Zaktualizuj właściwości opcji Wybór w polu wyboru.
enableSelectionChoice

object (EnableSelectionChoiceRequest)

Włącz opcję w polu wyboru.
disableSelectionChoice

object (DisableSelectionChoiceRequest)

Wyłącz opcję w polu wyboru.
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

Usuń opcję z pola wyboru.

UpdateLabelPropertiesRequest

Aktualizuje podstawowe właściwości etykiety.

Zapis JSON 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
Pola
updateMask

string (FieldMask format)

Pola, które należy zaktualizować. Musisz określić co najmniej jedno pole. Element główny label_properties jest domniemany i nie należy go podawać. Pojedynczego parametru * można używać w skrócie do aktualizowania każdego pola.
properties

object (Properties)

To pole jest wymagane. Właściwości etykiet do zaktualizowania.

CreateFieldRequest

Żądanie utworzenia pola w etykiecie.

Zapis JSON 
{
  "field": {
    object (Field)
  }
}
Pola
field

object (Field)

To pole jest wymagane. Pole do utworzenia.

UpdateFieldPropertiesRequest

Żądanie zaktualizowania właściwości pola.

Zapis JSON 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Pola
updateMask

string (FieldMask format)

Pola, które należy zaktualizować. Musisz określić co najmniej jedno pole. Element główny properties jest domniemany i nie należy go podawać. Pojedynczego parametru * można używać w skrócie do aktualizowania każdego pola.
id

string

To pole jest wymagane. Pole do zaktualizowania.
properties

object (Properties)

To pole jest wymagane. Podstawowe właściwości pola.

UpdateFieldTypeRequest

Prośba o zmianę typu pola.

Zapis JSON 
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
Pola
updateMask

string (FieldMask format)

Pola, które należy zaktualizować. Musisz określić co najmniej jedno pole. Pierwiastek z type_options jest domniemany i nie należy go podawać. Pojedynczego parametru * można używać w skrócie do aktualizowania każdego pola.
id

string

To pole jest wymagane. Pole do zaktualizowania.

Pole sumy type_options.

type_options może być tylko jedną z tych wartości:
textOptions

object (TextOptions)

Zaktualizuj pole na Tekst.
longTextOptions

object (LongTextOptions)

Zmień pole na długi tekst.
integerOptions

object (IntegerOptions)

Zaktualizuj pole do liczby całkowitej.
dateOptions

object (DateOptions)

Zaktualizuj pole na datę.
selectionOptions

object (SelectionOptions)

Zaktualizuj pole do zaznaczenia.
userOptions

object (UserOptions)

Zmień wartość w polu na Użytkownik.

LongTextOptions

Opcje typu pola Długi tekst.

Zapis JSON 
{
  "minLength": integer,
  "maxLength": integer
}
Pola
minLength

integer

Tylko dane wyjściowe. Minimalna prawidłowa długość wartości pola tekstowego.
maxLength

integer

Tylko dane wyjściowe. Maksymalna prawidłowa długość wartości w polu tekstowym.

EnableFieldRequest

Poproś o włączenie pola.

Zapis JSON 
{
  "id": string
}
Pola
id

string

To pole jest wymagane. Identyfikator pola, które chcesz włączyć.

DisableFieldRequest

Poproś o wyłączenie pola.

Zapis JSON 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Pola
updateMask

string (FieldMask format)

Pola, które należy zaktualizować. Musisz określić co najmniej jedno pole. Element główny disabledPolicy jest domniemany i nie należy go podawać. Pojedynczego parametru * można używać w skrócie do aktualizowania każdego pola.
id

string

To pole jest wymagane. Klucz pola do wyłączenia.
disabledPolicy

object (DisabledPolicy)

To pole jest wymagane. Pole zasady wyłączone.

DeleteFieldRequest

Poproś o usunięcie pola.

Zapis JSON 
{
  "id": string
}
Pola
id

string

To pole jest wymagane. Identyfikator pola do usunięcia.

CreateSelectionChoiceRequest

Poproś o utworzenie opcji wyboru.

Zapis JSON 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
Pola
fieldId

string

To pole jest wymagane. Pole wyboru, w którym ma zostać utworzona opcja.
choice

object (Choice)

To pole jest wymagane. Co można tworzyć

UpdateSelectionChoicePropertiesRequest

Prośba o zaktualizowanie właściwości wyboru.

Zapis JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Pola
updateMask

string (FieldMask format)

Pola, które należy zaktualizować. Musisz określić co najmniej jedno pole. Element główny properties jest domniemany i nie należy go podawać. Pojedynczego parametru * można używać w skrócie do aktualizowania każdego pola.
fieldId

string

To pole jest wymagane. Pole wyboru do zaktualizowania.
id

string

To pole jest wymagane. Opcja aktualizacji.
properties

object (Properties)

To pole jest wymagane. Właściwości wyboru do zaktualizowania.

EnableSelectionChoiceRequest

Poproś o włączenie opcji.

Zapis JSON 
{
  "fieldId": string,
  "id": string
}
Pola
fieldId

string

To pole jest wymagane. Pole wyboru, w którym zostanie włączona opcja.
id

string

To pole jest wymagane. Opcja włączenia.

DisableSelectionChoiceRequest

Prośba o wyłączenie opcji.

Zapis JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Pola
updateMask

string (FieldMask format)

Pola, które należy zaktualizować. Musisz określić co najmniej jedno pole. Element główny disabledPolicy jest domniemany i nie należy go podawać. Pojedynczego parametru * można używać w skrócie do aktualizowania każdego pola.
fieldId

string

To pole jest wymagane. Pole wyboru, w którym Wybór zostanie wyłączony.
id

string

To pole jest wymagane. Opcja wyłączenia.
disabledPolicy

object (DisabledPolicy)

To pole jest wymagane. Wyłączono zasadę do zaktualizowania.

DeleteSelectionChoiceRequest

Poproś o usunięcie opcji.

Zapis JSON 
{
  "fieldId": string,
  "id": string
}
Pola
fieldId

string

To pole jest wymagane. Pole wyboru, z którego zostanie usunięta opcja.
id

string

To pole jest wymagane. Opcja usunięcia.

Odpowiedź

Pojedyncza odpowiedź z aktualizacji.

Zapis JSON 
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
Pola
Pole sumy response. Odpowiedź dla odpowiedniego żądania. response może być tylko jedną z tych wartości:
updateLabel

object (UpdateLabelPropertiesResponse)

Zaktualizowano podstawowe właściwości etykiety.
createField

object (CreateFieldResponse)

Tworzy nowe pole.
updateField

object (UpdateFieldPropertiesResponse)

Aktualizuje podstawowe właściwości pola.
updateFieldType

object (UpdateFieldTypeResponse)

Zaktualizuj typ pola lub opcje typu.
enableField

object (EnableFieldResponse)

Włącza pole.
disableField

object (DisableFieldResponse)

Wyłącza pole.
deleteField

object (DeleteFieldResponse)

Usuwa pole z etykiety.
createSelectionChoice

object (CreateSelectionChoiceResponse)

Tworzy nową opcję listy wyboru, którą możesz dodać do pola wyboru.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

Aktualizuje opcję w polu wyboru.
enableSelectionChoice

object (EnableSelectionChoiceResponse)

Włącza opcję w polu wyboru.
disableSelectionChoice

object (DisableSelectionChoiceResponse)

Wyłącza opcję w polu wyboru.
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

Usuwa opcję z pola wyboru.

UpdateLabelPropertiesResponse

Odpowiedź na temat aktualizacji właściwości etykiet.

CreateFieldResponse

Odpowiedź wyświetlana po utworzeniu pola.

Zapis JSON 
{
  "id": string,
  "priority": integer
}
Pola
id

string

Pole utworzonego pola. Jeśli w prośbie o utworzenie pozostawisz puste pole, klucz zostanie wygenerowany automatycznie i w tym miejscu będzie można go zidentyfikować.
priority

integer

Priorytet utworzonego pola. Priorytet może się różnić od wartości określonej w celu zapewnienia ciągłości priorytetów między polami (1–n).

UpdateFieldPropertiesResponse

Odpowiedź po aktualizacji właściwości pola.

Zapis JSON 
{
  "priority": integer
}
Pola
priority

integer

Priorytet zaktualizowanego pola. Priorytet może się różnić od wartości określonej w celu zapewnienia ciągłości priorytetów między polami (1–n).

UpdateFieldTypeResponse

Odpowiedź po zmianie typu pola.

EnableFieldResponse

Odpowiedź: pole „Włącz”.

DisableFieldResponse

Odpowiedź poniżej Pole zostało wyłączone.

DeleteFieldResponse

Odpowiedź po usunięciu pola.

CreateSelectionChoiceResponse

Odpowiedź po utworzeniu opcji wyboru.

Zapis JSON 
{
  "fieldId": string,
  "id": string
}
Pola
fieldId

string

Wygenerowany przez serwer identyfikator pola.
id

string

Wygenerowany przez serwer identyfikator wybranej opcji w polu

UpdateSelectionChoicePropertiesResponse

Odpowiedź na temat aktualizacji właściwości dotyczących wyboru.

Zapis JSON 
{
  "priority": integer
}
Pola
priority

integer

Priorytet zaktualizowanej opcji. Priorytet może zmienić się na inny niż określony, aby zapewnić spójne priorytety między wyborami (1–n).

EnableSelectionChoiceResponse

Włączona odpowiedź poniżej opcji wyboru.

DisableSelectionChoiceResponse

Odpowiedź poniżej wyboru została wyłączona.

DeleteSelectionChoiceResponse

Odpowiedź na prośbę o usunięcie odpowiedzi.