Zarządzanie komentarzami i odpowiedziami

Komentarze to komentarze użytkowników dotyczące pliku, na przykład czytelnicy dokument dotyczący przetwarzania tekstu sugerowanego, jak przeformułować zdanie. Dostępne są 2 typy komentarzy: komentarze zakotwiczone i niezakotwiczone. Reklama zakotwiczona komentarz jest powiązany z określoną lokalizacją, na przykład z zdaniem w dokumentu przetwarzania tekstu w określonej wersji dokumentu. I odwrotnie: niezakotwiczony komentarz jest po prostu powiązany z dokumentem.

Uwaga: w przypadku plików blob interfejs Google Drive API obsługuje tylko komentarze niezakotwiczone. Komentarze zakotwiczone w plikach blob i plikach edytorów Dokumentów Google nie są obsługiwane.

Odpowiedzi są dołączane do komentarzy i odzwierciedlają odpowiedź użytkownika na komentarz. Interfejs Drive API umożliwia użytkownikom dodawanie komentarzy i odpowiedzi dokumentów utworzonych w aplikacji. Łączny komentarz z odpowiedziami to tzw. dyskusję.

Dodaj niezakotwiczony komentarz

Aby dodać do dokumentu niezakotwiczony komentarz, wywołaj metodę comments.create z parametrem fileId i znakiem Zasób comments zawierający komentarz.

Komentarz jest wstawiony jako zwykły tekst, ale treść odpowiedzi zawiera Pole htmlContent zawierające treść sformatowaną do wyświetlania.

Ważne: zalecamy sprawdzenie, czy użytkownik ma odpowiednie uprawnienia do dodawania komentarzy. Ponadto tylko twórca komentarza lub odpowiedzi może usunąć lub edytować komentarz lub odpowiedź. Błędy występują, gdy użytkownik niebędący twórcą próbuje usunąć lub edytować komentarz. Aby uniknąć tych błędów, sprawdź pole author.me w w zasobie komentarzy, aby użytkownik użytkownik przesyłający prośbę jest autorem komentarza, a następnie weryfikuje jego uprawnień w stosunku do komentarza.

Dodawanie odpowiedzi na komentarz

Aby dodać odpowiedź na komentarz, wywołaj metodę replies.create z komentarzem, Parametr fileId i zasób replies zawierający odpowiedź.

Odpowiedź jest wstawiona jako zwykły tekst, ale jej treść zawiera Pole htmlContent zawierające treść sformatowaną do wyświetlania.

Dodaj zakotwiczony komentarz do najnowszej wersji dokumentu

Gdy dodajesz komentarz, możesz go zakotwiczyć w regionie w pliku. An kotwica definiuje wersję i region pliku, do którego komentarz . Zasób comments określa anchor w postaci ciągu JSON.

Uwaga: w przypadku plików blob interfejs Drive API obsługuje tylko komentarze niezakotwiczone. Zakotwiczone komentarze w plikach blob i plikach edytorów Dokumentów Google nie są obsługiwane.

Ważne: kotwice nie można zmieniać, a ich pozycji względem zawartości Między kolejnymi wersjami nie można zagwarantować dokumentu. Zalecamy korzystanie z reklam zakotwiczonych, w dokumentach, których pozycja się nie zmienia, na przykład w plikach graficznych lub tylko do odczytu. dokumenty

Aby dodać komentarz zakotwiczony:

1. Opcjonalnie: Zadzwoń pod numer revisions.list aby wyświetlić każdy element revisionID w dokumencie. Wykonaj ten krok tylko wtedy, gdy chcesz zakotwiczyć komentarz do dowolnej wersji innej niż najnowsza. Jeśli chcesz użyć najnowszej wersji, użyj head dla revisionID.

2. Wywoływanie metody comments.create z parametrem fileID, comments zasób zawierający komentarz oraz ciąg kotwicy JSON zawierający revisionID (r) i region (a).

Sposób definiowania regionu zależy od typu treści dokumentu z naszymi usługami. Więcej informacji znajdziesz w artykule Definiowanie regionu.

Uwaga: zalecamy sprawdzenie, czy użytkownik ma odpowiednie uprawnienia do dodawania komentarzy. Ponadto tylko twórca komentarza lub odpowiedzi może usunąć lub edytować komentarz lub odpowiedź. Błędy występują, gdy osoba niebędąca twórcą próbuje usunąć lub edytować komentarz. Aby uniknąć tych błędów, sprawdź pole author.me w zapoznaj się z zasobami dotyczącymi komentarzy.

Zdefiniuj region

Jak już wspomnieliśmy, ciąg kotwicy JSON zawiera elementy revisionID (r) oraz region (a). Region (a) to tablica JSON zawierająca klasyfikatory regionów. określając format i lokalizację, do których zakotwiczony będzie komentarz. Klasyfikator może to być dwuwymiarowy prostokąt na obraz, wiersz tekstu w dokumencie lub czas trwania filmu. Aby zdefiniować region, wybierz region klasyfikatora pasującego do typu treści, które chcesz zakotwiczyć. Dla: Jeśli np. treść jest tekstem, warto użyć atrybutu txt lub line klasyfikator regionów.

Listę klasyfikatorów regionów w interfejsie Drive API znajdziesz w sekcji Region klasyfikatory.

Poniższy przykład przedstawia ciąg kotwicy JSON, który zakotwicza komentarze do wierszy w 2 osobnych obszarach dokumentu:

• Pierwszy obszar zaczyna się w linii 12 ('n':12) i rozciąga się na trzy linie ('l':3).
• Drugi obszar obejmuje tylko linię 18 ('n':18, 'l':1`).

    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

Zastąp REVISION_ID wartością head lub identyfikatorem konkretnego elementu wersji.

Ważne: jeśli aplikacja pozwala użytkownikom aktualizować i udostępniać wiele wersji , komentarze do starszych wersji mogą już nie mieć zastosowania do lokalizacji. Dlatego musisz wskazać, do której wersji należy dany komentarz. w interfejsie użytkownika.

Zakończ komentarz

Użyj metody comment.update, aby ustawić właściwość resolved w funkcji comments zasobu do true po zaadresowaniu komentarza.

Gdy aplikacja ustawia właściwość resolved na true, interfejs powinien wskazywać że komentarz został odebrany. Aplikacja może na przykład:

• Nie zezwalaj na dalsze odpowiedzi i przyciemniaj wszystkie poprzednie odpowiedzi oraz oryginał komentarz.
• Ukryj zakończone komentarze.

Usuwanie komentarzy

Użyj metody comments.delete, aby usuwać komentarze. Gdy komentarz zostanie usunięty, Dysk oznaczy go jako skomentuj zasób jako "deleted": "true".

Wyświetlanie listy komentarzy

Użyj metody comments.list do wyświetlania listy komentarzy. Jeśli chcesz, aby wyniki zawierały też usunięte komentarze, ustaw includedDeleted do pozycji true.