Bu sayfa, Cloud Translation API ile çevrilmiştir.

Performans ipuçları

Bu dokümanda, 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 Directory 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ı kaldırmak için ek CPU zamanı gerekir ancak ağ maliyetleriyle olan denge 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

Aşağıdaki örnekte, fields parametresinin genel (hayali) bir "Demo" API ile kullanımı gösterilmektedir.

Basit istek: Bu HTTP GET isteği, fields parametresini atlar ve kaynağın tamamını döndürür.

https://www.googleapis.com/demo/v1

Tam kaynak yanıtı: Tam kaynak verileri, kısalık için atlanan diğer birçok alanın yanı sıra aşağıdaki alanları içerir.

{
  "kind": "demo",
  ...
  "items": [
  {
    "title": "First title",
    "comment": "First comment.",
    "characteristics": {
      "length": "short",
      "accuracy": "high",
      "followers": ["Jo", "Will"],
    },
    "status": "active",
    ...
  },
  {
    "title": "Second title",
    "comment": "Second comment.",
    "characteristics": {
      "length": "long",
      "accuracy": "medium"
      "followers": [ ],
    },
    "status": "pending",
    ...
  },
  ...
  ]
}

Kısmi yanıt isteği: Aynı kaynak için aşağıdaki istek, döndürülen veri miktarını önemli ölçüde azaltmak amacıyla fields parametresini kullanır.

https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)

Kısmi yanıt: Sunucu, yukarıdaki isteğe yanıt olarak yalnızca tür bilgilerini içeren bir yanıtın yanı sıra her öğede yalnızca HTML başlığı ve uzunluk özelliği bilgilerini içeren, sadeleştirilmiş bir öğeler dizisi gönderir.

200 OK

