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 বিষয়ের নাম। এই বিষয়ের নামটি ইতিমধ্যেই Cloud Pub/Sub-তে বিদ্যমান থাকতে হবে এবং আপনাকে ইতিমধ্যেই gmail-কে "প্রকাশ" করার অনুমতি দিতে হবে । উদাহরণস্বরূপ, "projects/my-project-identifier/topics/my-topic-name" (Cloud Pub/Sub "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

আরও তথ্যের জন্য, দেখুনOAuth 2.0 Overview .

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

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

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