REST Resource: subscriptions

সম্পদ: সাবস্ক্রিপশন

Google Workspace রিসোর্স সম্পর্কে ইভেন্ট পাওয়ার জন্য সাবস্ক্রিপশন। সাবস্ক্রিপশন সম্পর্কে আরও জানতে, Google Workspace Events API ওভারভিউ দেখুন।

JSON প্রতিনিধিত্ব
{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
ক্ষেত্র
name

string

ঐচ্ছিক। অপরিবর্তনীয়। শনাক্তকারী। সাবস্ক্রিপশনের সম্পদের নাম।

বিন্যাস: subscriptions/{subscription}

uid

string

শুধুমাত্র আউটপুট। সাবস্ক্রিপশনের জন্য সিস্টেম দ্বারা নির্ধারিত অনন্য শনাক্তকারী।

targetResource

string

প্রয়োজন। অপরিবর্তনীয়। Google Workspace রিসোর্স যা ইভেন্টের জন্য মনিটর করা হয়, পুরো রিসোর্সের নাম হিসেবে ফর্ম্যাট করা হয়। টার্গেট রিসোর্স এবং তারা যে ইভেন্টগুলি সমর্থন করে সে সম্পর্কে জানতে, সমর্থিত Google Workspace ইভেন্টগুলি দেখুন।

একটি প্রদত্ত লক্ষ্য সংস্থানের জন্য একটি সাবস্ক্রিপশন তৈরি করার জন্য একজন ব্যবহারকারী শুধুমাত্র আপনার অ্যাপকে অনুমোদন দিতে পারে। যদি আপনার অ্যাপ একই ব্যবহারকারীর শংসাপত্র সহ অন্য সদস্যতা তৈরি করার চেষ্টা করে, অনুরোধটি একটি ALREADY_EXISTS ত্রুটি ফেরত দেয়৷

eventTypes[]

string

প্রয়োজন। অপরিবর্তনীয়। Unordered তালিকা. একটি সদস্যতা তৈরি করার জন্য ইনপুট. অন্যথায়, শুধুমাত্র আউটপুট। টার্গেট রিসোর্স সম্পর্কে এক বা একাধিক ধরনের ইভেন্ট গ্রহণ করতে হবে। CloudEvents স্পেসিফিকেশন অনুযায়ী ফরম্যাট করা হয়েছে।

সমর্থিত ইভেন্ট প্রকারগুলি আপনার সদস্যতার লক্ষ্য সংস্থানের উপর নির্ভর করে। বিস্তারিত জানতে, সমর্থিত Google Workspace ইভেন্ট দেখুন।

ডিফল্টরূপে, আপনি আপনার সদস্যতার জীবনচক্র সম্পর্কে ইভেন্টগুলিও পাবেন৷ এই ক্ষেত্রের জন্য আপনাকে জীবনচক্র ইভেন্টগুলি নির্দিষ্ট করতে হবে না৷

আপনি যদি এমন একটি ইভেন্টের ধরন নির্দিষ্ট করেন যা টার্গেট রিসোর্সের জন্য বিদ্যমান নেই, তাহলে অনুরোধটি একটি HTTP 400 Bad Request স্ট্যাটাস কোড প্রদান করে।

payloadOptions

object ( PayloadOptions )

ঐচ্ছিক। ইভেন্ট পেলোডে কোন ডেটা অন্তর্ভুক্ত করতে হবে সে সম্পর্কে বিকল্প। শুধুমাত্র Google Chat ইভেন্টের জন্য সমর্থিত।

notificationEndpoint

object ( NotificationEndpoint )

প্রয়োজন। অপরিবর্তনীয়। শেষ পয়েন্ট যেখানে সদস্যতা ইভেন্টগুলি প্রদান করে, যেমন একটি পাব/সাব বিষয়।

state

enum ( State )

শুধুমাত্র আউটপুট। চাঁদার অবস্থা। সাবস্ক্রিপশন ইভেন্টগুলি গ্রহণ করতে পারে কিনা তা নির্ধারণ করে এবং সেগুলিকে বিজ্ঞপ্তির শেষ পয়েন্টে সরবরাহ করতে পারে।

suspensionReason

enum ( ErrorType )

শুধুমাত্র আউটপুট। ত্রুটি যে সদস্যতা স্থগিত.

সদস্যতা পুনরায় সক্রিয় করতে, ত্রুটিটি সমাধান করুন এবং subscriptions.reactivate পদ্ধতিতে কল করুন।

authority

string

শুধুমাত্র আউটপুট। যে ব্যবহারকারী সাবস্ক্রিপশন তৈরির অনুমোদন দিয়েছেন।

বিন্যাস: users/{user}

Google Workspace ব্যবহারকারীদের জন্য, ডিরেক্টরি এপিআই থেকে {user} মান হল user.id ফিল্ড।

createTime

string ( Timestamp format)

শুধুমাত্র আউটপুট। চাঁদা তৈরি হওয়ার সময়।

updateTime

string ( Timestamp format)

শুধুমাত্র আউটপুট। সর্বশেষ যে সাবস্ক্রিপশন আপডেট করা হয়.

reconciling

boolean

শুধুমাত্র আউটপুট। true হলে, সাবস্ক্রিপশন আপডেট হওয়ার প্রক্রিয়াধীন রয়েছে।

etag

string

ঐচ্ছিক। এই চেকসামটি সার্ভার দ্বারা অন্যান্য ক্ষেত্রের মানের উপর ভিত্তি করে গণনা করা হয় এবং অগ্রসর হওয়ার আগে ক্লায়েন্টের একটি আপ-টু-ডেট মান আছে তা নিশ্চিত করার জন্য আপডেটের অনুরোধে পাঠানো হতে পারে।

ইউনিয়ন ক্ষেত্রের expiration । সাবস্ক্রিপশনের মেয়াদ শেষ হওয়ার সময়।

আপনার সাবস্ক্রিপশনে ইভেন্ট পেলোডে রিসোর্স ডেটা অন্তর্ভুক্ত আছে কিনা তার উপর সর্বোচ্চ মেয়াদ শেষ হওয়ার সময় নির্ভর করে ( PayloadOptions ফিল্ডে উল্লেখ করা হয়েছে):

  • যদি পেলোড রিসোর্স ডেটা বাদ দেয়, তাহলে ৭ দিন পর্যন্ত।
  • যদি পেলোডের মধ্যে রিসোর্স ডেটা থাকে, 4 ঘন্টা পর্যন্ত। আপনার Google Workspace সংস্থা ডোমেন-ওয়াইড ডেলিগেশনের মাধ্যমে রিসোর্স অ্যাক্সেস করার অনুমতি দিলে, আপনি সাবস্ক্রিপশনের মেয়াদ 24 ঘণ্টা পর্যন্ত বাড়িয়ে দিতে পারেন।

সাবস্ক্রিপশনের মেয়াদ শেষ হওয়ার পরে, এটি স্বয়ংক্রিয়ভাবে মুছে ফেলা হয়। আপনি সাবস্ক্রিপশনের মেয়াদ শেষ হওয়ার 12 ঘন্টা এবং এক ঘন্টা আগে notification_endpoint লাইফসাইকেল ইভেন্টগুলি পাবেন। বিশদ বিবরণের জন্য, জীবনচক্র ইভেন্টগুলি গ্রহণ এবং প্রতিক্রিয়া দেখুন।

একটি সাবস্ক্রিপশনের মেয়াদ উত্তীর্ণ হওয়া রোধ করতে, আপনি এর মেয়াদ শেষ হওয়ার তারিখ বাড়ানোর জন্য UpdateSubscription পদ্ধতি ব্যবহার করতে পারেন। বিশদ বিবরণের জন্য, সাবস্ক্রিপশন আপডেট বা পুনর্নবীকরণ দেখুন। expiration নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:

expireTime

string ( Timestamp format)

অ-খালি ডিফল্ট। সাবস্ক্রিপশনের মেয়াদ শেষ হলে UTC-এ টাইমস্ট্যাম্প। ইনপুটে যা ব্যবহার করা হয়েছে তা নির্বিশেষে সর্বদা আউটপুটে প্রদর্শিত হয়।

ttl

string ( Duration format)

শুধুমাত্র ইনপুট। সাবস্ক্রিপশনের জন্য টাইম-টু-লাইভ (TTL) বা সময়কাল। অনির্দিষ্ট বা 0 তে সেট করা হলে, সর্বাধিক সম্ভাব্য সময়কাল ব্যবহার করে।

পেলোড অপশন

ইভেন্ট পেলোডে কোন ডেটা অন্তর্ভুক্ত করতে হবে সে সম্পর্কে বিকল্প। শুধুমাত্র Google Chat ইভেন্টের জন্য সমর্থিত।

JSON প্রতিনিধিত্ব
{
  "includeResource": boolean,
  "fieldMask": string
}
ক্ষেত্র
includeResource

boolean

ঐচ্ছিক। ইভেন্ট পেলোড পরিবর্তিত সম্পদ সম্পর্কে ডেটা অন্তর্ভুক্ত কিনা। উদাহরণস্বরূপ, একটি ইভেন্টের জন্য যেখানে একটি Google চ্যাট বার্তা তৈরি করা হয়েছিল, পেলোডে Message সংস্থান সম্পর্কিত ডেটা রয়েছে কিনা। মিথ্যা হলে, ইভেন্ট পেলোড শুধুমাত্র পরিবর্তিত সম্পদের নাম অন্তর্ভুক্ত করে।

fieldMask

string ( FieldMask format)

ঐচ্ছিক। includeResource true সেট করা থাকলে, ইভেন্ট পেলোডে অন্তর্ভুক্ত করার জন্য ক্ষেত্রগুলির তালিকা। কমা দিয়ে আলাদা ক্ষেত্র। উদাহরণস্বরূপ, একটি Google চ্যাট বার্তা প্রেরককে অন্তর্ভুক্ত করতে এবং সময় তৈরি করতে, message.sender,message.createTime লিখুন। বাদ দেওয়া হলে, পেলোড সম্পদের জন্য সমস্ত ক্ষেত্র অন্তর্ভুক্ত করে।

আপনি যদি এমন একটি ক্ষেত্র নির্দিষ্ট করেন যা সংস্থানের জন্য বিদ্যমান নেই, তবে সিস্টেমটি ক্ষেত্রটিকে উপেক্ষা করে।

বিজ্ঞপ্তি শেষ পয়েন্ট

শেষ পয়েন্ট যেখানে সাবস্ক্রিপশন ইভেন্ট বিতরণ করে।

JSON প্রতিনিধিত্ব
{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}
ক্ষেত্র

ইউনিয়ন ক্ষেত্রের endpoint ।

endpoint নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:

pubsubTopic

string

অপরিবর্তনীয়। ক্লাউড পাব/সাব বিষয় যা সদস্যতার জন্য ইভেন্ট গ্রহণ করে।

বিন্যাস: projects/{project}/topics/{topic}

আপনি যেখানে এই সাবস্ক্রিপশন তৈরি করেছেন সেই একই Google ক্লাউড প্রকল্পে আপনাকে অবশ্যই বিষয়টি তৈরি করতে হবে।

যখন বিষয়টি ইভেন্টগুলি পায়, তখন ইভেন্টগুলিকে ক্লাউড পাব/সাব বার্তা হিসাবে এনকোড করা হয়৷ বিশদ বিবরণের জন্য, ক্লাউড ইভেন্টের জন্য Google ক্লাউড পাব/সাব প্রোটোকল বাইন্ডিং দেখুন।

অবস্থা

সাবস্ক্রিপশনের জন্য সম্ভাব্য রাজ্য।

Enums
STATE_UNSPECIFIED ডিফল্ট মান। এই মান অব্যবহৃত.
ACTIVE সাবস্ক্রিপশন সক্রিয় এবং ইভেন্টগুলি গ্রহণ করতে এবং তার বিজ্ঞপ্তির শেষ পয়েন্টে বিতরণ করতে পারে।
SUSPENDED একটি ত্রুটির কারণে সদস্যতা ইভেন্টগুলি পেতে অক্ষম৷ ত্রুটি সনাক্ত করতে, suspensionReason ক্ষেত্রটি দেখুন।
DELETED সদস্যতা মুছে ফেলা হয়.

ErrorType

সাবস্ক্রিপশনের জন্য সম্ভাব্য ত্রুটি।

Enums
ERROR_TYPE_UNSPECIFIED ডিফল্ট মান। এই মান অব্যবহৃত.
USER_SCOPE_REVOKED অনুমোদনকারী ব্যবহারকারী এক বা একাধিক OAuth স্কোপের অনুদান প্রত্যাহার করেছেন। Google Workspace-এর অনুমোদন সম্পর্কে আরও জানতে, OAuth সম্মতি স্ক্রিন কনফিগার করুন দেখুন।
RESOURCE_DELETED সাবস্ক্রিপশনের জন্য টার্গেট রিসোর্স আর বিদ্যমান নেই।
USER_AUTHORIZATION_FAILURE সাবস্ক্রিপশন তৈরির অনুমোদনকারী ব্যবহারকারীর সাবস্ক্রিপশনের টার্গেট রিসোর্সে আর অ্যাক্সেস নেই।
ENDPOINT_PERMISSION_DENIED আপনার সাবস্ক্রিপশনের বিজ্ঞপ্তির এন্ডপয়েন্টে ইভেন্ট ডেলিভার করার জন্য Google Workspace অ্যাপের অ্যাক্সেস নেই।
ENDPOINT_NOT_FOUND সাবস্ক্রিপশনের নোটিফিকেশন এন্ডপয়েন্টটি বিদ্যমান নেই, অথবা আপনি সাবস্ক্রিপশন তৈরি করেছেন এমন Google ক্লাউড প্রোজেক্টে এন্ডপয়েন্ট পাওয়া যাবে না।
ENDPOINT_RESOURCE_EXHAUSTED অপর্যাপ্ত কোটা বা হার সীমিত হওয়ার কারণে সাবস্ক্রিপশনের বিজ্ঞপ্তির শেষ পয়েন্টটি ইভেন্টগুলি পেতে ব্যর্থ হয়েছে।
OTHER একটি অজ্ঞাত ত্রুটি ঘটেছে.

পদ্ধতি

create

 একটি Google Workspace সদস্যতা তৈরি করে।

delete

 Google Workspace সাবস্ক্রিপশন মুছে দেয়।

get

 Google Workspace সাবস্ক্রিপশনের বিবরণ পান।

list

 Google Workspace সাবস্ক্রিপশনের তালিকা।

patch

 Google Workspace সাবস্ক্রিপশন আপডেট বা রিনিউ করে।

reactivate

 সাসপেন্ড করা Google Workspace সাবস্ক্রিপশন আবার চালু করে।