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 aynı kavramlar Google Drive API için de geçerlidir.
gzip ile sıkıştırma
Her istek için gereken bant genişliğini azaltmanın kolay ve rahat bir yolu, gzip sıkıştırmayı etkinleştirmektir. Bu işlem, sonuçların sıkıştırılmasını açmak için ek CPU süresi gerektirse de ağ maliyetleriyle ilgili avantajları sayesinde genellikle çok faydalıdır.
Gzip kodlu bir yanıt almak için iki işlem yapmanız gerekir: Accept-Encoding
üst bilgisini ayarlayın ve kullanıcı aracınızı gzip
dizesini içerecek şekilde değiştirin. Gzip sıkıştırmayı etkinleştirmek için uygun şekilde oluşturulmuş HTTP üstbilgilerine dair bir örneği aşağıda bulabilirsiniz:
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öndermek ve almak olabilir. 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 istek (
fields
istek parametresini kullanın). - Yama: Yalnızca değiştirmek istediğiniz alanları gönderdiğiniz bir güncelleme isteğidir (
PATCH
HTTP fiilini kullanın).
Kısmi istekte bulunma hakkında daha fazla bilgiyi aşağıdaki bölümlerde bulabilirsiniz.
Kısmi yanıt
Varsayılan olarak, sunucu istekleri işledikten sonra bir kaynağın tam gösterimini 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 istemek için fields
istek parametresini kullanarak döndürülmesini istediğiniz alanları belirtin. Bu parametreyi, yanıt verisi 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 veriler göndermekten de kaçınabilirsiniz. Yalnızca değiştirdiğiniz belirli alanlar için güncellenen verileri göndermek üzere HTTP PATCH
fiilini kullanın. Bu belgede açıklanan yama semantiği, kısmi güncellemenin eski GData uygulamasında kullanılan semantikten farklıdır (ve daha basittir).
Aşağıdaki kısa örnekte, küçük bir güncelleme yapmak için göndermeniz gereken verileri yama kullanarak nasıl en aza indirebileceğiniz gösterilmektedir.
Örnek
Yamanın yanıtını işleme
API, geçerli bir yama isteğini işledikten sonra değiştirilen kaynağın tam temsiliyle birlikte 200 OK
HTTP yanıt kodunu döndürür. API tarafından ETag'ler kullanılıyorsa sunucu, bir yama isteğini başarıyla işlediğinde ETag değerlerini PUT
ile yaptığı gibi günceller.
Yama isteği, döndürdüğü veri miktarını azaltmak için fields
parametresini kullanmadığınız sürece kaynağın tamamını döndürür.
Bir yama isteği, söz dizimi veya anlam açısından geçersiz olan yeni bir kaynak durumuyla sonuçlanırsa sunucu 400 Bad Request
veya 422 Unprocessable Entity
HTTP durum kodunu 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 hata döndürür.
PATCH HTTP fiili desteklenmediğinde alternatif gösterim
Güvenlik duvarınız HTTP PATCH
isteklerine izin vermiyorsa HTTP POST
isteği gönderin ve geçersiz kılma üstbilgisini aşağıdaki örnekte gösterildiği 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
fiilini kullanan bir güncelleme isteği için veri gönderdiğinizde yalnızca zorunlu veya isteğe bağlı olan alanları göndermeniz gerekir. Sunucu tarafından ayarlanan alanlar için değer gönderirseniz bu 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
fiilini kullanan güncellemelerde, gerekli parametreleri sağlamazsanız istek başarısız olur ve isteğe bağlı parametreleri sağlamazsanız daha önce ayarlanan veriler temizlenir.
Bu nedenle yama kullanmak çok daha güvenlidir. Yalnızca değiştirmek istediğiniz alanlarla ilgili verileri sağlarsınız. Atladığınız alanlar temizlenmez. Bu kuralın tek istisnası, tekrarlayan öğ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 küme, sağladığınız küme ile 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 gönderileceği açıklanmaktadır.
Bu belge, özellikle bir HTTP isteği göndererek toplu istekte bulunma ile ilgilidir. Bunun yerine toplu istekte bulunmak için bir Google istemci kitaplığı kullanıyorsanız istemci kitaplığının dokümanlarına bakın.
Genel Bakış
İstemcinizin kurduğu her HTTP bağlantısı belirli bir ek yüke neden olur. Google Drive API, istemcinizin birden fazla API çağrısını tek bir HTTP isteğine yerleştirmesine olanak tanımak için toplu hale getirmeyi destekler.
Toplu işlem kullanmak isteyebileceğiniz durumlara örnekler:
- Çok sayıda dosyanın meta verilerini alma
- Meta verileri veya özellikleri toplu olarak güncelleme
- Yeni kullanıcı veya grup ekleme gibi çok sayıda dosyanın izinlerini değiştirme
- 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 bunları tek bir HTTP isteğinde gruplandırabilirsiniz. Tüm iç istekler aynı Google API'sine gitmelidir.
Tek bir toplu istekte en fazla 100 görüşme yapabilirsiniz. Bundan daha fazla arama yapmanız gerekiyorsa birden fazla toplu istek kullanın.
Not: Google Drive API'nin toplu iş sistemi, OData toplu işleme sistemiyle aynı söz dizimini kullanır ancak semantik farklıdır.
Ek kısıtlamalar:
- 100'den fazla çağrı içeren toplu istekler hataya neden olabilir.
- Her iç istek için URL uzunluğu 8.000 karakterle sınırlıdır.
- Google Drive, medya için toplu işlemleri (yükleme, indirme veya dosya dışa aktarma) desteklemez.
Toplu işlem ayrıntıları
Toplu istek, tek bir HTTP isteğinde birleştirilmiş 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
'dır. Bu bölümde, toplu iş söz dizimi ayrıntılı olarak açıklanmaktadır. Daha sonra bir örnek verilmiştir.
Not: Toplu olarak gönderilen n istek, kullanım sınırınıza tek bir istek olarak değil, n istek olarak dahil edilir. Toplu istek, işlenmeden önce bir dizi isteğe ayrılır.
Toplu isteğin biçimi
Toplu istek, multipart/mixed
içerik türünü kullanarak birden fazla Google Drive API çağrısı içeren tek bir standart HTTP isteğidir. Bu ana HTTP isteği içinde, her bir bölüm iç içe yerleştirilmiş bir HTTP isteği içerir.
Her bölüm kendi Content-Type: application/http
HTTP başlığıyla başlar. İsteğe bağlı olarak Content-ID
başlığı da içerebilir. Ancak bölüm başlıkları yalnızca bölümün başlangıcını işaretlemek için kullanılır ve iç içe yerleştirilmiş istekten ayrıdır. Sunucu, toplu isteği ayrı isteklere ayırdıktan sonra bölüm üstbilgileri yoksayılır.
Her parçanın gövdesi, kendi yüklemi, URL'si, başlıkları ve gövdesi ile kendi başına eksiksiz bir HTTP isteğidir. HTTP isteği yalnızca URL'nin yol kısmını içermelidir. Toplu isteklerde tam URL'lere izin verilmez.
Content-Type
gibi Content-
başlıkları hariç olmak üzere, dış toplu isteğin HTTP başlıkları, topludaki her istek için geçerlidir. Belirli bir HTTP üst bilgisini hem dış istekte hem de ayrı bir çağrıda belirtirseniz ayrı çağrı üst bilgisinin değeri, dış toplu istek üst bilgisinin değerini geçersiz kılar. Tek bir aramanın başlıkları yalnızca o arama için geçerlidir.
Örneğin, belirli bir çağrı için yetkilendirme üstbilgisi sağlarsanız bu üstbilgi yalnızca söz konusu çağrı 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ğin sorgu parametrelerini ve üst bilgilerini (uygun şekilde) her bir parçaya uygular ve ardından her bir parçayı ayrı bir HTTP isteğiymiş gibi işler.
Toplu isteğe 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.
İsteklerdeki parçalar gibi, her yanıt parçası da durum kodu, başlıklar ve gövde dahil olmak üzere eksiksiz bir HTTP yanıtı içerir. İsteklerdeki bölümler gibi, her yanıt bölümünün başında da bölümün başlangıcını belirten 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, aşağıdaki örnekte gösterildiği gibi, orijinal değerin önüne response-
dizesi eklenmiş şekilde eşleşen bir Content-ID
başlığı bulunur.
Not: Sunucu, aramalarınızı herhangi bir sırada gerçekleştirebilir. Belirttiğiniz sırayla yürütüleceklerini varsaymayın. İki aramanın belirli bir sırada gerçekleşmesini istiyorsanız bunları tek bir istekte gönderemezsiniz. Bunun yerine, ilkini tek başına gönderin, ardından ikincisini göndermeden önce ilkine verilen yanıtı bekleyin.
Örnek
Aşağıdaki örnekte, Google Drive API ile toplu işleme 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":"[email protected]", "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.
Varsayılan olarak döndürülen alanlar ihtiyacınız olan alanlar olmayabilir. Yanıtın hangi alanları döndüreceğini belirtmek istiyorsanız fields
sistem parametresini kullanın.
Daha fazla bilgi için Belirli alanları döndürme başlıklı makaleye bakın.
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 kümesi döndürmez.