Method: users.watch

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

HTTP অনুরোধ

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

URL-টিতে gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করা হয়েছে।

পথের পরামিতি

প্যারামিটার
userId

string

ব্যবহারকারীর ইমেল ঠিকানা। প্রমাণীকৃত ব্যবহারকারীকে নির্দেশ করতে me বিশেষ মানটি ব্যবহার করা যেতে পারে।

অনুরোধকারী শরীর

অনুরোধের মূল অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
ক্ষেত্র
labelIds[]

string

যেসব লেবেলআইডি-র নোটিফিকেশন সীমাবদ্ধ করতে হবে, তার তালিকা। ডিফল্টরূপে, যদি নির্দিষ্ট না করা হয়, তবে সমস্ত পরিবর্তন পুশ করা হয়। যদি নির্দিষ্ট করা হয়, তবে এটি নির্ধারণ করে যে একটি পুশ নোটিফিকেশন তৈরি করার জন্য কোন লেবেলগুলি আবশ্যক।

labelFilterAction
(deprecated)

enum ( LabelFilterAction )

labelIds list ফিল্টারিং আচরণ নির্দিষ্ট করা হয়েছে। এই ফিল্ডটি অপ্রচলিত কারণ এটি কিছু ক্ষেত্রে ভুল আচরণের কারণ হয়েছিল; এর পরিবর্তে labelFilterBehavior ব্যবহার করুন।

labelFilterBehavior

enum ( LabelFilterAction )

labelIds list ফিল্টারিং আচরণ নির্দিষ্ট করা হয়েছে। এই ফিল্ডটি labelFilterAction প্রতিস্থাপন করে; এটি সেট করা থাকলে, labelFilterAction উপেক্ষা করা হয়।

topicName

string

ইভেন্টগুলো প্রকাশ করার জন্য একটি সম্পূর্ণ যোগ্য গুগল ক্লাউড পাব/সাব এপিআই টপিকের নাম। এই টপিকের নামটি অবশ্যই ক্লাউড পাব/সাব-এ আগে থেকেই বিদ্যমান থাকতে হবে এবং আপনাকে অবশ্যই জিমেইলকে এর উপর 'publish' অনুমতি দিতে হবে। উদাহরণস্বরূপ, 'projects/my-project-identifier/topics/my-topic-name' (ক্লাউড পাব/সাব 'v1' টপিক নামকরণের ফরম্যাট ব্যবহার করে)।

মনে রাখবেন যে 'my-project-identifier' অংশটি অবশ্যই আপনার গুগল ডেভেলপার প্রজেক্ট আইডির (যেটি এই ওয়াচ রিকোয়েস্টটি চালাচ্ছে) সাথে হুবহু মিলতে হবে।

প্রতিক্রিয়া সংস্থা

পুশ নোটিফিকেশন ওয়াচ রেসপন্স।

সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "historyId": string,
  "expiration": string
}
ক্ষেত্র
historyId

string

মেইলবক্সটির বর্তমান হিস্ট্রি রেকর্ডের আইডি।

expiration

string ( int64 format)

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

অনুমোদনের পরিধি

নিম্নলিখিত OAuth স্কোপগুলির মধ্যে একটি প্রয়োজন:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

আরও তথ্যের জন্য, অনুমোদন নির্দেশিকা দেখুন।

লেবেলফিল্টারঅ্যাকশন

লেবেলআইডি তালিকার ফিল্টারিং আচরণ নির্দিষ্ট করা হয়েছে।

এনাম
include শুধুমাত্র নির্দিষ্ট লেবেলআইডি-সম্পর্কিত বার্তা পরিবর্তনের জন্য পুশ নোটিফিকেশন পান।
exclude নির্দিষ্ট লেবেলআইডি-সম্পর্কিত বার্তাগুলি ছাড়া বাকি সব বার্তা পরিবর্তনের জন্য পুশ নোটিফিকেশন পান।