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

Niestandardowe właściwości plików to pary klucz-wartość służące 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 itp. Możesz na przykład dodać właściwości pliku 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 w zasobie files. Aby dodać właściwości ograniczone do Twojej aplikacji, użyj pola appProperties zasobu files.

Właściwości można też używać w wyrażeniach wyszukiwania.

To struktura typowej właściwości, która może służyć do przechowywania identyfikatora bazy danych pliku na Dysku.

"appProperties": {
  "additionalID": "ID",
}

{
  'key':        'additionalID',
  'value':      'ID',
  'visibility': 'PRIVATE'
}

Praca z niestandardowymi właściwościami plików

W tej sekcji znajdziesz informacje o wykonywaniu niektórych zadań związanych z niestandardowymi właściwościami plików, które mają wpływ na wszystkie aplikacje.

Dodawanie lub 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ą, korzystając z zaawansowanej usługi Dysku w Google Apps Script. Więcej informacji znajdziesz w artykule Dodawanie właściwości niestandardowych.

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

Aby wyświetlić właściwości widoczne dla wszystkich aplikacji, użyj metody 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, który zawiera 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, aby ustawić pole properties zasobu files na wartość null.

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

{
  "name": null
}

Aby zobaczyć zmianę, wywołaj metodę files.get, aby pobrać obiekt properties dla pliku.

{
  "properties": {
    "mass": "1.3kg",
    "count": "3"
  }
}

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

Właściwości niestandardowe mają te ograniczenia:

• Maksymalnie 100 niestandardowych właściwości 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 dowolnej aplikacji.
• Maksymalnie 124 bajty na ciąg znaków właściwości (w tym klucz i wartość) w kodowaniu UTF-8. Na przykład właściwość z kluczem o długości 10 znaków może mieć wartość o długości tylko 114 znaków. Podobnie właściwość, która wymaga 100 znaków w przypadku wartości, może używać maksymalnie 24 znaków w przypadku klucza.

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

Dostęp do prywatnych niestandardowych właściwości pliku

Prywatne właściwości możesz pobierać tylko za pomocą pola appProperties w uwierzytelnionym żądaniu, które używa tokena dostępu uzyskanego za pomocą identyfikatora klienta OAuth 2.0. Nie możesz używać klucza interfejsu API do pobierania usług prywatnych.