Kitaplık, işlevleri diğer komut dosyalarında yeniden kullanılabilecek bir komut dosyası projesidir.
Bir kitaplığa erişim elde etme
Projenize bir kitaplık eklemek için en az görüntüleme düzeyine sahip olmanız gerekir erişebilir. İstediğiniz kitaplığın yazarı değilseniz yazarla iletişim kurun ve erişim isteyin.
Dahil etmek istediğiniz kitaplığın komut dosyası kimliğine ihtiyacınız vardır. komut dosyası kimliğini Proje Ayarları bölümünde bulabilirsiniz
sayfa.Komut dosyası projenize kitaplık ekleyin
- Apps Komut Dosyası düzenleyicisinin solunda, "Kitaplıklar"ın yanında Ekle'yi tıklayın. kitaplığı.
- "Komut dosyası kimliği"nde alanına, kitaplığın komut dosyası kimliğini yapıştırın.
- Ara'yı tıklayın.
- Sürüm açılır menüsünü tıklayıp kitaplık sürümünü seçin tıklayın.
- Varsayılan "Tanımlayıcı"nın istediğiniz adı
bu kitaplıkla kullanabilirsiniz. Bu, komut dosyanızın Google Ads'deki
kitaplığına başvurur. Örneğin,
Test
olarak ayarlarsanız şunu yapabilirsiniz: o kitaplığın bir yöntemini şu şekilde çağırın:Test.libraryMethod()
. - Ekle'yi tıklayın.
Kitaplık kullanma
Dahil edilen kitaplığınızı, varsayılan bir hizmet gibi kullanın. Örneğin,
Örneğin, Test
kitaplığınızın tanımlayıcısıysa
Test
hemen ardından bir nokta işaretiyle kitaplıktaki yöntemlerin listesini görüntüleyin.
Dahil edilen bir kitaplığa ait referans belgeleri şu yolla açılabilir: şu adımları uygulayın:
Komut dosyası düzenleyicinin solunda, kitaplık adının yanındaki Diğer'i tıklayın.
> Yeni sekmede açın.Kitaplığı kaldırma
Komut dosyası düzenleyicinin solunda, kitaplık adının yanındaki Diğer'i tıklayın.
> Kaldır > Kitaplığı kaldır'a dokunun.Kitaplığı güncelleme
Kitaplığın sürümünü değiştirebilir veya tanımlayıcısını güncelleyebilirsiniz.
- Editörün sol tarafındaki "Kütüphaneler"in altında kitaplığın adını tıklayın.
- Değişiklikleri yapıp Kaydet'i tıklayın.
Kitaplık oluşturma ve paylaşma
Komut dosyası projenizi kitaplık olarak kullanmak ve paylaşmak için aşağıdaki adımları uygulayın.
- Sürümü olan dağıtım oluşturma oluşturun.
- En azından görüntüleme düzeyinde erişimi, kitaplığın tüm potansiyel kullanıcılarıyla paylaşın.
- Bu kullanıcılara, Proje Ayarlar sayfası.
En iyi uygulamalar
Kitaplık yazarken uymanız gereken bazı kurallar şunlardır:
- Projeniz için anlamlı bir ad seçin çünkü varsayılan tanımlayıcıdır.
- Komut dosyanızdaki bir veya daha fazla yöntemin görünür olmasını istemiyorsanız (veya
kullanılabilir) kullanıyorsanız, yöntemin adını
alt çizgi. Örneğin,
myPrivateMethod_()
. - Kitaplık kullanıcıları yalnızca numaralandırılabilir genel özellikleri görebilir. Buna, fonksiyon
bildirimleri,
var
ile işlevin dışında oluşturulan değişkenler ve özellikler açıkça ayarlanmış çift tıklayın. Örneğin,enumerable
öğesine sahipObject.defineProperty()
,false
olarak ayarlanmıştır , kitaplığınızda kullanabileceğiniz bir simge oluşturuyor, ancak kullanıcılarınız bu simgeye erişemiyor. Kitaplığınızdaki kullanıcılarınızın, komut dosyası düzenleyicinin otomatik tamamlama ve dokümanları oluşturmak için JSDoc stilinde tüm işlevlerinizle ilgili dokümanlar da mevcuttur. Aşağıda bununla ilgili bir örnek verilmiştir:
/** * Raises a number to the given power, and returns the result. * * @param {number} base the number we're raising to a power * @param {number} exp the exponent we're raising the base to * @return {number} the result of the exponential calculation */ function power(base, exp) { ... }
Kaynak kapsamı
Kitaplıklarla çalışırken iki tür kaynak vardır: paylaşılan ve paylaşılmaz. Paylaşılan kaynak, hem kitaplığın hem de kapsayıcıdaki komut dosyasının aynı kaynak örneğine yerleşik erişimi vardır. İlgili içeriği oluşturmak için kullanılan aşağıdaki şemada paylaşılan kaynak örneği kullanılarak Kullanıcı Özellikleri:
Paylaşılmayan kaynak, hem kitaplığın hem de dahil olan komut dosyasının yerleşik erişimleri vardır. Ancak kütüphaneler sahip olduğu açık işlevler sayesinde, paylaşılmayan kaynaklara yardımcı olmaktır. Bu örnekte, komut dosyası özelliklerini görmek için kitaplığınızın her yerinden açın:
function getLibraryProperty(key) {
return ScriptProperties.getProperty(key);
}
Aşağıdaki şemada, Komut Dosyası Özellikleri:
Referans olması amacıyla, paylaşılan ve paylaşılmayan kaynaklar aşağıdaki tabloda listelenmiştir:
Kaynak | Paylaşıldı* | Paylaşılmıyor** | Notlar |
---|---|---|---|
Kilitle | Aynı örnek, emin olmanız gerekir. | ||
Komut Dosyası Özellikleri | Aynı örnek, emin olmanız gerekir. | ||
Önbellek | Aynı örnek, emin olmanız gerekir. | ||
Tetikleyiciler | Kitaplıkta oluşturulan basit tetikleyiciler aşağıdakiler tarafından tetiklenmez: komut dosyası. | ||
ScriptApp | |||
UiApp |
|
||
Kullanıcı Özellikleri | |||
Günlük kaydedici ve yürütme dökümü | |||
Sites, E-Tablolar ve diğer kapsayıcılar | getActive() için yapılan bir çağrı,
bazı bilgiler var. |
||
MailApp ve GmailApp | |||
* Bu, kitaplığın kendisine ait bir
özelliği/kaynak olduğunu tespit edip komut dosyası tarafından oluşturulan
bir şeydir.
. ** Bu, kitaplığın kendi kaynak/özellik örneğinin olduğu anlamına gelir. ve kitaplığı kullanan tüm komut dosyalarının bu komut dosyalarına erişmesini anlamına gelir. |
Kitaplığı test etme
Kitaplığınızı test etmek için başlık dağıtımını kullanın. Düzenleyici düzeyinde sahip olan herkes komut dosyasına erişmek için "head" dağıtımını kullanabilirsiniz.
Kitaplıkta hata ayıklama
Hata ayıklayıcıyı, mevcut kitaplığınız olan bir projede kullandığınızda dahil edilen kitaplığın bir işlevine geçebilir. Bu kod, hata ayıklayıcıyı salt görüntüleme modunda ve doğru sürümde çalıştırmalıdır.