সম্পদ পরিবর্তনের জন্য বিজ্ঞপ্তি, সম্পদ পরিবর্তনের জন্য বিজ্ঞপ্তি

প্রয়োজনীয় সম্পত্তি

প্রতিটি watch রিকোয়েস্টের সাথে আপনাকে অবশ্যই এই ফিল্ডগুলো প্রদান করতে হবে:

• একটি id প্রপার্টি স্ট্রিং যা আপনার প্রোজেক্টের মধ্যে এই নতুন নোটিফিকেশন চ্যানেলটিকে অনন্যভাবে শনাক্ত করে। আমরা একটি সার্বজনীনভাবে অনন্য শনাক্তকারী ( UUID ) বা এই জাতীয় কোনো অনন্য স্ট্রিং ব্যবহার করার পরামর্শ দিই। সর্বোচ্চ দৈর্ঘ্য: ৬৪ অক্ষর।

  আপনার সেট করা আইডি মানটি এই চ্যানেলের জন্য প্রাপ্ত প্রতিটি নোটিফিকেশন বার্তার X-Goog-Channel-Id HTTP হেডারে প্রতিফলিত হয়।

• একটি type প্রপার্টি স্ট্রিং যার মান web_hook এ সেট করা হয়েছে।

• এই নোটিফিকেশন চ্যানেলের জন্য নোটিফিকেশন শোনা ও সেগুলোর উত্তর দেওয়ার URL-এ সেট করা একটি address প্রপার্টি স্ট্রিং। এটি আপনার ওয়েবহুক কলব্যাক URL, এবং এতে অবশ্যই HTTPS ব্যবহার করতে হবে।

  মনে রাখবেন যে, আপনার ওয়েব সার্ভারে একটি বৈধ SSL সার্টিফিকেট ইনস্টল করা থাকলেই গুগল ড্রাইভ এপিআই এই HTTPS ঠিকানায় নোটিফিকেশন পাঠাতে পারবে। অবৈধ সার্টিফিকেটগুলোর মধ্যে রয়েছে:

  • স্ব-স্বাক্ষরিত সনদপত্র।
  • অবিশ্বস্ত উৎস দ্বারা স্বাক্ষরিত সনদপত্র।
  • যে সনদপত্রগুলো বাতিল করা হয়েছে।
  • যেসব সার্টিফিকেটের সাবজেক্ট টার্গেট হোস্টনেমের সাথে মেলে না।

ঐচ্ছিক বৈশিষ্ট্য

আপনি আপনার watch রিকোয়েস্টের সাথে এই ঐচ্ছিক ফিল্ডগুলোও নির্দিষ্ট করতে পারেন:

• একটি token প্রপার্টি যা চ্যানেল টোকেন হিসেবে ব্যবহারের জন্য একটি যথেচ্ছ স্ট্রিং ভ্যালু নির্দিষ্ট করে। আপনি বিভিন্ন উদ্দেশ্যে নোটিফিকেশন চ্যানেল টোকেন ব্যবহার করতে পারেন। উদাহরণস্বরূপ, প্রতিটি আগত বার্তা আপনার অ্যাপ্লিকেশন দ্বারা তৈরি করা একটি চ্যানেলের জন্য কিনা তা যাচাই করতে—নোটিফিকেশনটি স্পুফিং হচ্ছে না তা নিশ্চিত করতে—অথবা এই চ্যানেলের উদ্দেশ্যের উপর ভিত্তি করে বার্তাটিকে আপনার অ্যাপ্লিকেশনের মধ্যে সঠিক গন্তব্যে পাঠাতে আপনি টোকেনটি ব্যবহার করতে পারেন। সর্বোচ্চ দৈর্ঘ্য: ২৫৬ অক্ষর।

  এই চ্যানেলের জন্য আপনার অ্যাপ্লিকেশন যে প্রতিটি নোটিফিকেশন মেসেজ পায়, তার X-Goog-Channel-Token HTTP হেডারে টোকেনটি অন্তর্ভুক্ত থাকে।

  আপনি যদি নোটিফিকেশন চ্যানেল টোকেন ব্যবহার করেন, তাহলে আমরা আপনাকে নিম্নলিখিত পরামর্শ দিই:

  • একটি সম্প্রসারণযোগ্য এনকোডিং ফরম্যাট ব্যবহার করুন, যেমন ইউআরএল কোয়েরি প্যারামিটার। উদাহরণ: forwardTo=hr&createdBy=mobile

  • OAuth টোকেনের মতো সংবেদনশীল তথ্য অন্তর্ভুক্ত করবেন না।

• একটি expiration প্রপার্টি স্ট্রিং, যা একটি ইউনিক্স টাইমস্ট্যাম্পে (মিলিসেকেন্ডে) সেট করা হয়। এই টাইমস্ট্যাম্পটি সেই তারিখ ও সময়কে নির্দেশ করে, যখন আপনি চান যে গুগল ড্রাইভ এপিআই এই নোটিফিকেশন চ্যানেলের জন্য বার্তা পাঠানো বন্ধ করুক।

  যদি কোনো চ্যানেলের মেয়াদ শেষ হওয়ার সময় থাকে, তাহলে আপনার অ্যাপ্লিকেশন সেই চ্যানেলের জন্য যে প্রতিটি নোটিফিকেশন মেসেজ পায়, তাতে X-Goog-Channel-Expiration HTTP হেডারের ভ্যালু হিসেবে (সহজবোধ্য ফরম্যাটে) তা অন্তর্ভুক্ত করা হয়।

