সতর্কতা: এই ডেটাটি Google ব্যবহারকারী ডেটা নীতির অধীনে প্রদান করা হয়েছে। অনুগ্রহ করে পর্যালোচনা করুন এবং নীতি মেনে চলুন। এটি করতে ব্যর্থ হলে প্রকল্প বা অ্যাকাউন্ট সাসপেনশন হতে পারে।

ওয়েবসাইটের জন্য Google 3P অনুমোদন জাভাস্ক্রিপ্ট লাইব্রেরি - API রেফারেন্স

সেভ করা পৃষ্ঠা গুছিয়ে রাখতে 'সংগ্রহ' ব্যবহার করুন আপনার পছন্দ অনুযায়ী কন্টেন্ট সেভ করুন ও সঠিক বিভাগে রাখুন।

এই রেফারেন্সটি Google 3P অনুমোদন জাভাস্ক্রিপ্ট লাইব্রেরি API বর্ণনা করে, যা আপনি অনুমোদন কোড লোড করতে বা Google থেকে টোকেন অ্যাক্সেস করতে ব্যবহার করতে পারেন।

পদ্ধতি: google.accounts.oauth2.initCodeClient

initCodeClient পদ্ধতিটি প্যারামিটারে কনফিগারেশন সহ একটি কোড ক্লায়েন্টকে শুরু করে এবং ফেরত দেয়।

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

ডেটা টাইপ: CodeClientConfig

নিম্নলিখিত সারণী CodeClientConfig ডেটা টাইপের বৈশিষ্ট্যগুলি তালিকাভুক্ত করে।

বৈশিষ্ট্য
client_id প্রয়োজন। আপনার আবেদনের জন্য ক্লায়েন্ট আইডি। আপনি API কনসোলে এই মানটি খুঁজে পেতে পারেন।
scope প্রয়োজন। স্কোপের একটি স্থান-সীমাবদ্ধ তালিকা যা ব্যবহারকারীর পক্ষ থেকে আপনার অ্যাপ্লিকেশন অ্যাক্সেস করতে পারে এমন সংস্থানগুলি সনাক্ত করে৷ এই মানগুলি সম্মতি স্ক্রীনকে জানায় যা Google ব্যবহারকারীকে প্রদর্শন করে।
redirect_uri UX পুনঃনির্দেশের জন্য প্রয়োজনীয়। ব্যবহারকারী অনুমোদন প্রবাহ সম্পূর্ণ করার পরে API সার্ভার ব্যবহারকারীকে কোথায় রিডাইরেক্ট করে তা নির্ধারণ করে। মানটি অবশ্যই OAuth 2.0 ক্লায়েন্টের জন্য অনুমোদিত রিডাইরেক্ট ইউআরআইগুলির একটির সাথে মিলতে হবে, যা আপনি API কনসোলে কনফিগার করেছেন এবং অবশ্যই আমাদের পুনঃনির্দেশ URI বৈধতা নিয়ম মেনে চলতে হবে। সম্পত্তি পপআপ UX দ্বারা উপেক্ষা করা হবে.
callback পপআপ UX এর জন্য প্রয়োজনীয়। জাভাস্ক্রিপ্ট ফাংশনের নাম যা প্রত্যাবর্তিত কোড প্রতিক্রিয়া পরিচালনা করে। সম্পত্তি পুনর্নির্দেশ UX দ্বারা উপেক্ষা করা হবে.
state ঐচ্ছিক। UX পুনঃনির্দেশের জন্য প্রস্তাবিত। আপনার অনুমোদনের অনুরোধ এবং অনুমোদন সার্ভারের প্রতিক্রিয়ার মধ্যে অবস্থা বজায় রাখতে আপনার অ্যাপ্লিকেশন ব্যবহার করে এমন কোনো স্ট্রিং মান নির্দিষ্ট করে।
enable_serial_consent ঐচ্ছিক, ডিফল্ট থেকে truefalse সেট করা হলে, 2019-এর আগে তৈরি করা ক্লায়েন্টদের জন্য আরও দানাদার Google অ্যাকাউন্টের অনুমতিগুলি অক্ষম করা হবে। নতুন ক্লায়েন্টদের জন্য কোনও প্রভাব নেই, কারণ তাদের জন্য আরও দানাদার অনুমতি সবসময় সক্ষম থাকে।
hint ঐচ্ছিক। আপনার অ্যাপ্লিকেশান যদি জানে যে কোন ব্যবহারকারীর অনুরোধ অনুমোদন করা উচিত, তাহলে এটি Google-কে একটি ইঙ্গিত দিতে এই সম্পত্তি ব্যবহার করতে পারে৷ লক্ষ্য ব্যবহারকারীর জন্য ইমেল ঠিকানা. আরও তথ্যের জন্য, OpenID Connect login_hint ক্ষেত্রটি দেখুন।
hosted_domain ঐচ্ছিক। ব্যবহারকারী যে ওয়ার্কস্পেস ডোমেনের অন্তর্গত আপনার অ্যাপ্লিকেশান যদি জানেন, তাহলে Google-কে একটি ইঙ্গিত দিতে এটি ব্যবহার করুন। আরও তথ্যের জন্য, OpenID Connect ডক্সে hd ক্ষেত্রটি দেখুন।
ux_mode ঐচ্ছিক। অনুমোদন প্রবাহের জন্য ব্যবহার করার জন্য UX মোড। ডিফল্টরূপে, এটি একটি পপআপে সম্মতির প্রবাহ খুলবে। বৈধ মানগুলি হল popup এবং redirect
select_account ঐচ্ছিক, ডিফল্ট থেকে 'false' । বুলিয়ান মান ব্যবহারকারীকে একটি অ্যাকাউন্ট নির্বাচন করতে অনুরোধ জানায়।

