Tworzenie i publikowanie etykiety

Z tego dokumentu dowiesz się, jak tworzyć i publikować etykiety za pomocą interfejsu Google Drive Labels API.

Tworzenie etykiety

Aby utworzyć etykietę, użyj metody create w zasobie labels. Etykiety mogą opcjonalnie zawierać co najmniej 1 Field obiektów.

Musisz też określić:

Poniższy przykładowy kod pokazuje, jak użyć metody create do utworzenia standardowej etykiety administratora z określonym tytułem i 1SelectionOptions Field z 2Choice obiektami.

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

service.labels.create({
  requestBody: label,
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Zastąp te elementy:

  • TITLE: tytuł etykiety.
  • DISPLAY_NAME: wyświetlana nazwa pola.
  • CHOICE_1: pierwszy wybór w polu SelectionOptions.
  • CHOICE_2: drugi wybór w polu SelectionOptions.

Etykieta jest tworzona w UNPUBLISHED_DRAFT State. Aby etykieta była widoczna dla użytkowników i można było jej używać w plikach, musi być PUBLISHED. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

Limity etykiet

Podczas tworzenia i stosowania etykiet obowiązują te limity:

  • Etykiety standardowe: 150
  • Pola na etykietę: 10

Praca z polami w etykietach

W tabeli poniżej znajdziesz opis typów pól, które możesz dodać do etykiety, sposobu interakcji użytkowników z nimi oraz uwagi dotyczące formatu i ograniczeń:

Field Type Czynności, które mogą wykonywać użytkownicy Uwagi dotyczące formatu i ograniczeń
SelectionOptions Wybierz co najmniej 1 opcję z listy Maksymalna liczba obsługiwanych opcji to 200
Maksymalna liczba wyborów w przypadku pliku to 10, zgodnie z konfiguracją w ListOptions
IntegerOptions Wpisz wartość liczbową Obsługiwane są tylko liczby całkowite
DateOptions Wybierz datę w kalendarzu (Opcjonalnie) DateFormat można ustawić na "Długi: miesiąc DD, RRRR" lub "Krótki: MM/DD/RR"
TextOptions Wpisz tekst w polu tekstowym Maksymalna liczba znaków to 100
UserOptions Wybierz co najmniej 1 użytkownika z listy kontaktów Google Workspace. Maksymalna liczba wpisów użytkowników w przypadku pliku to 10, zgodnie z konfiguracją w ListOptions

Opublikowanie etykiety

Interfejs Drive Labels API umożliwia opublikowanie wersji roboczej etykiety po jej ukończeniu. Etykieta jest wtedy widoczna dla użytkowników i można ją stosować do plików.

Aby opublikować etykietę, użyj metody publish w zasobie labels i określ:

Poniższy przykładowy kod pokazuje, jak użyć id etykiety, aby zidentyfikować i opublikować prawidłową etykietę.

Python

service.labels().publish(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.publish({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Zastąp ID identyfikatorem etykiety, którą chcesz opublikować.

Po opublikowaniu etykiety przechodzi ona do PUBLISHED State, a identyfikator wersji etykiety jest zwiększany. Etykieta jest wtedy widoczna dla użytkowników i można ją stosować do plików. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

Ograniczenia podczas publikowania etykiet

Podczas przygotowywania się do publikowania etykiet pamiętaj o tych ograniczeniach:

  • Po opublikowaniu etykiety nie można przywrócić jej pierwotnego stanu wersji roboczej. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

  • Opublikowanie etykiety powoduje utworzenie nowej opublikowanej wersji. Wszystkie poprzednie wersje robocze zostaną usunięte. Wcześniej opublikowane wersje są zachowywane, ale w razie potrzeby mogą zostać automatycznie usunięte.

  • Po opublikowaniu niektóre zmiany nie są już dozwolone. Zwykle oznacza to, że odrzucane są wszelkie zmiany, które unieważniają lub powodują nowe ograniczenia dotyczące istniejących metadanych związanych z etykietą. Na przykład po opublikowaniu etykiety nie można wprowadzić tych zmian:

    • Etykieta zostanie bezpośrednio usunięta. (Najpierw trzeba ją wyłączyć, a potem usunąć).
    • Zmieniono Field.FieldType.
    • Aktualizacje opcji weryfikacji Field odrzucają coś, co wcześniej było akceptowane.
    • Zmniejszenie maksymalnej liczby wpisów.