Method: users.watch

প্রদত্ত ব্যবহারকারীর মেলবক্সে একটি পুশ বিজ্ঞপ্তি ঘড়ি সেট আপ বা আপডেট করুন৷

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

ইভেন্টগুলি প্রকাশ করার জন্য একটি সম্পূর্ণরূপে যোগ্যতাসম্পন্ন Google Cloud Pub/Sub API বিষয়ের নাম৷ এই বিষয়ের নামটি অবশ্যই ক্লাউড পাব/সাব-এ ইতিমধ্যেই বিদ্যমান থাকতে হবে এবং আপনি ইতিমধ্যেই এটিতে gmail "প্রকাশ করুন" অনুমতি দিয়েছেন৷ উদাহরণস্বরূপ, "projects/my-project-identifier/topics/my-topic-name" (ক্লাউড পাব/সাব "v1" বিষয়ের নামকরণ ফর্ম্যাট ব্যবহার করে)।

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

প্রতিক্রিয়া শরীর

পুশ বিজ্ঞপ্তি ঘড়ি প্রতিক্রিয়া.

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

JSON প্রতিনিধিত্ব 
{
  "historyId": string,
  "expiration": string
}
ক্ষেত্র
historyId

string

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

expiration

string ( int64 format)

যখন Gmail মেইলবক্স আপডেটের জন্য বিজ্ঞপ্তি পাঠানো বন্ধ করবে (epoch Millis)। ঘড়ি পুনর্নবীকরণ করার জন্য এই সময়ের আগে আবার 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

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

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

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

Enums
include শুধুমাত্র নির্দিষ্ট লেবেলআইড সম্পর্কিত বার্তা পরিবর্তনের জন্য পুশ বিজ্ঞপ্তি পান।
exclude উল্লেখিত লেবেলআইডগুলি ব্যতীত সমস্ত বার্তা পরিবর্তনের জন্য পুশ বিজ্ঞপ্তি পান৷