পুশ বিজ্ঞপ্তি

প্রয়োজনীয় বৈশিষ্ট্য

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

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

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

• একটি type প্রোপার্টি স্ট্রিং যা web_hook মানের সাথে সেট করা আছে।

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

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

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

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

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

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

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

  আপনি যদি বিজ্ঞপ্তি চ্যানেল টোকেন ব্যবহার করেন, তাহলে আমরা আপনাকে সুপারিশ করব যে:

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

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

• এই বিজ্ঞপ্তি চ্যানেলের জন্য যখন আপনি অ্যাডমিন SDK API বার্তা পাঠানো বন্ধ করতে চান, তখন একটি expiration সম্পত্তি স্ট্রিং একটি Unix টাইমস্ট্যাম্পে (মিলিসেকেন্ডে) সেট করা থাকে।

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

ঘড়ির প্রতিক্রিয়া

যদি watch অনুরোধটি সফলভাবে একটি বিজ্ঞপ্তি চ্যানেল তৈরি করে, তাহলে এটি একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে।

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

{
  "kind": "api#channel",
  "id": "reportsApiId",
  "resourceId": "o3hgv1538sdjfh",
  "resourceUri": "https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName",
  "token": "target=myApp-myFilesChannelDest",
  "expiration": 3600
}

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

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

প্রতিক্রিয়া সম্পর্কে আরও বিস্তারিত জানার জন্য, API রেফারেন্সে Activities রিসোর্সের জন্য watch পদ্ধতিটি দেখুন।

বার্তা সিঙ্ক করুন

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

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

আপনার রিসিভিং URL-এ অ্যাডমিন SDK API যে 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 থাকে। এই চ্যানেলের জন্য প্রতিটি পরবর্তী বিজ্ঞপ্তিতে একটি বার্তা নম্বর থাকে যা পূর্ববর্তীটির চেয়ে বড়, যদিও বার্তা নম্বরগুলি ক্রমানুসারে থাকবে না।

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

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

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

বিজ্ঞপ্তি বার্তার ফর্ম্যাটটি ব্যাখ্যা করুন

সমস্ত বিজ্ঞপ্তি বার্তায় HTTP হেডারের একটি সেট থাকে যার X-Goog- উপসর্গ থাকে। কিছু ধরণের বিজ্ঞপ্তিতে একটি বার্তার মূল অংশও অন্তর্ভুক্ত থাকতে পারে।

ক্রিয়াকলাপের বিজ্ঞপ্তি বার্তাগুলিতে অনুরোধের মূল অংশে নিম্নলিখিত তথ্য থাকে:

POST https://mydomain.com/notifications
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName
X-Goog-Resource-State:  eventName
X-Goog-Message-Number: 10

{
  "kind": "admin#reports#activity",
  "id": {
    "time": datetime,
    "uniqueQualifier": long,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "callerType": string,
    "email": string,
    "profileId": long
  },
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "name": string,
          "value": string,
          "intValue": long,
          "boolValue": boolean
        }
      ]
    }
  ]
}

POST https://mydomain.com/notifications
Content-Type: application/json; utf-8
Content-Length: 596
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret987df98743md8g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin?alt=json
X-Goog-Resource-State:  CREATE_USER
X-Goog-Message-Number: 23

{
  "kind": "admin#reports#activity",
  "id": {
    "time": "2013-09-10T18:23:35.808Z",
    "uniqueQualifier": "-0987654321",
    "applicationName": "admin",
    "customerId": "ABCD012345"
  },
  "actor": {
    "callerType": "USER",
    "email": "admin@example.com",
    "profileId": "0123456789987654321"
  },
  "ownerDomain": "apps-reporting.example.com",
  "ipAddress": "192.0.2.0",
  "events": [
    {
      "type": "USER_SETTINGS",
      "name": "CREATE_USER",
      "parameters": [
        {
          "name": "USER_EMAIL",
          "value": "liz@example.com"
        }
      ]
    }
  ]
}

বিজ্ঞপ্তির উত্তর দিন

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

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

অ্যাডমিন SDK API বিজ্ঞপ্তি ইভেন্টগুলি বুঝুন

এই বিভাগটি অ্যাডমিন SDK API-এর সাথে পুশ বিজ্ঞপ্তি ব্যবহার করার সময় আপনি যে বিজ্ঞপ্তি বার্তাগুলি পেতে পারেন তার বিশদ বিবরণ প্রদান করে।

রিপোর্ট API পুশ নোটিফিকেশনে দুই ধরণের মেসেজ থাকে: সিঙ্ক মেসেজ এবং ইভেন্ট নোটিফিকেশন। মেসেজের ধরণটি X-Goog-Resource-State HTTP হেডারে নির্দেশিত। ইভেন্ট নোটিফিকেশনের সম্ভাব্য মানগুলি activities.list পদ্ধতির মতোই। প্রতিটি অ্যাপ্লিকেশনের অনন্য ইভেন্ট রয়েছে:

• অ্যাডমিন
• ক্যালেন্ডার
• ড্রাইভ
• দল
• লগইন
• মোবাইল
• ছোট
• টোকেন
• ব্যবহারকারীর_অ্যাকাউন্ট