প্রতিক্রিয়া দেখুন

যদি watch রিকোয়েস্টটি সফলভাবে একটি নোটিফিকেশন চ্যানেল তৈরি করে, তাহলে এটি একটি HTTP 200 OK স্ট্যাটাস কোড রিটার্ন করে।

ওয়াচ রেসপন্সের মেসেজ বডি আপনার সদ্য তৈরি করা নোটিফিকেশন চ্যানেলটি সম্পর্কে তথ্য প্রদান করে, যেমনটি নিচের উদাহরণে দেখানো হয়েছে।

{
  "kind": "api#channel",
  "id": "01234567-89ab-cdef-0123456789ab",
  "resourceId": "o3hgv1538sdjfh",
  "resourceUri": "https://www.googleapis.com/drive/v3/files/o3hgv1538sdjfh",
  "token": "target=myApp-myFilesChannelDest",
  "expiration": 1426325213000
}

প্রতিক্রিয়ার মূল অংশে চ্যানেলের বিবরণ দেওয়া থাকে, যেমন:

• kind : এটিকে একটি API চ্যানেল রিসোর্স হিসেবে চিহ্নিত করে।
• id : এই চ্যানেলের জন্য আপনার নির্দিষ্ট করা আইডি।
• resourceId : যে রিসোর্সটি পর্যবেক্ষণ করা হচ্ছে তার আইডি।
• resourceUri : পর্যবেক্ষণাধীন রিসোর্সের সংস্করণ-ভিত্তিক আইডি।
• token : অনুরোধের মূল অংশে প্রদত্ত টোকেন।
• expiration : চ্যানেলটির মেয়াদ শেষ হওয়ার সময়, যা মিলিসেকেন্ডে একটি ইউনিক্স টাইমস্ট্যাম্প হিসেবে প্রকাশ করা হয়।

আপনার অনুরোধের অংশ হিসেবে পাঠানো প্রোপার্টিগুলো ছাড়াও, ফেরত আসা তথ্যে resourceId এবং resourceUri ও অন্তর্ভুক্ত থাকে, যা এই নোটিফিকেশন চ্যানেলে পর্যবেক্ষণাধীন রিসোর্সটিকে শনাক্ত করতে সাহায্য করে।

আপনি ফেরত আসা তথ্য অন্যান্য নোটিফিকেশন চ্যানেল অপারেশনে পাঠাতে পারেন, যেমন যখন আপনি নোটিফিকেশন পাওয়া বন্ধ করতে চান।

প্রতিক্রিয়া সম্পর্কে আরও বিশদ তথ্যের জন্য, এপিআই রেফারেন্সে থাকা files এবং changes মেথডগুলোর watch মেথডটি দেখুন।

সিঙ্ক বার্তা

কোনো রিসোর্স পর্যবেক্ষণ করার জন্য একটি নোটিফিকেশন চ্যানেল তৈরি করার পর, গুগল ড্রাইভ এপিআই একটি sync মেসেজ পাঠায় যা নির্দেশ করে যে নোটিফিকেশন শুরু হচ্ছে। এই মেসেজগুলোর জন্য X-Goog-Resource-State HTTP হেডারের ভ্যালু হলো sync । নেটওয়ার্ক টাইমিং সমস্যার কারণে, watch মেথডের রেসপন্স পাওয়ার আগেও sync মেসেজটি পাওয়া সম্ভব।

sync নোটিফিকেশনটি উপেক্ষা করা নিরাপদ, তবে আপনি এটি ব্যবহারও করতে পারেন। উদাহরণস্বরূপ, যদি আপনি চ্যানেলটি রাখতে না চান, তাহলে নোটিফিকেশন পাওয়া বন্ধ করার জন্য একটি কলে X-Goog-Channel-ID এবং X-Goog-Resource-ID ভ্যালুগুলো ব্যবহার করতে পারেন। এছাড়াও, পরবর্তী ইভেন্টগুলোর জন্য প্রস্তুতি হিসেবে কিছু ইনিশিয়ালাইজেশন করতেও আপনি sync নোটিফিকেশনটি ব্যবহার করতে পারেন।

গুগল ড্রাইভ এপিআই আপনার গ্রহণকারী ইউআরএল-এ যে sync বার্তাগুলো পাঠায়, তার ফরম্যাট নিচে দেখানো হলো।

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

সিঙ্ক মেসেজগুলোর X-Goog-Message-Number HTTP হেডারের মান সর্বদা 1 থাকে। এই চ্যানেলের প্রতিটি পরবর্তী নোটিফিকেশনের একটি মেসেজ নম্বর থাকে যা আগেরটির চেয়ে বড়, যদিও মেসেজ নম্বরগুলো ক্রমানুসারে হবে না।

