এই ডকুমেন্টে এমন কিছু টেকনিকের উল্লেখ করা হয়েছে যা আপনার অ্যাপ্লিকেশনের পারফর্ম্যান্স উন্নত করতে ব্যবহার করতে পারবেন। কিছু ক্ষেত্রে, উপস্থাপিত ধারণাগুলি ব্যাখ্যা করার জন্য অন্যান্য API বা জেনেরিক API-এর উদাহরণ ব্যবহার করা হয়। তবে, একই ধারণা Google Forms API-এর ক্ষেত্রে প্রযোজ্য।
gzip ব্যবহার করে কম্প্রেস করা
প্রতিটি অনুরোধের জন্য প্রয়োজনীয় ব্যান্ডউইথ কমানোর একটি সহজ এবং সুবিধাজনক উপায় হল gzip কম্প্রেশন চালু করা। যদিও ফলাফল আনকম্প্রেস করার জন্য অতিরিক্ত সিপিইউ টাইম প্রয়োজন হয়, নেটওয়ার্ক খরচের সাথে ট্রেড-অফ সাধারণত এটিকে খুব সার্থক করে তোলে।
gzip-এনকোড করা উত্তর পেতে আপনাকে দুটি কাজ করতে হবে: Accept-Encoding হেডার সেট করুন এবং আপনার ইউজার এজেন্টকে পরিবর্তন করুন যাতে gzip স্ট্রিং থাকে। gzip কম্প্রেশন চালু করার জন্য সঠিকভাবে তৈরি করা HTTP হেডারের একটি উদাহরণ এখানে দেওয়া হল:
Accept-Encoding: gzip User-Agent: my program (gzip)
আংশিক রিসোর্স নিয়ে কাজ করা
আপনার API কলের পারফর্ম্যান্স উন্নত করার আরেকটি উপায় হল শুধুমাত্র সেই ডেটার অংশের জন্য অনুরোধ করা যাতে আপনি আগ্রহী। এটি আপনার অ্যাপ্লিকেশনকে অপ্রয়োজনীয় ফিল্ড ট্রান্সফার, পার্স ও স্টোর করা থেকে বিরত রাখে, যাতে এটি নেটওয়ার্ক, সিপিইউ ও মেমরি সহ রিসোর্স আরও দক্ষতার সাথে ব্যবহার করতে পারে।
আংশিক উত্তর
ডিফল্ট হিসেবে, অনুরোধ প্রসেস করার পরে সার্ভার রিসোর্সের সম্পূর্ণ উপস্থাপনা ফেরত পাঠায়। আরও ভালো পারফর্ম্যান্সের জন্য, আপনি সার্ভারকে শুধুমাত্র আপনার প্রয়োজনীয় ফিল্ডগুলি পাঠাতে বলতে পারেন এবং পরিবর্তে একটি আংশিক উত্তর পেতে পারেন।
আংশিক উত্তরের অনুরোধ করতে, আপনি যে ফিল্ড ফেরত পেতে চান তা নির্দিষ্ট করতে fields অনুরোধ প্যারামিটার ব্যবহার করুন। আপনি এই প্যারামিটারটি এমন যেকোনও অনুরোধের সাথে ব্যবহার করতে পারেন যা রেসপন্স ডেটা প্রদান করে।
উদাহরণ
নিচের উদাহরণে একটি সাধারণ (কাল্পনিক) "Demo" API-এর সাথে fields প্যারামিটারের ব্যবহার দেখানো হয়েছে।
সহজ অনুরোধ: এই HTTP GET অনুরোধ fields প্যারামিটার বাদ দেয় এবং সম্পূর্ণ রিসোর্স ফিরিয়ে দেয়।
https://www.googleapis.com/demo/v1
সম্পূর্ণ রিসোর্স রেসপন্স: সম্পূর্ণ রিসোর্স ডেটায় নিম্নলিখিত ফিল্ডগুলি অন্তর্ভুক্ত থাকে, এর সাথে আরও অনেক কিছু থাকে যা সংক্ষিপ্ত করার জন্য বাদ দেওয়া হয়েছে।
{
"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",
...
},
...
]
}আংশিক উত্তরের জন্য অনুরোধ: এই একই রিসোর্সের জন্য নিম্নলিখিত অনুরোধে fields প্যারামিটার ব্যবহার করা হয় যাতে ফেরত আসা ডেটার পরিমাণ উল্লেখযোগ্যভাবে কমে যায়।
https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)
আংশিক উত্তর: উপরের অনুরোধের উত্তরে, সার্ভার এমন একটি উত্তর পাঠায় যাতে শুধুমাত্র ধরনের তথ্য থাকে এবং এর সাথে থাকে একটি ছোট করা আইটেম অ্যারে যাতে প্রতিটি আইটেমে শুধুমাত্র HTML শীর্ষক এবং দৈর্ঘ্যের বৈশিষ্ট্য সংক্রান্ত তথ্য থাকে।
200 OK
{
"kind": "demo",
"items": [{
"title": "First title",
"characteristics": {
"length": "short"
}
}, {
"title": "Second title",
"characteristics": {
"length": "long"
}
},
...
]
}মনে রাখবেন যে রেসপন্স হল একটি JSON অবজেক্ট যাতে শুধুমাত্র বেছে নেওয়া ফিল্ড এবং সেগুলির এনক্লোজিং পেরেন্ট অবজেক্ট অন্তর্ভুক্ত থাকে।
fields প্যারামিটার কীভাবে ফর্ম্যাট করতে হয় সেই সম্পর্কে বিবরণ পরে কভার করা হয়েছে, তারপরে উত্তরে ঠিক কী ফেরত আসে সেই সম্পর্কে আরও বিবরণ দেওয়া হয়েছে।
ফিল্ড প্যারামিটার সিনট্যাক্সের সারাংশ
fields অনুরোধ প্যারামিটার ভ্যালুর ফর্ম্যাট XPath সিনট্যাক্সের উপর ভিত্তি করে তৈরি। কাজ করে এমন সিনট্যাক্স নিচে সংক্ষেপে দেওয়া হল এবং অতিরিক্ত উদাহরণ নিম্নলিখিত বিভাগে দেওয়া হল।
- একাধিক ফিল্ড বেছে নিতে কমা দিয়ে আলাদা করা তালিকা ব্যবহার করুন।
a/bব্যবহার করেbফিল্ড বেছে নিন যাaফিল্ডের মধ্যে নেস্ট করা আছে;a/b/cব্যবহার করেcফিল্ড বেছে নিন যাbফিল্ডের মধ্যে নেস্ট করা আছে।
ব্যতিক্রম: API রেসপন্সের ক্ষেত্রে, যা "ডেটা" র্যাপার ব্যবহার করে, যেখানে রেসপন্সটি
dataঅবজেক্টের মধ্যে নেস্ট করা থাকে যাdata: { ... }-এর মতো দেখায়,fieldsস্পেসিফিকেশনে "data" অন্তর্ভুক্ত করবেন না।data/a/b-এর মতো ফিল্ড স্পেসিফিকেশন সহ ডেটা অবজেক্ট অন্তর্ভুক্ত করলে সমস্যা হয়। পরিবর্তে,a/b-এর মতোfieldsস্পেসিফিকেশন ব্যবহার করুন।- "
( )" বন্ধনীর মধ্যে এক্সপ্রেশন লিখে অ্যারে বা অবজেক্টের নির্দিষ্ট সাব-ফিল্ডের সেট অনুরোধ করতে সাব-সিলেক্টর ব্যবহার করুন।যেমন:
fields=items(id,author/email)আইটেম অ্যারের প্রতিটি এলিমেন্টের জন্য শুধুমাত্র আইটেম আইডি এবং লেখকের ইমেল রিটার্ন করে। এছাড়াও, আপনি একটি সাব-ফিল্ড উল্লেখ করতে পারেন, যেখানেfields=items(id)হলfields=items/id-এর সমতুল্য। - প্রয়োজন হলে, ফিল্ড বেছে নেওয়ার সময় ওয়াইল্ডকার্ড ব্যবহার করুন।
যেমন:
fields=items/pagemap/*পেজম্যাপের সব অবজেক্ট বেছে নেয়।
ফিল্ড প্যারামিটার ব্যবহার করার আরও উদাহরণ
fields প্যারামিটারের মান কীভাবে উত্তরে প্রভাব ফেলে তার বিবরণ নিচে দেওয়া উদাহরণে রয়েছে।
মনে রাখবেন: সব কোয়েরি প্যারামিটার ভ্যালুর মতো fields প্যারামিটার ভ্যালু অবশ্যই URL এনকোড করা হতে হবে। আরও ভালভাবে পড়ার জন্য, এই ডকুমেন্টের উদাহরণে এনকোডিং বাদ দেওয়া হয়েছে।
- আপনি যে ফিল্ড ফেরত চান তা শনাক্ত করুন অথবা ফিল্ড বেছে নিন।
fieldsঅনুরোধের প্যারামিটার ভ্যালু হল কমা দিয়ে আলাদা করা ফিল্ডের তালিকা এবং প্রতিটি ফিল্ড রেসপন্সের রুটের সাপেক্ষে নির্দিষ্ট করা হয়। তাই, আপনি তালিকা অপারেশন করলে, উত্তরে একটি কালেকশন পাওয়া যায় এবং সাধারণত এতে রিসোর্সের একটি অ্যারে থাকে। আপনি যদি এমন কোনও অপারেশন করেন যা একটি রিসোর্স রিটার্ন করে, তাহলে সেই রিসোর্সের সাপেক্ষে ফিল্ড নির্দিষ্ট করা হয়। আপনার বেছে নেওয়া ফিল্ডটি যদি কোনও অ্যারে (বা অ্যারের অংশ) হয়, তাহলে সার্ভার অ্যারের সব এলিমেন্টের বেছে নেওয়া অংশটি রিটার্ন করে।
এখানে সংগ্রহ-লেভেল সংক্রান্ত কিছু উদাহরণ দেওয়া হল:
উদাহরণ এফেক্ট itemsআইটেম অ্যারেতে থাকা সব এলিমেন্ট ফিরিয়ে দেয়, যার মধ্যে প্রতিটি এলিমেন্টের সব ফিল্ড অন্তর্ভুক্ত থাকে, তবে অন্য কোনও ফিল্ড থাকে না। etag,itemsetagফিল্ড এবং আইটেম অ্যারের সব এলিমেন্ট, দু'টিই দেখায়।items/titleআইটেম অ্যারের সব এলিমেন্টের জন্য শুধুমাত্র titleফিল্ড দেখায়।
যখনই কোনও নেস্টেড ফিল্ড রিটার্ন করা হয়, উত্তরে এনক্লোজ করা পেরেন্ট অবজেক্ট অন্তর্ভুক্ত থাকে। স্পষ্টভাবে বেছে না নেওয়া হলে, পেরেন্ট ফিল্ডে অন্য কোনও চাইল্ড ফিল্ড অন্তর্ভুক্ত করা হয় না।context/facets/labelfacetsঅ্যারের সব মেম্বারের জন্য শুধুlabelফিল্ড রিটার্ন করে, যা নিজেইcontextঅবজেক্টের মধ্যে নেস্ট করা থাকে।items/pagemap/*/titleআইটেম অ্যারের প্রতিটি এলিমেন্টের জন্য, pagemap-এর চাইল্ড অবজেক্টের মধ্যে শুধুমাত্রtitleফিল্ড (যদি থাকে) রিটার্ন করে।
রিসোর্স-লেভেল সংক্রান্ত কিছু উদাহরণ এখানে দেওয়া হল:
উদাহরণ এফেক্ট titleঅনুরোধ করা রিসোর্সের titleফিল্ড রিটার্ন করে।author/uriঅনুরোধ করা রিসোর্সে authorঅবজেক্টেরuriসাব-ফিল্ড রিটার্ন করে।links/*/hreflinks-এর চাইল্ড হিসেবে থাকা সব অবজেক্টেরhrefফিল্ড ফিরিয়ে দেয়।- সাব-বাছাই ব্যবহার করে নির্দিষ্ট ফিল্ডের শুধুমাত্র কিছু অংশের জন্য অনুরোধ করুন।
- ডিফল্ট হিসেবে, আপনার অনুরোধে নির্দিষ্ট ফিল্ড উল্লেখ করা থাকলে, সার্ভার অবজেক্ট বা অ্যারে এলিমেন্ট সম্পূর্ণভাবে ফিরিয়ে দেয়। আপনি এমন একটি উত্তর নির্দিষ্ট করতে পারেন যাতে শুধুমাত্র নির্দিষ্ট সাব-ফিল্ড অন্তর্ভুক্ত থাকে। নিচের উদাহরণের মতো, "
( )" সাব-সিলেকশন সিনট্যাক্স ব্যবহার করে আপনি এটি করতে পারবেন।উদাহরণ এফেক্ট items(title,author/uri)আইটেম অ্যারের প্রতিটি এলিমেন্টের জন্য শুধুমাত্র titleএবং লেখকেরuri-এর ভ্যালু দেখায়।
আংশিক উত্তর ম্যানেজ করা
সার্ভার fields কোয়েরি প্যারামিটার সহ সঠিক অনুরোধ প্রসেস করার পরে, এটি অনুরোধ করা ডেটার সাথে HTTP 200 OK স্ট্যাটাস কোড ফেরত পাঠায়। fields কোয়েরি প্যারামিটারে কোনও সমস্যা থাকলে বা অন্য কোনও কারণে সেটি ভুল হলে, সার্ভার একটি HTTP 400 Bad Request স্ট্যাটাস কোড পাঠায়, এর সাথে একটি সমস্যার মেসেজও পাঠানো হয় যাতে ব্যবহারকারীকে জানানো হয় যে তার ফিল্ড বেছে নেওয়ার ক্ষেত্রে কী ভুল হয়েছে (যেমন, "Invalid field selection a/b")।
উপরে ভূমিকা বিভাগে দেখানো আংশিক উত্তরের উদাহরণ এখানে দেওয়া হল। কোন ফিল্ড ফেরত দিতে হবে তা নির্দিষ্ট করতে অনুরোধটি fields প্যারামিটার ব্যবহার করে।
https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)
আংশিক উত্তরটি এরকম দেখতে হবে:
200 OK
{
"kind": "demo",
"items": [{
"title": "First title",
"characteristics": {
"length": "short"
}
}, {
"title": "Second title",
"characteristics": {
"length": "long"
}
},
...
]
}মনে রাখবেন: ডেটা পেজিনেশনের (যেমন, maxResults এবং nextPageToken) জন্য কোয়েরি প্যারামিটার সাপোর্ট করে এমন API-এর ক্ষেত্রে, প্রতিটি কোয়েরির ফলাফল ম্যানেজ করা যায় এমন সাইজে কমাতে এইসব প্যারামিটার ব্যবহার করুন। অন্যথায়, আংশিক উত্তরের মাধ্যমে পারফর্ম্যান্সের যে উন্নতি সম্ভব তা হয়ত বোঝা যাবে না।