{
  "kind": "demo",
  "items": [{
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  }, {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]
}

Yanıtın, yalnızca seçilen alanları ve bunları kapsayan üst öğeleri içeren bir JSON nesnesi olduğunu unutmayın.

Ardından, fields parametresinin nasıl biçimlendirileceğiyle ilgili ayrıntılar ve ardından yanıtta tam olarak nelerin döndürüleceğiyle ilgili daha fazla ayrıntı ele alınmaktadır.

Alanlar parametresi söz dizimi özeti

fields istek parametresi değerinin biçimi, XPath söz dizimine dayanır. Desteklenen söz dizimi aşağıda özetlenmiştir. Aşağıdaki bölümde ek örnekler verilmiştir.

Birden fazla alan seçmek için virgülle ayrılmış liste kullanın.
a alanında iç içe yerleştirilmiş bir b alanını seçmek için a/b'ü, b alanında iç içe yerleştirilmiş bir c alanını seçmek için a/b/c'ı kullanın.

İstisna: Yanıtın data: { ... } gibi görünen bir data nesnesi içine yerleştirildiği "data" sarmalayıcıları kullanan API yanıtları için fields spesifikasyonuna "data" eklemeyin. Veri nesnesini data/a/b gibi bir alan spesifikasyonuyla dahil etmek hataya neden olur. Bunun yerine a/b gibi bir fields spesifikasyonu kullanın.
İfadeleri paranteze "( )" yerleştirerek dizi veya nesnelerin belirli bir alt alan grubunu istemek için alt seçici kullanın.
Örneğin: fields=items(id,author/email), items dizisindeki her öğe için yalnızca öğe kimliğini ve yazarın e-posta adresini döndürür. Ayrıca, fields=items(id)'ün fields=items/id ile eşdeğer olduğu tek bir alt alan da belirtebilirsiniz.
Gerekirse alan seçimlerinde joker karakterler kullanın.
Örneğin: fields=items/pagemap/*, bir sayfa haritasındaki tüm nesneleri seçer.

fields parametresinin kullanıldığı diğer örnekler

Aşağıdaki örneklerde, fields parametre değerinin yanıtı nasıl etkilediği açıklanmaktadır.

Not: Tüm sorgu parametresi değerlerinde olduğu gibi fields parametre değeri de URL olarak kodlanmış olmalıdır. Bu dokümandaki örneklerde, okunabilirliği artırmak için kodlama atlanmıştır.

Döndürülmesini istediğiniz alanları tanımlayın veya alan seçimleri yapın.

fields istek parametresi değeri, virgülle ayrılmış bir alan listesidir ve her alan, yanıtın köküne göre belirtilir. Bu nedenle, liste işlemi gerçekleştiriyorsanız yanıt bir koleksiyondur ve genellikle bir dizi kaynak içerir. Tek bir kaynak döndüren bir işlem gerçekleştiriyorsanız alanlar ilgili kaynağa göre belirtilir. Seçtiğiniz alan bir diziyse (veya dizinin parçasıysa) sunucu, dizideki tüm öğelerin seçili kısmını döndürür.

Koleksiyon düzeyinde bazı örnekleri aşağıda bulabilirsiniz:

Örnekler	Etki
`items`	Her öğedeki tüm alanlar dahil olmak üzere items dizisindeki tüm öğeleri döndürür ancak diğer alanları döndürmez.
`etag,items`	Hem `etag` alanını hem de items dizisindeki tüm öğeleri döndürür.
`items/title`	items dizisindeki tüm öğeler için yalnızca `title` alanını döndürür. İç içe yerleştirilmiş bir alan döndürüldüğünde yanıt, kapsayıcı üst nesneleri içerir. Üst alanlar, açıkça seçilmediği sürece başka alt alanları içermez.
`context/facets/label`	`facets` dizisinin tüm üyeleri için yalnızca `label` alanını döndürür. Bu alan da `context` nesnesi altında iç içe yerleştirilmiştir.
`items/pagemap/*/title`	items dizisindeki her öğe için `pagemap` öğesinin alt öğesi olan tüm nesnelerin yalnızca `title` alanını (varsa) döndürür.

Kaynak düzeyinde bazı örnekleri aşağıda bulabilirsiniz:

Örnekler	Etki
`title`	İstenen kaynağın `title` alanını döndürür.
`author/uri`	İstenen kaynaktaki `author` nesnesinin `uri` alt alanını döndürür.
`links/*/href`	`links` öğesinin alt öğesi olan tüm nesnelerin `href` alanını döndürür.

Alt seçimler kullanarak belirli alanların yalnızca belirli bölümlerini isteyin.

İsteğiniz belirli alanları belirtiyorsa sunucu varsayılan olarak nesneleri veya dizi öğelerini tamamen döndürür. Yalnızca belirli alt alanları içeren bir yanıt belirtebilirsiniz. Bunu, aşağıdaki örnekte gösterildiği gibi "( )" alt seçim söz dizimini kullanarak yaparsınız.

Örnek	Etki
`items(title,author/uri)`	items dizisindeki her öğe için yalnızca `title` ve yazarın `uri` değerlerini döndürür.

Kısmi yanıtlarla ilgilenme

Bir sunucu, fields sorgu parametresini içeren geçerli bir isteği işledikten sonra istenen verilerle birlikte bir HTTP 200 OK durum kodunu geri gönderir. fields sorgu parametresinde hata varsa veya parametre geçersizse sunucu, kullanıcıya alan seçiminde neyin yanlış olduğunu belirten bir hata mesajıyla birlikte bir HTTP 400 Bad Request durum kodu döndürür (örneğin, "Invalid field selection a/b").

Yukarıdaki giriş bölümünde gösterilen kısmi yanıt örneğini burada bulabilirsiniz. İstek, döndürülecek alanları belirtmek için fields parametresini kullanır.

https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)

Kısmi yanıt şu şekilde görünür:

200 OK

{
  "kind": "demo",
  "items": [{
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  }, {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]
}

Not: Veri sayfalandırması için sorgu parametrelerini destekleyen API'lerde (ör. maxResults ve nextPageToken), her sorgunun sonuçlarını yönetilebilir bir boyuta indirmek için bu parametreleri kullanın. Aksi takdirde, kısmi yanıtla elde edilebilecek performans kazanımları elde edilemeyebilir.

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

Bu örnekte, yalnızca genel (hayali) bir "Demo" API kaynağının başlığını güncellemek için basit bir düzeltme isteği gösterilmektedir. Kaynakta bir yorum, bir özellik grubu, durum ve diğer birçok alan da vardır ancak bu istekte yalnızca title alanı gönderilir çünkü değiştirilen tek alan budur:

PATCH https://www.googleapis.com/demo/v1/324
Authorization: Bearer your_auth_token
Content-Type: application/json

{
  "title": "New title"
}

Yanıt:

200 OK

{
  "title": "New title",
  "comment": "First comment.",
  "characteristics": {
    "length": "short",
    "accuracy": "high",
    "followers": ["Jo", "Will"],
  },
  "status": "active",
  ...
}

Sunucu, güncellenen kaynağın tam temsiliyle birlikte bir 200 OK durum kodu döndürür. Yalnızca title alanı düzeltme isteğine dahil edildiğinden, öncekinden farklı olan tek değer budur.

Not: Kısmi yanıt fields parametresini, düzeltmeyle birlikte kullanırsanız güncelleme isteklerinizin verimliliğini daha da artırabilirsiniz. Yama isteği yalnızca isteğin boyutunu azaltır. Kısmi yanıt, yanıtın boyutunu azaltır. Bu nedenle, her iki yönde de gönderilen veri miktarını azaltmak için fields parametresini içeren bir düzeltme isteği kullanın.

Bir yama isteğinin semantikleri

Yama isteğinin gövdesinde yalnızca değiştirmek istediğiniz kaynak alanları bulunur. Bir alanı belirtirken, kapsayıcı ebeveynlerin kısmi yanıt ile döndürüldüğü gibi kapsayıcı ebeveyn nesnelerini de eklemeniz gerekir. Gönderdiğiniz değiştirilmiş veriler, varsa üst öğenin verileriyle birleştirilir.

Ekle: Mevcut olmayan bir alan eklemek için yeni alanı ve değerini belirtin.
Değiştir: Mevcut bir alanın değerini değiştirmek için alanı belirtin ve yeni değere ayarlayın.
Sil: Bir alanı silmek için alanı belirtin ve null olarak ayarlayın. Örneğin, "comment": null. Değiştirilebilir bir nesnenin tamamını null olarak ayarlayarak da silebilirsiniz. Java API İstemci Kitaplığı'nı kullanıyorsanız bunun yerine Data.NULL_STRING kullanın. Ayrıntılar için JSON null bölümüne bakın.

Dizilerle ilgili not: Dizi içeren yama istekleri, mevcut diziyi sağladığınız diziyle değiştirir. Bir dizideki öğeleri tek tek değiştiremez, ekleyemez veya silemezsiniz.

Okuma-değiştirme-yazma döngüsünde yama kullanma

Değiştirmek istediğiniz verileri içeren kısmi bir yanıtı alarak başlamak yararlı olabilir. Bu, kaynağı başarıyla güncellemek için If-Match HTTP başlığında mevcut ETag değerini sağlamanız gerektiğinden özellikle ETag kullanan kaynaklar için önemlidir. Verileri aldıktan sonra, değiştirmek istediğiniz değerleri değiştirebilir ve değiştirilmiş kısmi temsili bir düzeltme isteğiyle geri gönderebilirsiniz. Demo kaynağının ETag'leri kullandığı varsayılan bir örnek aşağıda verilmiştir:

GET https://www.googleapis.com/demo/v1/324?fields=etag,title,comment,characteristics
Authorization: Bearer your_auth_token

Kısmi yanıt şu şekildedir:

200 OK

{
  "etag": "ETagString"
  "title": "New title"
  "comment": "First comment.",
  "characteristics": {
    "length": "short",
    "level": "5",
    "followers": ["Jo", "Will"],
  }
}

Aşağıdaki yama isteği bu yanıta dayanır. Aşağıda gösterildiği gibi, yama yanıtında döndürülen verileri sınırlamak için fields parametresini de kullanır:

PATCH https://www.googleapis.com/demo/v1/324?fields=etag,title,comment,characteristics
Authorization: Bearer your_auth_token
Content-Type: application/json
If-Match: "ETagString"

{
  "etag": "ETagString"
  "title": "",                  /* Clear the value of the title by setting it to the empty string. */
  "comment": null,              /* Delete the comment by replacing its value with null. */
  "characteristics": {
    "length": "short",
    "level": "10",              /* Modify the level value. */
    "followers": ["Jo", "Liz"], /* Replace the followers array to delete Will and add Liz. */
    "accuracy": "high"          /* Add a new characteristic. */
  },
}

