Alan maskeleri, API arayanlarının bir isteğin döndürmesi veya güncellemesi gereken alanları listelemesinin bir yoludur. FieldMask kullanmak API'nin gereksiz işlerden kaçınmasını sağlar ve performansı artırır. Alan maskesi, Google Slaytlar API'sinde hem okuma hem de güncelleme yöntemleri için kullanılır.
Alan maskesiyle okuma
Sunular büyük olabilir ve genellikle okuma isteği tarafından döndürülen Presentation kaynağının tüm bölümlerine ihtiyacınız olmaz. fields URL parametresini kullanarak Slides API yanıtında nelerin döndürüleceğini sınırlayabilirsiniz. En iyi performans için yanıtta yalnızca ihtiyacınız olan alanları açıkça listeleyin.
Domains parametresinin biçimi, FieldMask'in JSON kodlamasıyla aynıdır. Özetle, birden fazla farklı alan virgülle ve alt alanlar ise noktalarla ayrılır. Alan adları, camelCase veya sold_by_underscores ile belirtilebilir. Kolaylık sağlaması açısından, aynı türden birden fazla alt alan parantez içinde listelenebilir.
Aşağıdaki presentations.get istek örneğinde, sunudaki tüm slaytlardaki bir pageElement nesnesinin yalnızca nesne kimliğini, Size ve dönüşümünü getirmek için slides.pageElements(objectId,size,transform) alan maskesi kullanılmaktadır:
GET https://slides.googleapis.com/v1/presentations/presentationId?fields=slides.pageElements(objectId,size,transform)
Bu yöntem çağrısının yanıtı, alan maskesinde istenen bileşenleri içeren bir Presentation nesnesidir:
{
"slides": [
{
"pageElements": [
{
"objectId": "OBJECT_ID",
"size": {
"width": {
"magnitude": 3000000,
"unit": "EMU"
},
"height": {
"magnitude": 3000000,
"unit": "EMU"
}
},
"transform": {
"scaleX": 1,
"scaleY": 1
"translateX": 311708,
"translateY": 744575,
"unit": "EMU"
}
},
{
"objectId": "OBJECT_ID",
"size": {
"width": {
"magnitude": 3000000,
"unit": "EMU"
},
"height": {
"magnitude": 3000000,
"unit": "EMU"
}
},
"transform": {
"scaleX": 1,
"scaleY": 1
"translateX": 311700,
"translateY": 2834125,
"unit": "EMU"
}
}
]
}
]
}
Alan maskesiyle güncelle
Bazen bir nesnedeki yalnızca belirli alanları güncellemeniz gerekir. Diğer alanları ise değiştirmeden bırakırsınız. Bir presentations.batchUpdate işlemi içindeki güncelleme istekleri, API'ye hangi alanların değiştirildiğini bildirmek için alan maskelerini kullanır. Güncelleme isteği, alan maskesinde belirtilmeyen tüm alanları yok sayar ve mevcut değerleriyle kalır.
Bir alanı, güncellenen mesajda belirtmeden alanı maskeye ekleyerek de ayarı kaldırabilirsiniz. Bu, alanın önceden sahip olduğu değeri temizler.
Güncelleme alan maskelerinin söz dizimi, okunan alan maskeleriyle aynıdır.
Aşağıdaki örnekte, bir şeklin renk dolgusunu DARK1 tema rengiyle değiştirmek ve şeklin dış çizgisini ayarlamak için UpdateShapePropertiesRequest kullanılmıştır:
POST https://slides.googleapis.com/v1/presentations/presentationId:batchUpdate
{
"requests": [
{
"updateShapeProperties": {
"objectId": OBJECT_ID,
"shapeProperties": {
"shapeBackgroundFill": {
"solidFill": {
"color": {
"themeColor": "DARK1"
}
}
}
},
"fields": "shapeBackgroundFill.solidFill.color,outline"
}
}
]
}