Topluluk Bağlayıcıları için hata işleme ve iletiler

İyi bir kullanıcı deneyimi sağlamak için kodunuz, hataları doğru şekilde işlemelidir. Kullanıcılara aşağıdakiler için düzeltici adımları özetleyen, eyleme dönüştürülebilir hata mesajları sunarak çözmüş olursunuz.

Bu dokümanda, bağlayıcılarda oluşabilecek hatalar ve ve bağlayıcı hatalarının nasıl düzgün bir şekilde ele alınacağı konusunda bilgi edineceksiniz.

Bilgi: JavaScript'te istisnaları işleme hakkında daha fazla bilgi edinmek için bkz. try...catch ifadesi.

Hata türleri

Kullanıcıların bağlayıcı genellikle aşağıdaki üç kategoriden birine girer:

  1. bağlayıcının dahili hataları
  2. bağlayıcı harici hataları
  3. Looker Studio hataları

Bağlayıcı dahili ve harici hataları bağlayıcı tarafından işlenmelidir geliştiriciyim. Bu hatalar, geliştiricinin hazırladığı koddan kaynaklanır.

Bağlayıcı dahili hatası

Bağlayıcı yürütülürken bağlayıcı dahili hataları oluşur. Örneğin, bağlayıcı, getData() yürütülürken API yanıtını ayrıştıramaz. Bu hatalar öngörülmeli ve kullanıcı dostu açıklamalarla ele alınmalıdır gerekir.

Bağlayıcı dahili hatalarının işlenmesi hakkında daha fazla bilgi için Bağlayıcı hatalarını işlemeyle ilgili en iyi uygulamalar.

Bağlayıcı harici hatası

Bağlayıcı yürütüldükten sonra bağlayıcı harici hataları oluşur. Örneğin, getData() ürününün üç alan için yaptığı istek yalnızca ikiye ait verileri döndürür. Her ne kadar bağlayıcının yürütülmesini tamamladığında, Looker'dan gelen isteği yerine getirmedi Stüdyo'yu seçin. Kapsamlı testler bu hataları önleyebilir.

Bağlayıcı harici hataları genellikle hata ayrıntılarını inceleyerek düzeltilebilir (varsa) kullanılabilir) ve sorunu tanımlamak için kodda hata ayıklama işlemi yapın. Daha fazla bilgi için bağlayıcınızda hata ayıklama için Kodunuzdaki hataları ayıklama bölümüne bakın.

Looker Studio hatası

Looker Studio hataları, bağlayıcı kodunuzla ilgili olmayan hatalardır. Örneğin, Kullanıcı rastgele bir veri kaynağına sahip bir zaman serisi grafiği tarih/saat boyutunu ekleyebilirsiniz.

Hata doğrudan bağlayıcıyla ilgili değilse herhangi bir işlem yapılmaz izin verdiği anlamına gelir. Kullanıcılar şu adresi ziyaret ederek daha fazla yardım alabilir: Looker Studio Yardım Merkezi'ne göz atın.

Hata mesajları gösteriliyor

Yönetici durumuna göre hata ayrıntıları gösteriliyor

Bağlayıcı hata verdiğinde Looker Studio hata mesajını gösterir .

  • Kullanıcı yönetici kullanıcıysa tüm ayrıntıları görebilir. Buna şunlar dâhildir: hata mesajını, hata türünü ve yığın izlemeyi gösterir.
  • Kullanıcı yönetici kullanıcı değilse yalnızca hatasının kullanıcı dostu bir mesajı var. Hatanın gösterilmesi hakkında daha fazla bilgi için Yönetici olmayan kullanıcılara gönderilen mesajlar için Kullanıcılara yönelik hatalar bildirme başlıklı makaleyi inceleyin.
ziyaret edin.

Kullanıcılara yönelik hatalar bildirme

Varsayılan olarak, hata ayrıntılarını yalnızca bağlayıcı yöneticileri görür. Bu sayede karşılaşılabilecek bir yığındaki API anahtarı gibi hassas bilgilerin yanlışlıkla açıklanması izler. Yönetici olmayan kullanıcılara hata mesajlarını göstermek içinnewUserError() Looker Studio Apps Komut Dosyası hizmeti.

Örnek:

try {
  // API request that can be malformed.
  getDataFromAPI();
} catch (e) {
  DataStudioApp.createCommunityConnector()
      .newUserError()
      .setDebugText('Error fetching data from API. Exception details: ' + e)
      .setText('There was an error communicating with the service. Try again later, or file an issue if this error persists.')
      .throwException();

}

Bu örnekte setText(), tüm kullanıcılara gösterilecek metni ayarlar, setDebugText() ise yalnızca yönetici kullanıcılara gösterilecek metni ayarlar.

Bağlayıcı hatalarını işlemeyle ilgili en iyi uygulamalar

Doğrulama sürecinde mümkün olduğunca çok sayıda hatayı yakalamaya ve gidermeye yürütmenizi sağlar. Örneğin, görevlerinizi tamamlamanıza yardımcı olacak hatalara neden olabilir veya istenmeyen bir duruma neden olabilir:

  • Başarısız URL getirme denemesi (geçici hatalar, zaman aşımları)
  • İstenen dönem için veri yok
  • API'deki veriler ayrıştırılamıyor veya biçimlendirilemiyor
  • Yetkilendirme jetonları iptal edildi

Kurtarılabilir hataları giderme

Başarısız olabilecek ancak kurtarılabilir olan bağlayıcı yürütme noktaları ele alınır. Örneğin, bir API isteği önemli olmayan bir nedenden dolayı (ör. sunucu yükü azaltma) kullanıyorsa hata vermeden önce yeniden denemesi gerekir.

Hataları yakalama ve bildirme

Kurtarılamayan hatalar yakalanıp yeniden fırlatılmalıdır. Yeniden atılan hata kullanıcıların hatanın neden oluştuğunu anlamalarına yardımcı olmalıdır. Sorun giderilebiliyorsa düzeltici eylemle ilgili ayrıntılar verilmelidir.

Kullanıcılara yönelik hatalar bildirme bölümünü inceleyin.

Hataları Stackdriver'a kaydet

Hataları ve diğer mesajları günlüğe kaydetmek için Stackdriver'ı kullanın. Bu, kullanıcıların hataları anlama, sorunları ayıklama ve işlenmemiş istisnaları keşfetme.

İstisna günlüğü etkinleştirme hakkında daha fazla bilgi için ve hata ayıklama amacıyla kullanıcıların güvenli bir şekilde nasıl tanımlanacağını öğrenmek için bölümüne Stackdriver Logging'i kullanın.

KULLANIMDAN KALDIRILDI: Güvenli hata mesajları için DS_USER: önekini kullanın

Yönetici olmayan kullanıcılara kullanıcı dostu hata mesajları sağlamak için şunları ekleyin: Hata mesajları içeren DS_USER: öneki. Bu önek, güvenli reklamları tanımlamak için kullanılır iletilerinin yanı sıra, gerçek hata mesajına dahil edilmemiştir.

Aşağıdaki örnekler, yönetici olmayan kullanıcılar başka bir yerde yalnızca yöneticiye hata mesajı gösterilir kullanıcılar:

data-studio/errors.gs
// Admin and non-admin users will see the following error.
try {
  // Code that might fail.
} catch (e) {
  throw new Error('DS_USER:This will be shown to admin & non-admin.');
}

// Only admin users will see the following error.
try {
  // Code that might fail.
} catch (e) {
  throw new Error('This message will only be shown to admin users');
}
.