Sunucu, 200 OK HTTP durum koduyla ve güncellenen kaynağın kısmi temsiliyle yanıt verir:

200 OK

{
  "etag": "newETagString"
  "title": "",                 /* Title is cleared; deleted comment field is missing. */
  "characteristics": {
    "length": "short",
    "level": "10",             /* Value is updated.*/
    "followers": ["Jo" "Liz"], /* New follower Liz is present; deleted Will is missing. */
    "accuracy": "high"         /* New characteristic is present. */
  }
}

Doğrudan bir yama isteği oluşturma

Bazı yama isteklerinde, daha önce aldığınız verileri temel almanız gerekir. Örneğin, bir diziye öğe eklemek istiyorsanız ve mevcut dizi öğelerinden hiçbirini kaybetmek istemiyorsanız önce mevcut verileri almanız gerekir. Benzer şekilde, bir API ETag kullanıyorsa kaynağı başarıyla güncellemek için isteğinizle birlikte önceki ETag değerini göndermeniz gerekir.

Not: ETags kullanılırken bir yamanın uygulanmasını zorunlu kılmak için "If-Match: *" HTTP üst bilgisini kullanabilirsiniz. Bunu yaparsanız yazmadan önce okuma işlemini yapmanız gerekmez.

Ancak diğer durumlarda, önce mevcut verileri almadan doğrudan yama isteğini oluşturabilirsiniz. Örneğin, bir alanı yeni bir değerle güncelleyen veya yeni bir alan ekleyen bir yama isteği kolayca oluşturabilirsiniz. Örnek:

PATCH https://www.googleapis.com/demo/v1/324?fields=comment,characteristics
Authorization: Bearer your_auth_token
Content-Type: application/json

{
  "comment": "A new comment",
  "characteristics": {
    "volume": "loud",
    "accuracy": null
  }
}

Bu istekle, yorum alanında mevcut bir değer varsa yeni değerle bu değerin üzerine yazılır. Aksi takdirde, alan yeni değere ayarlanır. Benzer şekilde, bir cilt özelliği varsa değerinin üzerine yazılır, yoksa özellik oluşturulur. Ayarlanmışsa doğruluk alanı kaldırılır.

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.