google.script.run sınıfı (İstemci Tarafı API'sı)

google.script.run, şurada kullanılabilen eşzamansız bir istemci taraflı JavaScript API'dir: Sunucu tarafı Apps Komut Dosyası'nı çağırabilen HTML hizmeti sayfaları işlevlerine dahildir. Google Dokümanlar, E-Tablolar veya Formlar'da iletişim kutuları ya da kenar çubuklarıyla istemci tarafında etkileşimde bulunmak için google.script.host kodunu kullanın. Daha fazla bilgi için sunucu işlevleriyle iletişim kurma kılavuzu inceleyebilirsiniz.

Yöntemler

YöntemDönüş türüKısa açıklama
myFunction(...) (herhangi bir sunucu tarafı işlevi) void İlgili adla sunucu tarafı Apps Komut Dosyası işlevini yürütür.
withFailureHandler(function) google.script.run Sunucu tarafı işlevi bir istisna bildirirse çalışacak bir geri çağırma işlevi ayarlar.
withSuccessHandler(function) google.script.run Sunucu tarafı işlevi başarılı bir şekilde döndürülürse çalıştırılacak bir geri çağırma işlevi ayarlar.
withUserObject(object) google.script.run Başarı ve hata işleyicilere ikinci parametre olarak iletilecek bir nesne ayarlar.

Ayrıntılı belgeler

myFunction(...) (herhangi bir sunucu tarafı işlevi)

İlgili adla sunucu tarafı Apps Komut Dosyası işlevini yürütür.

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>

Parametreler

AdTürAçıklama
...Çoğu tür yasaldır ancak Date, Function ve veya form dışında bir DOM öğesi; açıklamaya bakınYasal parametreler JavaScript'tir Number, Boolean, String veya null ve temel öğelerden oluşan JavaScript nesneleri ve dizileri, nesneler ve diziler. Sayfadaki form öğesi de parametre olarak yasaldır, ancak işlevin tek parametresi olmalıdır. Bir Date, Function, form dışında bir DOM öğesi veya başka bir öğe nesne veya dizilerdeki yasaklı türler de dahil olmak üzere izin verilmeyen türler. Dairesel oluşturan nesneler başvurular da başarısız olur ve dizilerdeki tanımlanmamış alanlar null haline gelir. Lütfen sunucuya iletilen bir nesne, orijinal öğenin bir kopyası olur. Sunucu işlevi istemcideki özellikler etkilenmez.

Return

void - Bu yöntem eşzamansızdır ve doğrudan döndürülmez; ancak sunucu tarafı işlevi, istemciye aktarılan bir parametre olarak istemciye başarı işleyici; Ayrıca, dönüş türleri şunlara tabidir: Bir form öğesinin yasal olmaması dışında parametre türleriyle aynı kısıtlamalar dönüş türü

withFailureHandler(function)

Sunucu tarafı işlevi bir istisna bildirirse çalışacak bir geri çağırma işlevi ayarlar. İlgili içeriği oluşturmak için kullanılan Error. nesne, işleve ilk bağımsız değişken olarak aktarılır ve user nesnesi (varsa) ikinci bağımsız değişken olarak iletilir. Yok: söz konusu olduğunda, hatalar JavaScript konsoluna günlüğe kaydedilir. Bunu geçersiz kılmak için withFailureHandler(null) veya hiçbir şey yapmayan bir hata işleyici sağlayın.

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>

Parametreler

AdTürAçıklama
functionFunctionistemci tarafı geri çağırma işleviyle sunucu tarafı işlevi bir istisna bildirirse çalıştırılır; "the" Error. nesne, işleve ilk bağımsız değişken olarak aktarılır ve user nesnesi (varsa) ikinci bağımsız değişken olarak iletilir

Return

google.script.run — bu "komut dosyası çalıştırıcı", zincirleme için

withSuccessHandler(function)

Sunucu tarafı işlevi başarılı bir şekilde döndürülürse çalıştırılacak bir geri çağırma işlevi ayarlar. Sunucunun döndürülen değer, işleve ilk bağımsız değişken olarak aktarılır ve user nesnesi (varsa) ikinci bağımsız değişken olarak geçirilir.

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>

Parametreler

AdTürAçıklama
functionFunctionistemci tarafı geri çağırma işleviyle sunucu tarafı işlevi başarıyla döndürülürse çalıştırma; sunucunun döndürülen değeri işlevini ilk bağımsız değişken ve varsa kullanıcı nesnesi olarak tanımlar ikinci bağımsız değişken olarak geçirilir

Return

google.script.run — bu "komut dosyası çalıştırıcı", zincirleme için

withUserObject(object)

Başarı ve hata işleyicilere ikinci parametre olarak iletilecek bir nesne ayarlar. Bu kullanıcı object&quot; — User sınıfı — geri çağırmaya izin verir işlevleri istemcinin sunucuyla iletişim kurduğu bağlama yanıt verir. Kullanıcı nesneleri sunucuya gönderilmez, parametre kısıtlamalarına tabi değildir ve sunucu çağrılarının değerlerine karşılık gelir. Ancak kullanıcı nesneleri birer nesne olamaz new operatörüyle oluşturulur.

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>

Parametreler

AdTürAçıklama
objectObjectikinci parametre olarak iletilecek bir nesne ve kullanıcı nesneleri sunucuya gönderilmediğinden parametre ve dönüş değerlerine ilişkin kısıtlamalara tabidir. sunucu çağrıları için de geçerlidir. Bununla birlikte, kullanıcı nesneleri oluşturulan nesneler olamaz new operatörüyle

Return

google.script.run — bu "komut dosyası çalıştırıcı", zincirleme için