Bu belgede, uygulamanızın performansını artırmak için kullanabileceğiniz bazı teknikler ele alınmaktadır. Bazı durumlarda, sunulan fikirleri açıklamak için diğer API'lerden veya genel API'lerden örnekler kullanılır. Ancak Google Drive API için de aynı kavramlar geçerlidir.
gzip kullanarak sıkıştırma
Her istek için gereken bant genişliğini azaltmanın kolay ve kullanışlı bir yolu gzip sıkıştırmayı etkinleştirmektir. Sonuçların sıkıştırmasını açmak için ek CPU zamanı gerekir ancak ağ maliyetleriyle olan değişim genellikle bu işlemin çok değerli olmasını sağlar.
Gzip ile kodlanmış bir yanıt almak için iki şey yapmanız gerekir: Bir Accept-Encoding
üst bilgisi ayarlayın ve kullanıcı aracınızı gzip
dizesini içerecek şekilde değiştirin. gzip sıkıştırmasını etkinleştirmek için doğru şekilde oluşturulmuş HTTP üstbilgilerini gösteren örnek:
Accept-Encoding: gzip User-Agent: my program (gzip)
Kısmi kaynaklarla çalışma
API çağrılarınızın performansını artırmanın bir diğer yolu da yalnızca ilgilendiğiniz veri bölümünü gönderip almaktır. Bu sayede uygulamanız gereksiz alanları aktarmaktan, ayrıştırmaktan ve depolamaktan kaçınarak ağ, CPU ve bellek gibi kaynakları daha verimli kullanabilir.
İki tür kısmi istek vardır:
- Kısmi yanıt: Yanıta hangi alanların dahil edileceğini belirttiğiniz bir istektir (
fields
istek parametresini kullanın). - Yama: Yalnızca değiştirmek istediğiniz alanları gönderdiğiniz bir güncelleme isteğidir (
PATCH
HTTP fiili kullanılır).
Kısmi istek gönderme hakkında daha fazla bilgiyi aşağıdaki bölümlerde bulabilirsiniz.
Kısmi yanıt
Sunucu, istekleri işledikten sonra varsayılan olarak kaynağın tam temsilini geri gönderir. Daha iyi performans için sunucudan yalnızca gerçekten ihtiyacınız olan alanları göndermesini isteyebilir ve bunun yerine kısmi yanıt alabilirsiniz.
Kısmi yanıt isteğinde bulunmak için döndürülmesini istediğiniz alanları belirtmek üzere fields
istek parametresini kullanın. Bu parametreyi, yanıt verileri döndüren tüm isteklerle kullanabilirsiniz.
fields
parametresinin yalnızca yanıt verilerini etkilediğini, göndermeniz gereken verileri (varsa) etkilemediğini unutmayın. Kaynakları değiştirirken gönderdiğiniz veri miktarını azaltmak için yama isteği kullanın.
Örnek
Yama (kısmi güncelleme)
Ayrıca, kaynakları değiştirirken gereksiz veri göndermekten de kaçınabilirsiniz. Yalnızca değiştirdiğiniz belirli alanlar için güncellenmiş veriler göndermek istiyorsanız HTTP PATCH
fiili kullanın. Bu belgede açıklanan yama semantikleri, kısmi güncellemenin eski GData uygulamasından farklıdır (ve daha basittir).
Aşağıdaki kısa örnekte, küçük bir güncelleme yapmak için göndermeniz gereken verilerin, düzeltme kullanılarak nasıl en aza indirildiği gösterilmektedir.
Örnek
Yama yanıtını işleme
Geçerli bir düzeltme isteği işlendikten sonra API, değiştirilen kaynağın tam temsiliyle birlikte bir 200 OK
HTTP yanıt kodu döndürür. API tarafından ETag'ler kullanılıyorsa sunucu, bir düzeltme isteğini başarıyla işlediğinde PUT
ile olduğu gibi ETag değerlerini günceller.
Döndürülen veri miktarını azaltmak için fields
parametresini kullanmadığınız sürece, düzeltme isteği kaynak temsilinin tamamını döndürür.
Bir düzeltme isteği, söz dizimi veya anlam açısından geçersiz olan yeni bir kaynak durumuyla sonuçlanırsa sunucu bir 400 Bad Request
veya 422 Unprocessable Entity
HTTP durum kodu döndürür ve kaynak durumu değişmeden kalır. Örneğin, zorunlu bir alanın değerini silmeye çalışırsanız sunucu bir hata döndürür.
PATCH HTTP fiili desteklenmediğinde alternatif gösterim
Güvenlik duvarınız HTTP PATCH
isteklerine izin vermiyorsa bir HTTP POST
isteği gönderin ve geçersiz kılma üst bilgisini aşağıdaki gibi PATCH
olarak ayarlayın:
POST https://www.googleapis.com/... X-HTTP-Method-Override: PATCH ...
Yama ile güncelleme arasındaki fark
Uygulamada, HTTP PUT
fiili kullanılan bir güncelleme isteği için veri gönderirken yalnızca zorunlu veya isteğe bağlı alanları göndermeniz gerekir. Sunucu tarafından ayarlanan alanlar için gönderdiğiniz değerler yoksayılır. Bu, kısmi güncelleme yapmanın başka bir yolu gibi görünse de bu yaklaşımın bazı sınırlamaları vardır. HTTP PUT
fiili kullanılan güncellemelerde, gerekli parametreleri sağlamazsanız istek başarısız olur ve isteğe bağlı parametreleri sağlamazsanız daha önce ayarlanmış veriler temizlenir.
Bu nedenle, yamayı kullanmak çok daha güvenlidir. Yalnızca değiştirmek istediğiniz alanlar için veri sağlarsınız. Atladığınız alanlar temizlenmez. Bu kuralın tek istisnası, yinelenen öğeler veya diziler için geçerlidir: Bunların tümünü atlarsanız olduğu gibi kalırlar; bunlardan herhangi birini sağlarsanız tüm grup, sağladığınız grupla değiştirilir.
Toplu istekler
Bu belgede, istemcinizin kurması gereken HTTP bağlantılarının sayısını azaltmak için API çağrılarının nasıl toplu olarak yapılacağı gösterilmektedir.
Bu doküman, özellikle HTTP isteği göndererek toplu istek göndermeyle ilgilidir. Bunun yerine toplu istek yapmak için bir Google istemci kitaplığı kullanıyorsanız istemci kitaplığının belgelerine bakın.
Genel Bakış
İstemcinizin kurduğu her HTTP bağlantısı belirli miktarda ek yük oluşturur. Google Drive API, istemcinizin tek bir HTTP isteğine birden fazla API çağrısı eklemesine olanak tanıyan toplu hale getirme işlevini destekler.
Gruplandırmayı kullanmak isteyebileceğiniz durumlara örnekler:
- Çok sayıda dosya için meta verileri alma.
- Meta verileri veya özellikleri toplu olarak güncelleme.
- Çok sayıda dosyanın izinlerini değiştirme (ör. yeni bir kullanıcı veya grup ekleme).
- Yerel istemci verilerini ilk kez veya uzun süre çevrimdışı kaldıktan sonra senkronize etme.
Her durumda, her çağrıyı ayrı ayrı göndermek yerine tek bir HTTP isteğinde gruplandırabilirsiniz. Tüm iç istekler aynı Google API'ye gönderilmelidir.
Tek bir toplu istekte en fazla 100 çağrı gönderebilirsiniz. Bundan daha fazla arama yapmanız gerekiyorsa birden fazla toplu istek kullanın.
Not: Google Drive API'nin toplu sistemi, OData toplu işleme sistemiyle aynı söz dizimini kullanır ancak anlamları farklıdır.
Ek kısıtlamalar arasında şunlar yer alır:
- 100'den fazla çağrı içeren toplu istekler hataya neden olabilir.
- Her iç istek için URL'nin uzunluğunda 8.000 karakter sınırı vardır.
- Google Drive, medya yükleme, indirme veya dışa aktarma için toplu işlemleri desteklemez.
Toplu işlem ayrıntıları
Toplu istek, tek bir HTTP isteğinde birleştirilen birden fazla API çağrısından oluşur. Bu istek, API keşif belgesinde belirtilen batchPath
adresine gönderilebilir. Varsayılan yol /batch/api_name/api_version
'tir. Bu bölümde toplu söz dizimi ayrıntılı olarak açıklanmaktadır. Ardından bir örnek verilmiştir.
Not: Birlikte gruplandırılmış n istek grubu, kullanım sınırınıza tek bir istek olarak değil, n istek olarak dahil edilir. Toplu istek, işleme alınmadan önce bir dizi isteğe ayrılır.
Toplu istek biçimi
Toplu istek, multipart/mixed
içerik türünü kullanan birden fazla Google Drive API çağrısı içeren tek bir standart HTTP isteğidir. Bu ana HTTP isteğinde, parçaların her biri iç içe yerleştirilmiş bir HTTP isteği içerir.
Her bir parça kendi Content-Type: application/http
HTTP başlığıyla başlar. İsteğe bağlı bir Content-ID
başlığı da olabilir. Ancak bölüm üst bilgileri yalnızca bölümün başlangıcını işaretlemek içindir ve iç içe yerleştirilmiş istekten ayrıdır. Sunucu, toplu isteği ayrı istekler halinde açtıktan sonra bölüm üst bilgileri yoksayılır.
Her bir parçanın gövdesi, kendi yüklemi, URL'si, başlıkları ve gövdesi ile eksiksiz bir HTTP isteğidir. HTTP isteği yalnızca URL'nin yol bölümünü içermelidir. Toplu isteklerde tam URL'lere izin verilmez.
Content-Type
gibi Content-
üstbilgileri hariç olmak üzere dış toplu istek için HTTP üstbilgileri, toplu istekteki her istek için geçerlidir. Hem dış istek hem de tek bir çağrıda belirli bir HTTP üst bilgisi belirtirseniz tek bir çağrı üst bilgisinin değeri, dış toplu istek üst bilgisinin değerini geçersiz kılar. Bir aramanın üstbilgileri yalnızca o arama için geçerlidir.
Örneğin, belirli bir arama için bir Yetkilendirme üstbilgisi sağlarsanız bu üstbilgi yalnızca söz konusu arama için geçerli olur. Dış istek için bir Yetkilendirme üst bilgisi sağlarsanız bu üst bilgi, kendi Yetkilendirme üst bilgileriyle geçersiz kılınmadığı sürece tüm ayrı çağrılar için geçerli olur.
Sunucu, toplu isteği aldığında dış isteğinin sorgu parametrelerini ve üst bilgilerini (uygun olduğu şekilde) her bir parçaya uygular ve ardından her bir parçayı ayrı bir HTTP isteği gibi işler.
Toplu istek yanıtı
Sunucunun yanıtı, multipart/mixed
içerik türüne sahip tek bir standart HTTP yanıtıdır. Her bölüm, toplu istekteki isteklerden birine verilen yanıttır ve isteklerle aynı sıradadır.
İstekteki parçalar gibi her yanıt parçası da durum kodu, üstbilgiler ve gövde dahil olmak üzere eksiksiz bir HTTP yanıtı içerir. İstekteki bölümler gibi, her yanıt bölümünün önünde bölümün başlangıcını işaretleyen bir Content-Type
üstbilgisi bulunur.
İsteğin belirli bir bölümünde Content-ID
başlığı varsa yanıtın ilgili bölümünde de eşleşen bir Content-ID
başlığı bulunur. Bu başlıkta, orijinal değerin önünde response-
dizesi yer alır (aşağıdaki örnekte gösterildiği gibi).
Not: Sunucu, çağrılarınızı herhangi bir sırada gerçekleştirebilir. Bu komutların belirttiğiniz sırayla yürütüleceğini varsaymayın. İki çağrının belirli bir sırada gerçekleşmesini istiyorsanız bunları tek bir istekle gönderemezsiniz. Bunun yerine, ilkini tek başına gönderin ve ikinciyi göndermeden önce ilk çağrıya verilen yanıtı bekleyin.
Örnek
Aşağıdaki örnekte, Google Drive API ile toplu işlemlerin kullanımı gösterilmektedir.
Örnek toplu istek
POST https://www.googleapis.com/batch/drive/v3 Accept-Encoding: gzip User-Agent: Google-HTTP-Java-Client/1.20.0 (gzip) Content-Type: multipart/mixed; boundary=END_OF_PART Content-Length: 963--END_OF_PART Content-Length: 337 Content-Type: application/http content-id: 1 content-transfer-encoding: binary
POST https://www.googleapis.com/drive/v3/files/fileId/permissions?fields=id Authorization: Bearer authorization_token Content-Length: 70 Content-Type: application/json; charset=UTF-8
{ "emailAddress":"example@appsrocks.com", "role":"writer", "type":"user" } --END_OF_PART Content-Length: 353 Content-Type: application/http content-id: 2 content-transfer-encoding: binary
POST https://www.googleapis.com/drive/v3/files/fileId/permissions?fields=id&sendNotificationEmail=false Authorization: Bearer authorization_token Content-Length: 58 Content-Type: application/json; charset=UTF-8
{ "domain":"appsrocks.com", "role":"reader", "type":"domain" } --END_OF_PART--
Örnek toplu yanıt
Bu, önceki bölümdeki örnek isteğe verilen yanıttır.
HTTP/1.1 200 OK Alt-Svc: quic=":443"; p="1"; ma=604800 Server: GSE Alternate-Protocol: 443:quic,p=1 X-Frame-Options: SAMEORIGIN Content-Encoding: gzip X-XSS-Protection: 1; mode=block Content-Type: multipart/mixed; boundary=batch_6VIxXCQbJoQ_AATxy_GgFUk Transfer-Encoding: chunked X-Content-Type-Options: nosniff Date: Fri, 13 Nov 2015 19:28:59 GMT Cache-Control: private, max-age=0 Vary: X-Origin Vary: Origin Expires: Fri, 13 Nov 2015 19:28:59 GMT--batch_6VIxXCQbJoQ_AATxy_GgFUk Content-Type: application/http Content-ID: response-1
HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Date: Fri, 13 Nov 2015 19:28:59 GMT Expires: Fri, 13 Nov 2015 19:28:59 GMT Cache-Control: private, max-age=0 Content-Length: 35
{ "id": "12218244892818058021i" }
--batch_6VIxXCQbJoQ_AATxy_GgFUk Content-Type: application/http Content-ID: response-2
HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Date: Fri, 13 Nov 2015 19:28:59 GMT Expires: Fri, 13 Nov 2015 19:28:59 GMT Cache-Control: private, max-age=0 Content-Length: 35
{ "id": "04109509152946699072k" }
--batch_6VIxXCQbJoQ_AATxy_GgFUk--
İstekten belirli alanları döndürme
fields
parametresini belirtmezseniz sunucu, yönteme özgü varsayılan bir alan grubu döndürür. Örneğin, files.list
yöntemi yalnızca kind
, id
, name
ve mimeType
alanlarını döndürür.
Döndürülen varsayılan alanlar ihtiyacınız olan alanlar olmayabilir. Yanıtta hangi alanların döndürüleceğini belirtmek istiyorsanız fields
sistem parametresini kullanın.
Daha fazla bilgi için Belirli alanları döndürme başlıklı makaleyi inceleyin.
about
, comments
(delete
hariç) ve replies
(delete
hariç) kaynaklarının tüm yöntemleri için fields
parametresini ayarlamanız gerekir. Bu yöntemler varsayılan bir alan grubu döndürmez.