Niestandardowe właściwości plików to pary klucz-wartość używane do przechowywania niestandardowych metadanych pliku na Dysku Google (np. tagów), identyfikatorów z innych magazynów danych, informacji udostępnianych między aplikacjami przepływu pracy itd. Na przykład możesz dodać właściwości plików do wszystkich dokumentów wygenerowanych przez dział sprzedaży w I kwartale.
Aby dodać właściwości widoczne dla wszystkich aplikacji, użyj pola properties
zasobu files
. Aby dodać właściwości ograniczone do aplikacji, użyj pola appProperties
zasobu files
.
Usług można też używać w wyrażeniach wyszukiwania.
To jest struktura typowej właściwości, która może służyć do przechowywania w pliku identyfikatora bazy danych pliku z Dysku.
Interfejs Drive API w wersji 3
"appProperties": {
"additionalID": "ID",
}
Interfejs Drive API w wersji 2
{
'key': 'additionalID',
'value': 'ID',
'visibility': 'PRIVATE'
}
Praca z niestandardowymi właściwościami pliku
W tej sekcji wyjaśniono, jak wykonywać zadania związane z właściwościami pliku niestandardowego, które mają wpływ na wszystkie aplikacje.
Dodawanie i aktualizowanie niestandardowych właściwości pliku
Aby dodać lub zaktualizować właściwości widoczne dla wszystkich aplikacji, użyj metody files.update
, aby ustawić pole properties
zasobu files
.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{ "properties": { "name": "wrench", "mass": "1.3kg", "count": "3" } }
Możesz też dodać do pliku właściwość niestandardową przy użyciu zaawansowanej usługi Dysk w Google Apps Script. Więcej informacji znajdziesz w artykule Dodawanie właściwości niestandardowych.
Pobieranie i wyświetlanie niestandardowych właściwości pliku
Aby wyświetlić właściwości widoczne dla wszystkich aplikacji, użyj metody files.get
do pobrania niestandardowych właściwości pliku.
GET https://www.googleapis.com/drive/v3/files/FILE_ID
?fields=properties
Odpowiedź składa się z obiektu properties
zawierającego zbiór par klucz-wartość.
{ "properties": { "name": "wrench", "mass": "1.3kg", "count": "3" } }
Usuwanie niestandardowych właściwości pliku
Aby usunąć wartości właściwości widoczne dla wszystkich aplikacji, użyj metody files.update
do ustawienia pola properties
zasobu files
na wartość null.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{ "name": null }
Aby wyświetlić zmianę, wywołaj metodę files.get
w celu pobrania obiektu properties
dla pliku.
{ "properties": { "mass": "1.3kg", "count": "3" } }
Ograniczenia niestandardowych właściwości plików
Usługi niestandardowe mają te limity:
- Maksymalnie 100 właściwości niestandardowych na plik (łącznie ze wszystkich źródeł).
- Maksymalnie 30 właściwości publicznych na plik, łącznie ze wszystkich źródeł.
- Maksymalnie 30 właściwości prywatnych na plik z jednej aplikacji.
- Maksymalnie 124 bajty na ciąg znaków usługi (w tym klucz i wartość) w kodowaniu UTF-8. Na przykład właściwość z kluczem, który ma 10 znaków, może mieć w wartości tylko 114 znaków. Podobnie w przypadku właściwości, która wymaga podania 100 znaków, klucz może mieć do 24 znaków.
Więcej informacji znajdziesz w zasobie files
. W przypadku interfejsu Drive API w wersji 2 zapoznaj się z zasobem properties
.
Dostęp do właściwości prywatnego pliku niestandardowego
Właściwości prywatne możesz pobierać za pomocą pola appProperties
tylko za pomocą uwierzytelnionego żądania, które wykorzystuje token dostępu uzyskany z identyfikatorem klienta OAuth 2.0. Nie można używać klucza interfejsu API do pobierania usług prywatnych.