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

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

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

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

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

• একটি type প্রপার্টি স্ট্রিং মান web_hook সেট করে।

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

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

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

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

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

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

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

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

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

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

• আপনি যখন অ্যাডমিন SDK API এই বিজ্ঞপ্তি চ্যানেলের জন্য বার্তা পাঠানো বন্ধ করতে চান সেই তারিখ এবং সময়ের একটি ইউনিক্স টাইমস্ট্যাম্পে (মিলিসেকেন্ডে) একটি expiration সম্পত্তি স্ট্রিং সেট করা হয়েছে৷

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

প্রতিক্রিয়া দেখুন

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

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

{
  "kind": "api#channel",
  "id": "reportsApiId", // ID you specified for this channel.
  "resourceId": "o3hgv1538sdjfh", // ID of the watched resource.
  "resourceUri": "https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 3600, // Actual expiration time as Unix timestamp (in ms), if applicable.
}

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

আপনি প্রত্যাবর্তিত তথ্যগুলি অন্যান্য বিজ্ঞপ্তি চ্যানেল অপারেশনগুলিতে প্রেরণ করতে পারেন, যেমন আপনি যখন বিজ্ঞপ্তিগুলি পাওয়া বন্ধ করতে চান৷

প্রতিক্রিয়া সম্পর্কে আরও বিশদ বিবরণের জন্য, API রেফারেন্সে অ্যাক্টিভিটি রিসোর্সের জন্য watch পদ্ধতিটি পড়ুন।

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

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

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

অ্যাডমিন 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 HTTP শিরোনামে আপনার অ্যাপ্লিকেশন এই চ্যানেলের জন্য প্রাপ্ত প্রতিটি বিজ্ঞপ্তি বার্তায় মেয়াদ শেষ হওয়ার তারিখ এবং সময় অন্তর্ভুক্ত করা হয়েছে (মানুষ-পঠনযোগ্য বিন্যাসে)।

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

বিজ্ঞপ্তি বার্তা বিন্যাস ব্যাখ্যা

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

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

POST https://mydomain.com/notifications // Your receiving URL.
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 // Your receiving URL.
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 পদ্ধতির মতোই। প্রতিটি অ্যাপ্লিকেশন অনন্য ইভেন্ট আছে:

• অ্যাডমিন
• ক্যালেন্ডার
• ড্রাইভ
• গ্রুপ
• লগইন
• মোবাইল
• saml
• টোকেন
• user_accounts