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