Videos: batchGetStats

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

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

درخواست

درخواست 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 را که با کاما از هم جدا شده‌اند و پاسخ API شامل آنها خواهد بود، مشخص می‌کند. لیست زیر شامل نام part است که می‌توانید در مقدار پارامتر قرار دهید: contentDetails id snippet statistics
پارامترهای اختیاری
onBehalfOfContentOwner	string این پارامتر فقط می‌تواند در یک درخواست با مجوز صحیح استفاده شود. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان می‌دهد که اعتبارنامه‌های مجوز درخواست، یک کاربر YouTube CMS را شناسایی می‌کنند که از طرف مالک محتوای مشخص شده در مقدار پارامتر عمل می‌کند. این پارامتر برای شرکای محتوای 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 نوع منبع API را مشخص می‌کند. مقدار آن youtube#batchGetStatsResponse خواهد بود.
etag	etag برچسب E این منبع.
items[]	list فهرستی از آمار ویدیو که با معیارهای درخواست مطابقت دارد.
items[]. id	string شناسه‌ای که یوتیوب برای شناسایی منحصر به فرد ویدیو از آن استفاده می‌کند.
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 هیچ پیام خطایی را که منحصر به این متد API باشد، تعریف نمی‌کند. با این حال، این متد همچنان می‌تواند خطاهای عمومی API را که در مستندات پیام خطا ذکر شده است، برگرداند.