ডেটা টাইপ: কোডক্লায়েন্ট

ক্লাসে শুধুমাত্র একটি পাবলিক পদ্ধতি অনুরোধ কোড আছে, যা OAuth 2.0 কোড UX প্রবাহ শুরু করে।

interface CodeClient {
  requestCode(): void;
}

ডেটা টাইপ: CodeResponse

একটি CodeResponse JavaScript অবজেক্ট পপআপ UX-এ আপনার callback পদ্ধতিতে পাঠানো হবে। রিডাইরেক্ট UX-এ, CodeResponse URL প্যারামিটার হিসাবে পাস করা হবে।

নিম্নলিখিত সারণী CodeResponse ডেটা টাইপের বৈশিষ্ট্যগুলি তালিকাভুক্ত করে৷

বৈশিষ্ট্য
code একটি সফল টোকেন প্রতিক্রিয়ার অনুমোদন কোড।
scope ব্যবহারকারীর দ্বারা অনুমোদিত স্কোপের একটি স্থান-সীমাবদ্ধ তালিকা।
state আপনার অনুমোদনের অনুরোধ এবং প্রতিক্রিয়ার মধ্যে অবস্থা বজায় রাখতে আপনার অ্যাপ্লিকেশনটি যে স্ট্রিং মান ব্যবহার করে।
error একটি একক ASCII ত্রুটি কোড।
error_description মানব-পঠনযোগ্য ASCII পাঠ্য অতিরিক্ত তথ্য প্রদান করে, যে ত্রুটিটি ঘটেছে তা বুঝতে ক্লায়েন্ট বিকাশকারীকে সহায়তা করতে ব্যবহৃত হয়।
error_uri একটি URI ত্রুটি সম্পর্কে তথ্য সহ একটি মানব-পাঠযোগ্য ওয়েব পৃষ্ঠা সনাক্ত করে, যা ক্লায়েন্ট বিকাশকারীকে ত্রুটি সম্পর্কে অতিরিক্ত তথ্য প্রদান করতে ব্যবহৃত হয়।

পদ্ধতি: google.accounts.oauth2.initTokenClient

initTokenClient পদ্ধতিটি প্যারামিটারে কনফিগারেশন সহ একটি টোকেন ক্লায়েন্ট শুরু করে এবং ফেরত দেয়।

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

ডেটা টাইপ: TokenClientConfig

নিম্নলিখিত টেবিলে TokenClientConfig ডেটা টাইপের বৈশিষ্ট্যগুলি তালিকাভুক্ত করা হয়েছে।

বৈশিষ্ট্য
client_id প্রয়োজন। আপনার আবেদনের জন্য ক্লায়েন্ট আইডি। আপনি API কনসোলে এই মানটি খুঁজে পেতে পারেন।
callback প্রয়োজন। জাভাস্ক্রিপ্ট ফাংশনের নাম যা প্রত্যাবর্তিত টোকেন প্রতিক্রিয়া পরিচালনা করে।
scope প্রয়োজন। স্কোপের একটি স্থান-সীমাবদ্ধ তালিকা যা ব্যবহারকারীর পক্ষ থেকে আপনার অ্যাপ্লিকেশন অ্যাক্সেস করতে পারে এমন সংস্থানগুলি সনাক্ত করে৷ এই মানগুলি সম্মতি স্ক্রীনকে জানায় যা Google ব্যবহারকারীকে প্রদর্শন করে।
prompt ঐচ্ছিক, 'select_account'-এ ডিফল্ট। ব্যবহারকারীকে উপস্থাপন করার জন্য প্রম্পটের একটি স্থান-বিভাজিত, কেস-সংবেদনশীল তালিকা। সম্ভাব্য মান হল:
  • খালি স্ট্রিং ব্যবহারকারীকে শুধুমাত্র প্রথমবার আপনার অ্যাপ অ্যাক্সেসের অনুরোধ জানানো হবে। অন্যান্য মান দিয়ে নির্দিষ্ট করা যাবে না।
  • 'কিছুই নয়' কোনো প্রমাণীকরণ বা সম্মতি স্ক্রীন প্রদর্শন করবেন না। অন্যান্য মানের সাথে নির্দিষ্ট করা উচিত নয়।
  • 'সম্মতি' ব্যবহারকারীকে সম্মতির জন্য অনুরোধ করুন।
  • 'select_account' ব্যবহারকারীকে একটি অ্যাকাউন্ট নির্বাচন করতে অনুরোধ করুন।
