Klasa google.script.run (interfejs API po stronie klienta)

google.script.run to asynchroniczny interfejs API JavaScript dostępny po stronie klienta Strony usługi HTML, które mogą wywoływać Apps Script po stronie serwera. funkcji. korzystanie z okien i pasków bocznych w Dokumentach, Arkuszach lub Formularzach Google po stronie klienta; użyj kodu google.script.host. Więcej informacji: przewodnik po komunikowaniu się z funkcjami serwera w usłudze HTML.

Metody

MetodaZwracany typKrótki opis
myFunction(...) (dowolna funkcja po stronie serwera) void Wykonuje funkcję Apps Script po stronie serwera o odpowiedniej nazwie.
withFailureHandler(function) google.script.run Ustawia funkcję wywołania zwrotnego, która zostanie uruchomiona, jeśli funkcja po stronie serwera zgłosi wyjątek.
withSuccessHandler(function) google.script.run Ustawia funkcję wywołania zwrotnego po pomyślnym zwróceniu funkcji po stronie serwera.
withUserObject(object) google.script.run Ustawia obiekt tak, aby był przekazywany jako drugi parametr do modułów obsługi powodzenia i niepowodzenia.

Szczegółowa dokumentacja

myFunction(...) (dowolna funkcja po stronie serwera)

Wykonuje funkcję Apps Script po stronie serwera o odpowiedniej nazwie.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function doSomething() {
  Logger.log('I was called!');
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      google.script.run.doSomething();
    </script>
  </head>
  <body>
  </body>
</html>

Parametry

NazwaTypOpis
...Większość typów jest legalna, ale nie: Date, Function, lub element DOM oprócz form; zobacz opisParametry prawne to JavaScript elementy podstawowe, takie jak Number, Boolean, String lub null, a także obiekty i tablice JavaScript złożone z elementów podstawowych, obiektów i tablic. Parametr form na stronie też jest dopuszczalny, ale musi to być jedyny parametr tej funkcji. Żądania kończą się niepowodzeniem, jeśli spróbujesz Date, Function, element DOM poza form lub innym zabroniony typ, w tym niedozwolone typy w obiektach lub tablicach. Obiekty tworzące okrąg odwołania także będą kończyć się niepowodzeniem, a niezdefiniowane pola w tablicach zmienią się w null. Pamiętaj, że obiekt przekazywany na serwer staje się kopią oryginału. Jeśli funkcja serwera otrzymuje i zmienia jego właściwości, nie ma to wpływu na właściwości klienta.

Powrót

void – ta metoda jest asynchroniczna i nie zwraca bezpośrednio. jednak funkcja po stronie serwera może zwrócić wartość klientowi jako parametr przekazywany do moduł obsługi sukcesu; również typy zwrotów podlegają zasadom opisanym w ograniczenia są takie same jak w przypadku typów parametrów, z tą różnicą, że element form nie jest legalny zwracany typ

withFailureHandler(function)

Ustawia funkcję wywołania zwrotnego, która zostanie uruchomiona, jeśli funkcja po stronie serwera zgłosi wyjątek. Error jest przekazywany do funkcji jako pierwszy argument, a argument obiekt użytkownika (jeśli istnieje) jest przekazywany jako drugi argument. Bez lub modułu obsługi błędów, błędy są rejestrowane w konsoli JavaScriptu. Aby to zmienić, wywołaj withFailureHandler(null) lub nie dostarcza modułu obsługi błędów, który nie wykonuje żadnych działań.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getUnreadEmails() {
  // 'got' instead of 'get' will throw an error.
  return GmailApp.gotInboxUnreadCount();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function onFailure(error) {
        var div = document.getElementById('output');
        div.innerHTML = "ERROR: " + error.message;
      }

      google.script.run.withFailureHandler(onFailure)
          .getUnreadEmails();
    </script>
  </head>
  <body>
    <div id="output"></div>
  </body>
</html>

Parametry

NazwaTypOpis
functionFunctionfunkcję wywołania zwrotnego po stronie klienta do uruchom, jeśli funkcja po stronie serwera zgłosi wyjątek; Error jest przekazywany do funkcji jako pierwszy argument, a argument obiekt użytkownika (jeśli istnieje) jest przekazywany jako drugi argument.

Powrót

google.script.run – ten „runner skryptu”, łańcuch

withSuccessHandler(function)

Ustawia funkcję wywołania zwrotnego po pomyślnym zwróceniu funkcji po stronie serwera. Adres serwera zwracana wartość jest przekazywana do funkcji jako pierwszy argument, a funkcja userobject (jeśli występuje) jest przekazywany jako drugi argument.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getUnreadEmails() {
  return GmailApp.getInboxUnreadCount();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function onSuccess(numUnread) {
        var div = document.getElementById('output');
        div.innerHTML = 'You have ' + numUnread
            + ' unread messages in your Gmail inbox.';
      }

      google.script.run.withSuccessHandler(onSuccess)
          .getUnreadEmails();
    </script>
  </head>
  <body>
    <div id="output"></div>
  </body>
</html>

Parametry

NazwaTypOpis
functionFunctionfunkcję wywołania zwrotnego po stronie klienta do uruchom, jeśli funkcja po stronie serwera zostanie zwrócona. wartość zwrócona przez serwer jest przekazywana do funkcji jako pierwszego argumentu oraz obiektu użytkownika (jeśli istnieje) jest przekazywany jako drugi argument

Powrót

google.script.run – ten „runner skryptu”, łańcuch

withUserObject(object)

Ustawia obiekt tak, aby był przekazywany jako drugi parametr do modułów obsługi powodzenia i niepowodzenia. Ten użytkownik object&quot; – nie należy mylić z Klasa User – umożliwia wywołanie zwrotne reagują na kontekst, w którym klient skontaktował się z serwerem. Obiekty użytkownika nie są wysyłane na serwer, nie podlegają ograniczeniom parametrów wartości wywołań serwera. Obiekty użytkownika nie mogą być jednak obiektami utworzonych za pomocą operatora new.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getEmail() {
  return Session.getActiveUser().getEmail();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function updateButton(email, button) {
        button.value = 'Clicked by ' + email;
      }
    </script>
  </head>
  <body>
    <input type="button" value="Not Clicked"
      onclick="google.script.run
          .withSuccessHandler(updateButton)
          .withUserObject(this)
          .getEmail()" />
    <input type="button" value="Not Clicked"
      onclick="google.script.run
          .withSuccessHandler(updateButton)
          .withUserObject(this)
          .getEmail()" />
  </body>
</html>

Parametry

NazwaTypOpis
objectObjectobiekt, który ma być przekazywany jako drugi parametr moduły obsługi powodzenia i niepowodzeń; ponieważ obiekty użytkownika nie są wysyłane do serwera, z zastrzeżeniem ograniczeń dotyczących parametrów i wartości zwracanych dla wywołania serwera. Obiekty użytkownika nie mogą być jednak obiektami utworzonymi z operatorem new

Powrót

google.script.run – ten „runner skryptu”, łańcuch