বিজ্ঞপ্তি চ্যানেলগুলি পুনর্নবীকরণ করুন

একটি নোটিফিকেশন চ্যানেলের একটি মেয়াদ শেষ হওয়ার সময় থাকতে পারে, যার মান আপনার অনুরোধ অথবা গুগল ড্রাইভ এপিআই-এর অভ্যন্তরীণ সীমা বা ডিফল্ট দ্বারা নির্ধারিত হয় (যেটি বেশি কঠোর, সেই মানটিই ব্যবহৃত হয়)। চ্যানেলের মেয়াদ শেষ হওয়ার সময়, যদি থাকে, তবে তা watch মেথড দ্বারা ফেরত দেওয়া তথ্যে একটি ইউনিক্স টাইমস্ট্যাম্প (মিলিসেকেন্ডে) হিসেবে অন্তর্ভুক্ত থাকে। এছাড়াও, এই চ্যানেলের জন্য আপনার অ্যাপ্লিকেশন যে প্রতিটি নোটিফিকেশন মেসেজ পায়, তার X-Goog-Channel-Expiration HTTP হেডারে মেয়াদ শেষ হওয়ার তারিখ এবং সময় (সহজবোধ্য বিন্যাসে) অন্তর্ভুক্ত থাকে।

বর্তমানে, একটি নোটিফিকেশন চ্যানেল নবায়ন করার কোনো স্বয়ংক্রিয় উপায় নেই। যখন কোনো চ্যানেলের মেয়াদ শেষ হওয়ার কাছাকাছি চলে আসে, তখন আপনাকে অবশ্যই watch মেথডটি কল করে সেটিকে একটি নতুন চ্যানেল দিয়ে প্রতিস্থাপন করতে হবে। বরাবরের মতোই, নতুন চ্যানেলের id প্রপার্টির জন্য আপনাকে অবশ্যই একটি অনন্য মান ব্যবহার করতে হবে। মনে রাখবেন যে, একই রিসোর্সের জন্য দুটি নোটিফিকেশন চ্যানেল সক্রিয় থাকার মধ্যে একটি "ওভারল্যাপ" সময়কাল থাকার সম্ভাবনা রয়েছে।

বিজ্ঞপ্তি বার্তার বিন্যাস ব্যাখ্যা করুন

সমস্ত নোটিফিকেশন মেসেজে X-Goog- প্রিফিক্সযুক্ত এক সেট HTTP হেডার অন্তর্ভুক্ত থাকে। কিছু ধরণের নোটিফিকেশনে একটি মেসেজ বডিও থাকতে পারে।

files এবং changes সংক্রান্ত বিজ্ঞপ্তি বার্তাগুলো খালি রয়েছে।

POST https://mydomain.com/notifications
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: 4ba78bf0-6a47-11e2-bcfd-0800200c9a66
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://www.googleapis.com/drive/v3/files/ret08u3rv24htgh289g
X-Goog-Resource-State:  update
X-Goog-Changed: content,properties
X-Goog-Message-Number: 10

POST https://mydomain.com/notifications
Content-Type: application/json; utf-8
Content-Length: 118
X-Goog-Channel-ID: 8bd90be9-3a58-3122-ab43-9823188a5b43
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT
X-Goog-Resource-ID:  ret987df98743md8g
X-Goog-Resource-URI: https://www.googleapis.com/drive/v3/changes
X-Goog-Resource-State:  changed
X-Goog-Message-Number: 23

{
  "kind": "drive#changes"
}

বিজ্ঞপ্তিগুলিতে সাড়া দিন

সফলতা নির্দেশ করতে, আপনি নিম্নলিখিত স্ট্যাটাস কোডগুলির যেকোনো একটি ফেরত দিতে পারেন: 200 , 201 , 202 , 204 , বা 102 ।

যদি আপনার পরিষেবা গুগলের এপিআই ক্লায়েন্ট লাইব্রেরি ব্যবহার করে এবং 500 , 502 , 503 , বা 504 রিটার্ন করে, তাহলে গুগল ড্রাইভ এপিআই এক্সপোনেনশিয়াল ব্যাকঅফ সহ পুনরায় চেষ্টা করে। অন্য সব রিটার্ন স্ট্যাটাস কোডকে মেসেজ ব্যর্থতা হিসেবে গণ্য করা হয়।

গুগল ড্রাইভ এপিআই নোটিফিকেশন ইভেন্টগুলো বুঝুন

এই বিভাগে গুগল ড্রাইভ এপিআই-এর সাথে পুশ নোটিফিকেশন ব্যবহার করার সময় আপনি যে নোটিফিকেশন বার্তাগুলি পেতে পারেন, সে সম্পর্কে বিস্তারিত তথ্য দেওয়া হয়েছে।

update ইভেন্টের জন্য, X-Goog-Changed HTTP হেডারটি প্রদান করা হতে পারে। এই হেডারে কমা দ্বারা পৃথক করা একটি তালিকা থাকে, যা সংঘটিত পরিবর্তনগুলোর ধরন বর্ণনা করে।

X-Goog-Changed হেডার সহ উদাহরণ:

X-Goog-Resource-State: update
X-Goog-Changed: content, permissions