enable_serial_consent ঐচ্ছিক, ডিফল্ট থেকে truefalse সেট করা হলে, 2019-এর আগে তৈরি করা ক্লায়েন্টদের জন্য আরও দানাদার Google অ্যাকাউন্টের অনুমতিগুলি অক্ষম করা হবে। নতুন ক্লায়েন্টদের জন্য কোনও প্রভাব নেই, কারণ তাদের জন্য আরও দানাদার অনুমতি সবসময় সক্ষম থাকে।
hint ঐচ্ছিক। আপনার অ্যাপ্লিকেশান যদি জানে যে কোন ব্যবহারকারীর অনুরোধ অনুমোদন করা উচিত, তাহলে এটি Google-কে একটি ইঙ্গিত দিতে এই সম্পত্তি ব্যবহার করতে পারে৷ লক্ষ্য ব্যবহারকারীর জন্য ইমেল ঠিকানা. আরও তথ্যের জন্য, OpenID Connect login_hint ক্ষেত্রটি দেখুন।
hosted_domain ঐচ্ছিক। ব্যবহারকারী যে ওয়ার্কস্পেস ডোমেনের অন্তর্গত আপনার অ্যাপ্লিকেশান যদি জানেন, তাহলে Google-কে একটি ইঙ্গিত দিতে এটি ব্যবহার করুন। আরও তথ্যের জন্য, OpenID Connect ডক্সে hd ক্ষেত্রটি দেখুন।
state ঐচ্ছিক। সুপারিশ করা হয় না. আপনার অনুমোদনের অনুরোধ এবং অনুমোদন সার্ভারের প্রতিক্রিয়ার মধ্যে অবস্থা বজায় রাখতে আপনার অ্যাপ্লিকেশন ব্যবহার করে এমন কোনো স্ট্রিং মান নির্দিষ্ট করে।

ডেটা টাইপ: টোকেনক্লায়েন্ট

requestAccessToken শুধুমাত্র একটি পাবলিক পদ্ধতি অনুরোধ অ্যাকসেসটোকেন রয়েছে, যা OAuth 2.0 টোকেন UX প্রবাহ শুরু করে।

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}
যুক্তি
overrideConfig OverridableTokenClientConfig ঐচ্ছিক। এই পদ্ধতিতে ওভাররাইড করা কনফিগারেশন।

ডেটা টাইপ: OverridableTokenClientConfig

নিচের সারণীতে OverridableTokenClientConfig ডেটা টাইপের বৈশিষ্ট্যের তালিকা রয়েছে।

বৈশিষ্ট্য
prompt ঐচ্ছিক। ব্যবহারকারীকে উপস্থাপন করার জন্য প্রম্পটের একটি স্থান-বিভাজিত, কেস-সংবেদনশীল তালিকা।
enable_serial_consent ঐচ্ছিক। false সেট করা হলে, 2019-এর আগে তৈরি করা ক্লায়েন্টদের জন্য আরও দানাদার Google অ্যাকাউন্টের অনুমতিগুলি অক্ষম করা হবে। নতুন ক্লায়েন্টদের জন্য কোনও প্রভাব নেই, কারণ তাদের জন্য আরও দানাদার অনুমতি সবসময় সক্ষম থাকে।
hint ঐচ্ছিক। আপনার অ্যাপ্লিকেশান যদি জানে যে কোন ব্যবহারকারীর অনুরোধ অনুমোদন করা উচিত, তাহলে এটি Google-কে একটি ইঙ্গিত দিতে এই সম্পত্তি ব্যবহার করতে পারে৷ লক্ষ্য ব্যবহারকারীর জন্য ইমেল ঠিকানা. আরও তথ্যের জন্য, OpenID Connect login_hint ক্ষেত্রটি দেখুন।
state ঐচ্ছিক। সুপারিশ করা হয় না. আপনার অনুমোদনের অনুরোধ এবং অনুমোদন সার্ভারের প্রতিক্রিয়ার মধ্যে অবস্থা বজায় রাখতে আপনার অ্যাপ্লিকেশন ব্যবহার করে এমন কোনো স্ট্রিং মান নির্দিষ্ট করে।

