Dodawanie niestandardowych właściwości plików

Niestandardowe właściwości pliku to pary klucz-wartość używane do przechowywania niestandardowych metadanych atrybutu Plik na Dysku Google (np. tagi), identyfikatory z innych magazynów danych, informacje współużytkowane przez aplikacje związane z przepływem pracy itd. Możesz na przykład dodać plik 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 sekcji files. Aby dodać usługi tylko w Twojej aplikacji, użyj pola appProperties zasobu files.

Uwaga: jeśli używasz starszej wersji Google Drive API (v2), użyj atrybutu Zasób properties do dodania do swojej aplikacji za pomocą properties.insert. Dla pełną listę różnic między wersjami można znaleźć w dokumentacji Drive API v2 i do porównania z wersją 3.

Właściwości mogą być też używane w wyszukiwaniu .

To typowa struktura typowej usługi, która może służyć do przechowywania Identyfikator bazy danych pliku na 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śniamy, jak wykonywać niektóre zadania związane z właściwościami pliku niestandardowego, nie wpływa na wszystkie aplikacje.

Uwaga: interfejs Dysku Google nie zawiera wbudowanego sposobu edytowania właściwości niestandardowe.

Dodawanie i aktualizowanie niestandardowych właściwości pliku

Aby dodać lub zaktualizować właściwości widoczne dla wszystkich aplikacji, użyj files.update, aby ustawić properties pola 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ą za pomocą zaawansowanych funkcji Dysk w Google Apps Script. Więcej informacji: Dodawanie niestandardowych usługi.

Pobieranie i wyświetlanie niestandardowych właściwości pliku

Aby wyświetlić właściwości widoczne dla wszystkich aplikacji, użyj files.get, aby pobrać niestandardowe 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 kolekcję 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 funkcji files.update, aby ustawić properties pola files zasób ma wartość null.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

{
  "name": null
}

Aby wyświetlić tę zmianę, wywołaj metodę files.get, aby pobrać 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 Kodowanie UTF-8. Na przykład właściwość z kluczem o długości 10 znaków Wartość może mieć tylko 114 znaków. Analogicznie usługa, która Wymaga 100 znaków, a wartość może mieć do 24 znaków .

Więcej informacji: files . W przypadku interfejsu Drive API w wersji 2 zapoznaj się z properties.

Dostęp do właściwości prywatnego pliku niestandardowego

Właściwości prywatne możesz pobierać tylko za pomocą pola appProperties przez uwierzytelnione żądanie, które wykorzystuje token dostępu uzyskany za pomocą protokołu OAuth 2.0. identyfikatora klienta. Nie można używać klucza interfejsu API do pobierania usług prywatnych.