API অনুরোধের মাপকাঠির সাথে মেলে এমন সাবস্ক্রিপশন রিসোর্স দেখায়।
কোটার উপর প্রভাব: এই পদ্ধতিতে কল করার জন্য ১ ইউনিট কোটা খরচ হয়।
সাধারণ ব্যবহারিক ক্ষেত্র
অনুরোধ করুন
HTTP অনুরোধ
GET https://www.googleapis.com/youtube/v3/subscriptions
প্যারামিটারগুলি
এই কোয়েরিতে যেসব প্যারামিটার কাজ করে তা নিম্নলিখিত সারণীতে দেওয়া হল। তালিকাবদ্ধ সব প্যারামিটার হল কোয়েরি প্যারামিটার।
| প্যারামিটারগুলি | ||
|---|---|---|
| প্রয়োজনীয় প্যারামিটার | ||
part |
stringpart প্যারামিটার এক বা একাধিক subscription রিসোর্স প্রপার্টির কমা দ্বারা আলাদা করা তালিকা নির্দিষ্ট করে যা API রেসপন্সে অন্তর্ভুক্ত করা হবে।প্যারামিটারটি যদি এমন কোনও প্রপার্টি শনাক্ত করে যাতে চাইল্ড প্রপার্টি আছে, তাহলে চাইল্ড প্রপার্টিগুলি রেসপন্সে অন্তর্ভুক্ত করা হবে। যেমন, subscription রিসোর্সে, snippet প্রপার্টিতে অন্যান্য প্রপার্টি থাকে, যেমন সাবস্ক্রিপশনের জন্য ডিসপ্লে শীর্ষক। আপনি part=snippet সেট করলে, API রেসপন্সেও সেইসব নেস্টেড প্রপার্টি থাকবে।নিচের তালিকায় part নাম আছে যা আপনি প্যারামিটারের মানে যোগ করতে পারবেন:
|
|
| ফিল্টার (নিম্নলিখিত প্যারামিটারের মধ্যে ঠিক একটি উল্লেখ করুন) | ||
channelId |
stringchannelId প্যারামিটার একটি YouTube চ্যানেল আইডি নির্দিষ্ট করে। API শুধুমাত্র সেই চ্যানেলের সাবস্ক্রিপশন সংক্রান্ত তথ্য রিটার্ন করবে। |
|
id |
stringid প্যারামিটারটি সেইসব রিসোর্সের জন্য YouTube সাবস্ক্রিপশন আইডির কমা-দ্বারা আলাদা করা তালিকা নির্দিষ্ট করে যেগুলি রিট্রিভ করা হচ্ছে। subscription রিসোর্সে, id প্রপার্টি YouTube সাবস্ক্রিপশন আইডি নির্দিষ্ট করে। |
|
mine |
booleanএই প্যারামিটার শুধুমাত্র সঠিকভাবে অনুমোদিত অনুরোধে ব্যবহার করা যেতে পারে। যাচাইকৃত ব্যবহারকারীর সাবস্ক্রিপশনের ফিড পেতে এই প্যারামিটারের ভ্যালু true-এ সেট করুন। |
|
myRecentSubscribers |
booleanএই প্যারামিটার শুধুমাত্র সঠিকভাবে অনুমোদিত অনুরোধে ব্যবহার করা যেতে পারে। এই প্যারামিটারের ভ্যালু true হিসেবে সেট করলে, যাচাই করা ব্যবহারকারীর সাবস্ক্রাইবারদের ফিড
উল্টো কালানুক্রমিক ক্রমে (সবচেয়ে নতুন প্রথমে) পাওয়া যাবে।মনে রাখবেন, এই API-এর মাধ্যমে রিটার্ন করা সাবস্ক্রাইবারদের সর্বাধিক সংখ্যা সীমিত হতে পারে। |
|
mySubscribers |
booleanএই প্যারামিটার শুধুমাত্র সঠিকভাবে অনুমোদিত অনুরোধে ব্যবহার করা যেতে পারে। এই প্যারামিটারের ভ্যালু true হিসেবে সেট করলে, যাচাই করা ব্যবহারকারীর সাবস্ক্রাইবারদের ফিড
কোনও নির্দিষ্ট ক্রম ছাড়াই পাওয়া যাবে। মনে রাখবেন, এই API-এর মাধ্যমে রিটার্ন করা সাবস্ক্রাইবারের সর্বাধিক সংখ্যা সীমিত
হতে পারে।
|
|
| ঐচ্ছিক প্যারামিটার | ||
forChannelId |
stringforChannelId প্যারামিটারটি চ্যানেল আইডির কমা-দ্বারা আলাদা করা তালিকা নির্দিষ্ট করে। API রেসপন্সে শুধুমাত্র সেইসব চ্যানেলের সাথে ম্যাচ করা সাবস্ক্রিপশন থাকবে। |
|
maxResults |
unsigned integermaxResults প্যারামিটারটি ফলাফল সেটে সর্বাধিক কতগুলি আইটেম দেখানো উচিত তা নির্দিষ্ট করে। গ্রহণযোগ্য ভ্যালু হল 0 থেকে 50, অন্তর্ভুক্ত। ডিফল্ট ভ্যালু হল 5। |
|
onBehalfOfContentOwner |
stringমনে রাখবেন: এই প্যারামিটারটি শুধুমাত্র YouTube কন্টেন্ট পার্টনারদের জন্য তৈরি করা হয়েছে। onBehalfOfContentOwner প্যারামিটারটি ইঙ্গিত করে যে অনুরোধের অনুমোদনের ক্রেডেনশিয়াল YouTube CMS ব্যবহারকারীকে শনাক্ত করে, যিনি প্যারামিটার ভ্যালুতে উল্লেখ করা কন্টেন্টের মালিকের হয়ে কাজ করছেন। এই প্যারামিটারটি YouTube কন্টেন্ট পার্টনারদের জন্য তৈরি করা হয়েছে যারা একাধিক YouTube চ্যানেলের মালিকানা ও ম্যানেজমেন্ট করেন। এটি কন্টেন্টের মালিকদের একবার যাচাইকরণ করার এবং প্রতিটি চ্যানেলের জন্য আলাদাভাবে যাচাইকরণ সংক্রান্ত ক্রেডেনশিয়াল প্রদান না করেই তাদের সমস্ত ভিডিও এবং চ্যানেল ডেটা অ্যাক্সেস করার অনুমতি দেয়। ব্যবহারকারী যে CMS অ্যাকাউন্ট দিয়ে যাচাইকরণ করবেন সেটি অবশ্যই নির্দিষ্ট YouTube কন্টেন্ট মালিকের সাথে লিঙ্ক করা থাকতে হবে। |
|
onBehalfOfContentOwnerChannel |
stringএই প্যারামিটার শুধুমাত্র সঠিকভাবে অনুমোদিত অনুরোধে ব্যবহার করা যেতে পারে। মনে রাখবেন: এই প্যারামিটারটি শুধুমাত্র YouTube কন্টেন্ট পার্টনারদের জন্য। onBehalfOfContentOwnerChannel প্যারামিটারটি সেই চ্যানেলের YouTube চ্যানেল আইডি নির্দিষ্ট করে যেখানে একটি ভিডিও যোগ করা হচ্ছে। কোনও অনুরোধে onBehalfOfContentOwner প্যারামিটারের জন্য কোনও ভ্যালু নির্দিষ্ট করা থাকলে এই প্যারামিটারটি প্রয়োজন এবং এটি শুধুমাত্র সেই প্যারামিটারের সাথে ব্যবহার করা যেতে পারে। এছাড়াও, onBehalfOfContentOwner প্যারামিটার দ্বারা নির্দিষ্ট করা কন্টেন্টের মালিকের সাথে লিঙ্ক করা CMS অ্যাকাউন্ট ব্যবহার করে অনুরোধটি অনুমোদিত হতে হবে। সবশেষে, onBehalfOfContentOwnerChannel প্যারামিটার ভ্যালু যে চ্যানেলকে নির্দিষ্ট করে, সেটি অবশ্যই onBehalfOfContentOwner প্যারামিটার দ্বারা নির্দিষ্ট করা কন্টেন্ট মালিকের সাথে লিঙ্ক করা থাকতে হবে।এই প্যারামিটারটি সেইসব YouTube কন্টেন্ট পার্টনারদের জন্য তৈরি করা হয়েছে যারা একাধিক YouTube চ্যানেলের মালিকানা ও ম্যানেজমেন্ট করেন। এটি কন্টেন্টের মালিকদের একবার প্রমাণীকরণ করতে এবং প্রতিটি আলাদা চ্যানেলের জন্য প্রমাণীকরণ ক্রেডেনশিয়াল প্রদান না করেই প্যারামিটার ভ্যালুতে নির্দিষ্ট করা চ্যানেলের হয়ে অ্যাকশন পারফর্ম করতে দেয়। |
|
order |
stringorder প্যারামিটারটি API রেসপন্সে রিসোর্স সাজানোর জন্য ব্যবহার করা পদ্ধতি নির্দিষ্ট করে। ডিফল্ট ভ্যালু হল SUBSCRIPTION_ORDER_RELEVANCE।গ্রহণযোগ্য ভ্যালু হল:
|
|
pageToken |
stringpageToken প্যারামিটারটি ফলাফল সেটের একটি নির্দিষ্ট পৃষ্ঠা শনাক্ত করে যা ফেরত দেওয়া উচিত। API রেসপন্সে, nextPageToken এবং prevPageToken প্রপার্টি অন্যান্য পৃষ্ঠা শনাক্ত করে যা ফিরিয়ে আনা যেতে পারে। |
|
অনুরোধের বডি
এই পদ্ধতি কল করার সময় অনুরোধের বডি প্রদান করবেন না।
রেসপন্স
সফল হলে, এই পদ্ধতিটি নিম্নলিখিত স্ট্রাকচার সহ একটি রেসপন্স বডি প্রদান করে:
{
"kind": "youtube#subscriptionListResponse",
"etag": etag,
"nextPageToken": string,
"prevPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
subscription Resource
]
}প্রপার্টি
এই রিসোর্সে যেসব প্রপার্টি দেখা যায়, নিম্নলিখিত সারণীতে সেগুলি সম্পর্কে বলা হয়েছে:
| প্রপার্টি | |
|---|---|
kind |
stringAPI রিসোর্সের ধরন শনাক্ত করে। ভ্যালু youtube#subscriptionListResponse হবে। |
etag |
etagএই রিসোর্সের Etag. |
nextPageToken |
stringফলাফলের সেটে পরবর্তী পৃষ্ঠাটি পেতে pageToken প্যারামিটারের ভ্যালু হিসেবে ব্যবহার করা যেতে পারে এমন টোকেন। |
prevPageToken |
stringফলাফলের সেটে আগের পৃষ্ঠা ফিরিয়ে আনতে pageToken প্যারামিটারের ভ্যালু হিসেবে যে টোকেন ব্যবহার করা যেতে পারে। |
pageInfo |
objectpageInfo অবজেক্টটি ফলাফল সেটের জন্য পেজিং তথ্য এনক্যাপসুলেট করে। |
pageInfo.totalResults |
integerফলাফলের সেটে ফলাফলের মোট সংখ্যা। |
pageInfo.resultsPerPage |
integerAPI রেসপন্সে অন্তর্ভুক্ত ফলাফলের সংখ্যা। |
items[] |
listঅনুরোধের মাপকাঠি পূরণ করে এমন সাবস্ক্রিপশনের তালিকা। |
সমস্যা
এই পদ্ধতিতে কল করার উত্তরে API যেসব সমস্যার মেসেজ পাঠাতে পারে, তা নিম্নলিখিত টেবিলে শনাক্ত করা হয়েছে। আরও বিবরণের জন্য সমস্যার মেসেজ সংক্রান্ত ডকুমেন্টেশন দেখুন।
| সমস্যার ধরন | সমস্যার বিবরণ | বিবরণ |
|---|---|---|
forbidden (403) |
accountClosed |
সাবস্ক্রিপশন ফিরিয়ে আনা যায়নি কারণ সাবস্ক্রাইবারের অ্যাকাউন্ট বন্ধ হয়ে গেছে। |
forbidden (403) |
accountSuspended |
সাবস্ক্রিপশন ফিরিয়ে আনা যায়নি কারণ সাবস্ক্রাইবারের অ্যাকাউন্ট সাসপেন্ড করা হয়েছে। |
forbidden (403) |
subscriptionForbidden |
অনুরোধকারীকে অনুরোধ করা সাবস্ক্রিপশন অ্যাক্সেস করার অনুমতি দেওয়া হয়নি। |
notFound (404) |
subscriberNotFound |
অনুরোধে উল্লেখ করা সাবস্ক্রাইবারকে খুঁজে পাওয়া যায়নি। |
এটি ব্যবহার করে দেখুন!
এই API কল করতে এবং API অনুরোধ ও উত্তর দেখতে APIs Explorer ব্যবহার করুন।