ডেটা টাইপ: টোকেন রেসপন্স

একটি TokenResponse JavaScript অবজেক্ট পপআপ UX-এ আপনার কলব্যাক পদ্ধতিতে পাঠানো হবে।

নিম্নলিখিত সারণী TokenResponse ডেটা টাইপের বৈশিষ্ট্যগুলি তালিকাভুক্ত করে।

বৈশিষ্ট্য
access_token একটি সফল টোকেন প্রতিক্রিয়ার অ্যাক্সেস টোকেন।
expires_in অ্যাক্সেস টোকেনের সেকেন্ডে জীবনকাল।
hd সাইন-ইন করা ব্যবহারকারী যে হোস্ট করা ডোমেনটির অন্তর্গত।
prompt প্রম্পট মান যা TokenClientConfig বা OverridableTokenClientConfig দ্বারা নির্দিষ্ট করা মানগুলির সম্ভাব্য তালিকা থেকে ব্যবহৃত হয়েছিল।
token_type জারি করা টোকেনের ধরন।
scope ব্যবহারকারীর দ্বারা অনুমোদিত স্কোপের একটি স্থান-সীমাবদ্ধ তালিকা।
state আপনার অনুমোদনের অনুরোধ এবং প্রতিক্রিয়ার মধ্যে অবস্থা বজায় রাখতে আপনার অ্যাপ্লিকেশনটি যে স্ট্রিং মান ব্যবহার করে।
error একটি একক ASCII ত্রুটি কোড।
error_description মানব-পঠনযোগ্য ASCII পাঠ্য অতিরিক্ত তথ্য প্রদান করে, যে ত্রুটিটি ঘটেছে তা বুঝতে ক্লায়েন্ট বিকাশকারীকে সহায়তা করতে ব্যবহৃত হয়।
error_uri একটি URI ত্রুটি সম্পর্কে তথ্য সহ একটি মানব-পাঠযোগ্য ওয়েব পৃষ্ঠা সনাক্ত করে, যা ক্লায়েন্ট বিকাশকারীকে ত্রুটি সম্পর্কে অতিরিক্ত তথ্য প্রদান করতে ব্যবহৃত হয়।

পদ্ধতি: google.accounts.oauth2.hasGrantedAllScopes

ব্যবহারকারী সমস্ত নির্দিষ্ট সুযোগ বা সুযোগ মঞ্জুর করেছে কিনা তা পরীক্ষা করে।

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;
যুক্তি
tokenResponse স্ট্রিং প্রয়োজন। একটি বৈধ অ্যাক্সেস টোকেন।
firstScope স্ট্রিং প্রয়োজন। যাচাই করার সুযোগ।
restScopes স্ট্রিং[] ঐচ্ছিক। চেক করার জন্য অন্যান্য সুযোগ।
রিটার্নস
বুলিয়ান সমস্ত সুযোগ মঞ্জুর করা হলে সত্য।

পদ্ধতি: google.accounts.oauth2.hasGrantedAnyScope

ব্যবহারকারী নির্দিষ্ট স্কোপ বা স্কোপ মঞ্জুর করেছেন কিনা তা পরীক্ষা করে।

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;
যুক্তি
tokenResponse স্ট্রিং প্রয়োজন। একটি বৈধ অ্যাক্সেস টোকেন।
firstScope স্ট্রিং প্রয়োজন। যাচাই করার সুযোগ।
restScopes স্ট্রিং[] ঐচ্ছিক। চেক করার জন্য অন্যান্য সুযোগ।
রিটার্নস
বুলিয়ান স্কোপ মঞ্জুর করা হয় যদি সত্য.

পদ্ধতি: google.accounts.oauth2.revoke

revoke পদ্ধতিটি ব্যবহারকারীর অ্যাপে দেওয়া সমস্ত সুযোগ প্রত্যাহার করে। অনুমতি প্রত্যাহার করার জন্য একটি বৈধ অ্যাক্সেস টোকেন প্রয়োজন৷

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
যুক্তি
accessToken স্ট্রিং প্রয়োজন। একটি বৈধ অ্যাক্সেস টোকেন।
done ফাংশন ঐচ্ছিক। কলব্যাক ফাংশন একবার প্রত্যাহার করা হয়।