Videos: batchGetStats

فهرستی از آمار ویدیو را که با پارامترهای درخواست میانای برنامه‌سازی کاربردی مطابقت دارد بازیابی می‌کند.

تأثیر سهمیه: تماس با این روش هزینه سهمیه ۱ واحدی دارد.

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/videos:batchGetStats

صدور مجوز

برای استفاده از این روش در ویدیوهای غیرعمومی، اصالت‌سنجی لازم است، اما برای ویدیوهای عمومی لازم نیست. اگر مجوز ارائه شده باشد، درخواست باید با حداقل یکی از دامنه‌های زیر مجاز شود (درباره اصالت‌سنجی و صدور مجوز بیشتر بخوانید).

حوزه
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

پارامترها

جدول زیر پارامترهایی را که این پُرسمان پشتیبانی می‌کند فهرست می‌کند. همه پارامترهای فهرست‌شده پارامترهای پُرسمان هستند.

پارامترها
پارامترهای الزامی
id	string پارامتر id فهرستی جداشده با کاما از شناسه(های) ویدیو YouTube برای منبع(هایی) که بازیابی می‌شوند را مشخص می‌کند. در منبع videoStat، دارایی id شناسه ویدیو را مشخص می‌کند.
part	string پارامتر part فهرست جداشده با کاما از یک یا چند ویژگی منبع videoStat را که پاسخ میانای برنامه‌سازی کاربردی شامل خواهد شد مشخص می‌کند. فهرست زیر حاوی نام‌های part است که می‌توانید در مقدار پارامتر اضافه کنید: contentDetails id snippet statistics
پارامترهای اختیاری
onBehalfOfContentOwner	string از این پارامتر فقط می‌توان در درخواست مجاز مناسب استفاده کرد. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان می‌دهد که اطلاعات کاربری مجوز درخواست، کاربر CMS YouTube را شناسایی می‌کند که از طرف مالک محتوای مشخص‌شده در مقدار پارامتر عمل می‌کند. این پارامتر برای شرکای محتوای YouTube که مالک و مدیر بسیاری از کانال‌های مختلف YouTube هستند درنظر گرفته شده است. این ویژگی به مالکان محتوا امکان می‌دهد یک‌بار اصالت‌سنجی کنند و به تمام داده‌های ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال جداگانه اطلاعات اصالت‌سنجی ارائه دهند. حساب CMS که کاربر با آن اصالت‌سنجی می‌کند باید به مالک محتوای YouTube مشخص‌شده پیوند داده شود.

متن درخواست

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

پاسخ

درصورت موفقیت‌آمیز بودن، این روش بدنه پاسخی با ساختار زیر برمی‌گرداند:

{
  "kind": "youtube#batchGetStatsResponse",
  "etag": etag,
  "items": [
    {
      "kind": "youtube#videoStats",
      "etag": etag,
      "id": string,
      "snippet": {
        "publishTime": datetime
      },
      "statistics": {
        "viewCount": unsigned long,
        "likeCount": unsigned long,
        "commentCount": unsigned long
      },
      "contentDetails": {
        "duration": string,
        "durationMillis": unsigned long
      }
    }
  ],
  "summary": {
    "requestedVideoCount": unsigned long,
    "succeededVideoCount": unsigned long,
    "failedVideoCount": unsigned long,
    "failedVideoIds": [
      string
    ]
  }
}

مشخصات

جدول زیر ویژگی‌هایی را که در این منبع ظاهر می‌شوند تعریف می‌کند:

مشخصات
kind	string نوع منبع میانای برنامه‌سازی کاربردی را مشخص می‌کند. مقدار youtube#batchGetStatsResponse خواهد بود.
etag	etag Etag این منبع.
items[]	list فهرستی از آمار ویدیو که با معیارهای درخواست مطابقت دارد.
items[].id	string شناسه‌ای که YouTube برای شناسایی یکتای ویدیو استفاده می‌کند.
items[].snippet.publishTime	datetime تاریخ و زمان بارگذاری ویدیو.
items[].statistics.viewCount	unsigned long تعداد دفعاتی که ویدیو بازدید شده است.
items[].statistics.likeCount	unsigned long تعداد کاربرانی که نشان داده‌اند ویدیو را پسندیده‌اند.
items[].statistics.commentCount	unsigned long تعداد نظرات ویدیو.
items[].contentDetails.duration	string طول ویدیو.
items[].contentDetails.durationMillis	unsigned long طول ویدیو برحسب میلی‌ثانیه.
summary	object خلاصه درخواست batchGetStats.
summary.requestedVideoCount	unsigned long تعداد ویدیوهای درخواست‌شده.
summary.succeededVideoCount	unsigned long تعداد ویدیوهایی که موفق بودند.
summary.failedVideoCount	unsigned long تعداد ویدیوهایی که ناموفق بوده‌اند.
summary.failedVideoIds[]	list شناسه‌های ویدیویی که ناموفق بوده‌اند.

خطاها

این میانای برنامه‌سازی کاربردی هیچ پیام خطایی که مختص این روش میانای برنامه‌سازی کاربردی باشد تعریف نمی‌کند. بااین‌حال، این روش همچنان می‌تواند خطاهای عمومی API را که در سند پیام خطا فهرست شده است برگرداند.