YouTube Reporting API - Get Bulk Data Reports

API گزارش‌دهی یوتیوب از گزارش‌های از پیش تعریف‌شده‌ای پشتیبانی می‌کند که شامل مجموعه‌ای جامع از داده‌های YouTube Analytics برای یک کانال یا مالک محتوا هستند. این گزارش‌ها به شما امکان می‌دهند مجموعه داده‌های انبوهی را که می‌توانید با API YouTube Analytics یا در بخش Analytics استودیوی Creator جستجو کنید، دانلود کنید.

این API همچنین از مجموعه‌ای از گزارش‌های مدیریت‌شده توسط سیستم که به‌طور خودکار ایجاد می‌شوند، پشتیبانی می‌کند که در دسترس مالکان محتوا قرار دارند و به گزارش‌های مربوطه در منوی گزارش‌ها دسترسی دارند. این گزارش‌ها حاوی داده‌های درآمد حاصل از تبلیغات و داده‌های درآمد حاصل از اشتراک YouTube Premium هستند. برای اطلاعات بیشتر به مستندات گزارش‌های مدیریت‌شده توسط سیستم مراجعه کنید.

نمای کلی

فیلدهای گزارش در این گزارش‌ها به صورت ابعاد یا معیارها مشخص می‌شوند:

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

به عنوان مثال، گزارش فعالیت کاربر پایه برای کانال‌ها شامل ابعاد زیر است:

• روز : تاریخی که فعالیت در آن رخ داده است.
• کانال : کانال یوتیوب مرتبط با فعالیت.
• ویدیو : ویدیوی یوتیوب مرتبط با فعالیت.
• liveOrOnDemand : مقداری که نشان می‌دهد آیا بینندگان در حال تماشای یک پخش زنده ویدیویی بوده‌اند یا خیر.
• وضعیت مشترک : مقداری که نشان می‌دهد آیا بینندگان در کانال مشترک شده‌اند یا خیر.
• کشور : کشوری که بینندگان در آن قرار داشتند.

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

برای مثال، برای محاسبه تعداد کل بازدیدها در آلمان در یک تاریخ خاص، مقادیر متریک بازدیدها را برای تمام ردیف‌هایی که مقدار ستون کشور DE و مقدار ستون روز تاریخ با فرمت YYYY-MM-DD است، جمع کنید.

گزارش‌های YouTube Analytics را بازیابی کنید

مراحل زیر نحوه بازیابی گزارش‌های مالک کانال و محتوا را از طریق API توضیح می‌دهد. برای دستورالعمل نحوه بازیابی این گزارش‌ها، به گزارش‌های مدیریت‌شده توسط سیستم مراجعه کنید.

مرحله 1: بازیابی اعتبارنامه‌های مجوز

تمام درخواست‌های API گزارش یوتیوب باید مجاز باشند. برای بازیابی توکن‌های مجوز از طریق پروتکل OAuth 2.0، به راهنمای مجوز مراجعه کنید.

درخواست‌های API گزارش یوتیوب از حوزه‌های مجوز زیر استفاده می‌کنند:

محدوده‌ها
https://www.googleapis.com/auth/yt-analytics.readonly	گزارش‌های YouTube Analytics را برای محتوای YouTube خود مشاهده کنید. این دامنه دسترسی به معیارهای فعالیت کاربر، مانند تعداد بازدیدها و تعداد رتبه‌بندی‌ها را فراهم می‌کند.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	گزارش‌های مالی YouTube Analytics را برای محتوای YouTube خود مشاهده کنید. این بخش دسترسی به معیارهای فعالیت کاربر و معیارهای تخمینی درآمد و عملکرد تبلیغات را فراهم می‌کند.

مرحله ۲: گزارش مورد نظر برای بازیابی را شناسایی کنید

برای بازیابی لیستی از گزارش‌هایی که می‌توانند برای مالک کانال یا محتوا تولید شوند، متد reportTypes.list از API را فراخوانی کنید. این متد لیستی از شناسه‌ها و نام‌های گزارش را برمی‌گرداند. مقدار ویژگی id را برای گزارش‌هایی که می‌خواهید تولید شوند، دریافت کنید. برای مثال، شناسه گزارش فعالیت کاربر پایه برای کانال‌ها channel_basic_a3 است.

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

مرحله 3: ایجاد یک گزارش شغلی

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

برای ایجاد یک گزارش، متد jobs.create از API را فراخوانی کنید. مقادیر زیر را در بدنه درخواست تنظیم کنید:

• مقدار ویژگی reportTypeId را برابر با شناسه گزارشی که در مرحله 2 بازیابی کردید، تنظیم کنید.
• مقدار ویژگی name را روی نامی که می‌خواهید به گزارش مرتبط کنید، تنظیم کنید.

پاسخ API به متد jobs.create شامل یک منبع Job است که ID مشخص می‌کند که به طور منحصر به فرد، Job را شناسایی می‌کند. شما می‌توانید ظرف ۴۸ ساعت از زمان ایجاد Job، بازیابی گزارش را شروع کنید و اولین گزارش موجود برای روزی خواهد بود که Job را برنامه‌ریزی کرده‌اید.

برای مثال، اگر کاری را برای ۱ سپتامبر برنامه‌ریزی کنید، گزارش ۱ سپتامبر در ۳ سپتامبر آماده خواهد بود. گزارش ۲ سپتامبر در ۴ سپتامبر منتشر می‌شود.

مرحله ۴: شناسه کار را بازیابی کنید

نکته: اگر برنامه شما شناسه کار برگردانده شده در مرحله ۳ را ذخیره کرده است، می‌توانید از این مرحله صرف نظر کنید.

برای بازیابی لیستی از کارهای زمان‌بندی‌شده، متد jobs.list را فراخوانی کنید. ویژگی reportTypeId در هر منبع Job برگردانده شده، نوع گزارشی را که آن کار تولید می‌کند، مشخص می‌کند. برنامه شما در مرحله بعد به مقدار ویژگی id از همان منبع نیاز دارد.

مرحله ۵: دریافت آدرس دانلود گزارش

برای بازیابی لیستی از گزارش‌های ایجاد شده برای این کار، متد jobs.reports.list را فراخوانی کنید. در درخواست، پارامتر jobId را برابر با شناسه‌ی کار گزارشی که می‌خواهید بازیابی کنید، قرار دهید.

نکته: از پارامتر createdAfter برای مشخص کردن این که API فقط گزارش‌هایی را که پس از یک زمان مشخص ایجاد شده‌اند، برگرداند، استفاده کنید. این پارامتر می‌تواند برای اطمینان از این باشد که API فقط گزارش‌هایی را که قبلاً پردازش نکرده‌اید، برگرداند.

پاسخ API شامل فهرستی از منابع Report برای آن کار است. هر منبع به گزارشی اشاره دارد که حاوی داده‌هایی برای یک دوره ۲۴ ساعته منحصر به فرد است. توجه داشته باشید که یوتیوب گزارش‌های قابل دانلودی را برای روزهایی که هیچ داده‌ای در دسترس نبوده است، تولید می‌کند. این گزارش‌ها حاوی یک ردیف هدر هستند اما حاوی داده‌های اضافی نیستند.

• ویژگی‌های startTime و endTime منبع، دوره زمانی را که داده‌های گزارش پوشش می‌دهند، مشخص می‌کنند.
• ویژگی downloadUrl منبع، URL ای را که گزارش می‌تواند از آن دریافت شود، مشخص می‌کند.
• ویژگی createTime منبع، تاریخ و زمان تولید گزارش را مشخص می‌کند. برنامه شما باید این مقدار را ذخیره کند و از آن برای تعیین اینکه آیا گزارش‌های دانلود شده قبلی تغییر کرده‌اند یا خیر، استفاده کند.

مرحله ششم: دانلود گزارش

برای بازیابی گزارش، یک درخواست HTTP GET به downloadUrl که در مرحله ۵ به دست آمده است، ارسال کنید.

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

برای دریافت پاسخ کدگذاری شده با gzip، هدر درخواست HTTP مربوط به Accept-Encoding را مطابق مثال زیر روی gzip تنظیم کنید:

Accept-Encoding: gzip

گزارش‌های فرآیند

بهترین شیوه‌ها

برنامه‌هایی که از API گزارش‌دهی یوتیوب استفاده می‌کنند، باید همیشه از این شیوه‌ها پیروی کنند:

• برای تعیین ترتیب ستون‌های گزارش، از ردیف سربرگ گزارش استفاده کنید. برای مثال، فرض نکنید که نماها (views) اولین معیاری هستند که در گزارش برگردانده می‌شوند، صرفاً به این دلیل که اولین معیار ذکر شده در توضیحات گزارش هستند. در عوض، از ردیف سربرگ گزارش برای تعیین اینکه کدام ستون حاوی آن داده‌ها است، استفاده کنید.

• برای اینکه پردازش گزارش شما در آینده تضمین شود، برنامه شما باید انتظار اضافه شدن معیارهای جدید به هر گزارشی را داشته باشد و باید آماده پردازش و گنجاندن این ستون‌های جدید به محض ظاهر شدن آنها باشد. معیارهای جدید به عنوان ستون‌های جدید در سربرگ گزارش ظاهر می‌شوند.

• برای جلوگیری از پردازش مکرر یک گزارش، گزارش‌هایی را که دانلود کرده‌اید، ثبت کنید. لیست زیر چند روش برای انجام این کار پیشنهاد می‌دهد.

  • هنگام فراخوانی متد reports.list ، از پارامتر createdAfter برای بازیابی گزارش‌های ایجاد شده پس از یک تاریخ خاص استفاده کنید. (پارامتر createdAfter را در اولین باری که گزارش‌ها را بازیابی می‌کنید، حذف کنید.)

    هر بار که گزارش‌ها را بازیابی و با موفقیت پردازش می‌کنید، مهر زمانی مربوط به تاریخ و زمان ایجاد جدیدترین آن گزارش‌ها را ذخیره کنید. سپس، مقدار پارامتر createdAfter را در هر فراخوانی متوالی به روش reports.list به‌روزرسانی کنید تا مطمئن شوید که فقط گزارش‌های جدید، از جمله گزارش‌های جدید با داده‌های پر شده، را هر بار که API را فراخوانی می‌کنید، بازیابی می‌کنید.

    به عنوان یک اقدام احتیاطی، قبل از بازیابی گزارش، بررسی کنید که شناسه گزارش از قبل در پایگاه داده شما ثبت نشده باشد.

  • شناسه هر گزارشی را که دانلود و پردازش کرده‌اید، ذخیره کنید. همچنین می‌توانید اطلاعات اضافی مانند تاریخ و زمان تولید هر گزارش یا startTime و endTime گزارش را ذخیره کنید که در کنار هم دوره‌ای را که گزارش حاوی داده‌ها است، مشخص می‌کنند. توجه داشته باشید که هر کار احتمالاً گزارش‌های زیادی خواهد داشت زیرا هر گزارش حاوی داده‌هایی برای یک دوره ۲۴ ساعته است.

    از شناسه گزارش برای شناسایی گزارش‌هایی که هنوز نیاز به دانلود و وارد کردن آنها دارید استفاده کنید. با این حال، اگر دو گزارش جدید مقادیر ویژگی‌های startTime و endTime یکسانی دارند، فقط گزارشی را وارد کنید که مقدار createTime جدیدتری دارد.

• گزارش‌ها حاوی شناسه‌های مرتبط با منابع YouTube هستند. برای بازیابی فراداده‌های اضافی برای آن منابع، از YouTube Data API استفاده کنید. همانطور که در سیاست‌های توسعه‌دهندگان خدمات YouTube API (بخش‌های III.E.4.b تا III.E.4.d) ذکر شده است، کلاینت‌های API باید پس از 30 روز، فراداده‌های ذخیره شده منبع را از آن API حذف یا به‌روزرسانی کنند.

ویژگی‌های گزارش

گزارش‌های API فایل‌های .csv (مقادیر جدا شده با کاما) با نسخه‌های مختلف هستند که دارای ویژگی‌های زیر می‌باشند:

• هر گزارش شامل داده‌هایی برای یک دوره ۲۴ ساعته منحصر به فرد است که از ساعت ۱۲:۰۰ بامداد تا ۱۱:۵۹ شب به وقت استاندارد اقیانوس آرام (UTC-8) ادامه دارد. به این ترتیب، در هر گزارش مشخص، مقدار بُعد روز همیشه یکسان است.

• گزارش‌ها روزانه به‌روزرسانی می‌شوند.

• یوتیوب برای روزهایی که هیچ داده‌ای در دسترس نبوده، گزارش‌های قابل دانلودی تولید می‌کند. این گزارش‌ها شامل یک ردیف سربرگ هستند اما داده‌های اضافی ندارند.

• گزارش‌های API به مدت ۶۰ روز از زمان تولیدشان در دسترس هستند، به استثنای داده‌های تاریخی تولید شده برای گزارش‌های جدید. گزارش‌ها پس از گذشت بیش از ۶۰ روز غیرقابل دسترسی می‌شوند.
• گزارش‌های حاوی داده‌های تاریخی به مدت ۳۰ روز از زمان تولید در دسترس هستند. گزارش‌هایی که حاوی داده‌های تاریخی هستند، پس از گذشت بیش از ۳۰ روز، غیرقابل دسترسی می‌شوند.

• داده‌های گزارش فیلتر نمی‌شوند. به این ترتیب، گزارش کانال شامل تمام داده‌های مربوط به ویدیوها یا لیست‌های پخش یک کانال است، به استثنای موارد ذکر شده در پاراگراف بعدی مربوط به منابع حذف شده. به طور مشابه، گزارش مالک محتوا شامل تمام داده‌های مربوط به کانال‌های مالک محتوا (ویدیوها، لیست‌های پخش، عملکرد تبلیغات و غیره) است، به استثنای موارد زیر.

  اگرچه داده‌های گزارش فیلتر نمی‌شوند، اما گزارش‌ها هیچ ارجاعی به منابع یوتیوب که حداقل ۳۰ روز قبل از تاریخ ایجاد گزارش حذف شده‌اند، ندارند.

• داده‌های گزارش مرتب نشده‌اند.

• گزارش‌ها ردیف‌هایی را که معیار ندارند، حذف می‌کنند. به عبارت دیگر، ردیف‌هایی که هیچ معیاری ندارند، از گزارش حذف می‌شوند. برای مثال، اگر یک ویدیو در یک روز خاص در آلبانی بازدید نداشته باشد، گزارش آن روز شامل ردیف‌هایی برای آلبانی نخواهد بود.

• گزارش‌ها حاوی ردیف‌هایی نیستند که داده‌های خلاصه‌ای برای معیارها، مانند تعداد کل بازدیدها برای همه ویدیوهای یک کانال، ارائه دهند. می‌توانید این مقادیر کل را به عنوان مجموع مقادیر موجود در گزارش محاسبه کنید، اما این مجموع ممکن است شامل معیارهای ویدیوهای حذف شده نباشد. همچنین می‌توانید از API YouTube Analytics برای بازیابی تعداد کل استفاده کنید. API YouTube Analytics مقادیر کل را که شامل معیارهای منابع حذف شده هستند، برمی‌گرداند، حتی اگر این منابع به صراحت در پاسخ‌های API به آنها اشاره نشده باشد.

• مقادیر ابعاد خالی: در گزارش‌های انبوه، ستون‌های ابعاد مانند video_id یا channel_id می‌توانند در سناریوهای زیر حاوی رشته‌های خالی باشند:

  • منابع حذف‌شده: اگر یک ویدیو یا کانال حذف شده باشد، گزارش شناسه منبع حذف‌شده را حذف می‌کند، اما همچنان ردیف مربوطه را در نظر می‌گیرد تا مجموع معیارهای کل برای نهاد والد حفظ شود.
  • معیارهای سطح کانال: در گزارش‌هایی که شامل بُعد video_id هستند، معیارهایی که در سطح کانال رخ می‌دهند (مانند اشتراک‌هایی که مستقیماً از صفحه اصلی کانال به دست می‌آیند) در ردیفی ظاهر می‌شوند که video_id یک رشته خالی است.

داده‌های پر کردن مجدد

داده‌های Backfill به مجموعه‌ای از داده‌ها اشاره دارد که جایگزین مجموعه‌ای از داده‌های ارائه شده قبلی می‌شود. هنگامی که یک گزارش داده‌های Backfill در دسترس است، برنامه شما باید گزارش جدید را بازیابی کرده و داده‌های ذخیره شده خود را برای مطابقت با مجموعه داده‌های اصلاح شده به‌روزرسانی کند. به عنوان مثال، برنامه شما می‌تواند داده‌های قبلی را برای دوره زمانی تحت پوشش گزارش حذف کرده و سپس مجموعه داده‌های جدید را وارد کند.

اگر یوتیوب داده‌های backfill داشته باشد، گزارش جدیدی با شناسه گزارش جدید ایجاد می‌کند. در این صورت، مقادیر ویژگی‌های startTime و endTime گزارش با زمان شروع و پایان گزارشی که قبلاً در دسترس بوده و ممکن است قبلاً دانلود کرده باشید، مطابقت خواهد داشت.

گزارش‌های Backfill هیچ ارجاعی به منابع یوتیوبی که حداقل ۳۰ روز قبل از تاریخ ایجاد گزارش حذف شده‌اند، ندارند.

داده‌های تاریخی

وقتی یک کار گزارش‌دهی جدید را برنامه‌ریزی می‌کنید، یوتیوب گزارش‌های تاریخی را از آن روز به بعد تولید می‌کند و گزارش‌هایی را نیز تولید می‌کند که دوره ۳۰ روزه قبل از زمانی که شما کار را ایجاد کرده‌اید را پوشش می‌دهند. بنابراین، در این مستندات، داده‌های تاریخی به گزارشی اشاره دارد که حاوی داده‌هایی برای یک دوره زمانی قبل از برنامه‌ریزی کار گزارش‌دهی است.

گزارش‌های تاریخی به محض اینکه در دسترس قرار گیرند، منتشر می‌شوند. معمولاً تمام داده‌های تاریخی برای یک کار ظرف چند روز منتشر می‌شوند. همانطور که در بخش ویژگی‌های گزارش توضیح داده شد، گزارش‌هایی که حاوی داده‌های تاریخی هستند، به مدت 30 روز از زمان تولید در دسترس هستند. گزارش‌هایی که حاوی داده‌های غیرتاریخی هستند، به مدت 60 روز در دسترس هستند.

ناشناس‌سازی داده‌ها

برای اطمینان از ناشناس ماندن بینندگان یوتیوب، مقادیر برخی از ابعاد فقط در صورتی بازگردانده می‌شوند که معیاری در همان ردیف، آستانه‌ی خاصی را رعایت کند.

برای مثال، در گزارش منبع ترافیک ویدیو برای کانال‌ها، هر ردیف شامل تعدادی بُعد، از جمله trafficSourceType و trafficSourceDetail است. هر ردیف همچنین شامل معیارهای مختلفی از جمله تعداد بازدیدها است. در ردیف‌هایی که ترافیکی را توصیف می‌کنند که از جستجوی YouTube سرچشمه گرفته است، بُعد trafficSourceDetail عبارت جستجویی را که منجر به ترافیک شده است، مشخص می‌کند.

در این مثال، قوانین زیر اعمال می‌شود:

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

• این گزارش شامل یک ردیف اضافی است که معیارهای مربوط به تمام مقادیر trafficSourceDetail را که آستانه تعداد بازدید را برآورده نمی‌کنند، جمع می‌کند. این ردیف تعداد کل بازدیدهای مرتبط با آن عبارات جستجو را گزارش می‌دهد، اما خود عبارات را شناسایی نمی‌کند.

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

داده‌های خام ترافیک جستجوی یوتیوب برای یک ویدیو

فرض کنید داده‌های زیر ترافیک جستجوی یوتیوب به یک ویدیوی خاص در یک روز خاص را توصیف می‌کنند.

عبارت جستجو	دیدگاه‌ها	دقایق تخمینی تماشا
سبک گانگنام	۱۰۰	۲۰۰
روان	۱۵	۲۵
گنگنام روانی	۹	۱۵
اوپا گنگنام	۵	۸
رقص اسب سواری	۲	۵

نمونه گزارش منبع ترافیک

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

در ردیف سوم گزارش، مقدار بُعد trafficSourceDetail NULL است. معیارهای views و estimatedMinutesWatched شامل بازدیدها و دقایق بازدید شده ترکیبی برای سه عبارت جستجو هستند که کمتر از 10 بازدید ایجاد کرده‌اند.

جزئیات منبع ترافیک	دیدگاه‌ها	دقیقه‌های تخمینی مشاهده شده
سبک گانگنام	۱۰۰	۲۰۰
روان	۱۵	۲۵
تهی	۱۶	۲۸

ابعاد مشمول ناشناس ماندن

جدول زیر مقادیر بُعدی را مشخص می‌کند که در صورت عدم رعایت آستانه‌ی مشخص برای مقادیر معیار مرتبط، ناشناس می‌شوند. در هر مورد، مقدار معیار بر روی بُعد دیگری تجمیع می‌شود. برای مثال، اگر معیار تعداد بازدیدها و بُعد تجمیع‌کننده ویدیو باشد، مقدار بُعد ناشناس می‌شود، مگر اینکه ویدیو به تعداد مشخصی مشاهده شده باشد.

متریک	ابعاد تجمیع (یا ابعاد)	بُعد ناشناس	مقدار ناشناس
مشترکین به دست آمده	کانال	کشور	ZZ
مشترکین به دست آمده	کانال	استان	US-ZZ
مشترکینگم‌شده	کانال	کشور	ZZ
مشترکینگم‌شده	کانال	استان	US-ZZ
نظرات	ویدئو	کشور	ZZ
نظرات	ویدئو	استان	US-ZZ
لایک‌ها	ویدئو	کشور	ZZ
لایک‌ها	ویدئو	استان	US-ZZ
دوست نداشتن	ویدئو	کشور	ZZ
دوست نداشتن	ویدئو	استان	US-ZZ
دیدگاه‌ها	ویدئو	گروه سنی	NULL
دیدگاه‌ها	ویدئو	جنسیت	NULL
دیدگاه‌ها	ویدیو و ترافیکSourceDetail	جزئیات منبع ترافیک	NULL
تعداد مشترکین کانال	کانال	وضعیت مشترک	NULL

نمونه‌های کد

نمونه‌های کد زیر نحوه استفاده از API برای ایجاد یک کار گزارش‌گیری و سپس بازیابی گزارش برای آن کار را نشان می‌دهند. برای هر زبان دو نمونه کد ارائه شده است:

1. اولین نمونه کد نشان می‌دهد که چگونه می‌توان لیستی از انواع گزارش‌های موجود را بازیابی کرد و سپس یک کار گزارش‌گیری جدید ایجاد کرد.

2. نمونه کد دوم نحوه بازیابی گزارش برای یک کار خاص را نشان می‌دهد. می‌توانید ظرف ۴۸ ساعت از زمان ایجاد کار، بازیابی گزارش‌ها را شروع کنید.

توجه: نمونه‌های کد زیر ممکن است نشان‌دهنده‌ی تمام زبان‌های برنامه‌نویسی پشتیبانی‌شده نباشند. برای مشاهده‌ی لیست زبان‌های پشتیبانی‌شده، به کتابخانه‌های کلاینت مراجعه کنید.

جاوا

نمونه‌های زیر از کتابخانه کلاینت جاوا استفاده می‌کنند:

• مثال ۱: ایجاد یک گزارش شغلی
• مثال ۲: بازیابی یک گزارش

مثال ۱: ایجاد یک گزارش شغلی

نمونه کد زیر متد reportTypes.list را برای بازیابی لیستی از انواع گزارش‌های موجود فراخوانی می‌کند. سپس متد jobs.create را برای ایجاد یک کار گزارش‌گیری جدید فراخوانی می‌کند.

/*
 * Copyright (c) 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.services.samples.youtube.cmdline.reporting;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListReportTypesResponse;
import com.google.api.services.youtubereporting.model.ReportType;
import com.google.common.collect.Lists;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

/**
 * This sample creates a reporting job by:
 *
 * 1. Listing the available report types using the "reportTypes.list" method.
 * 2. Creating a reporting job using the "jobs.create" method.
 *
 * @author Ibrahim Ulukaya
 */
public class CreateReportingJob {

    /**
     * Define a global instance of a YouTube Reporting object, which will be used to make
     * YouTube Reporting API requests.
     */
    private static YouTubeReporting youtubeReporting;


    /**
     * Create a reporting job.
     *
     * @param args command line args (not used).
     */
    public static void main(String[] args) {

        /*
         * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
         * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
         * use this scope.
         */
        List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");

        try {
            // Authorize the request.
            Credential credential = Auth.authorize(scopes, "createreportingjob");

            // This object is used to make YouTube Reporting API requests.
            youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
                    .setApplicationName("youtube-cmdline-createreportingjob-sample").build();

            // Prompt the user to specify the name of the job to be created.
            String name = getNameFromUser();

            if (listReportTypes()) {
              createReportingJob(getReportTypeIdFromUser(), name);
            }
        } catch (GoogleJsonResponseException e) {
            System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
                    + " : " + e.getDetails().getMessage());
            e.printStackTrace();

        } catch (IOException e) {
            System.err.println("IOException: " + e.getMessage());
            e.printStackTrace();
        } catch (Throwable t) {
            System.err.println("Throwable: " + t.getMessage());
            t.printStackTrace();
        }
    }

    /**
     * Lists report types. (reportTypes.listReportTypes)
     * @return true if at least one report type exists
     * @throws IOException
     */
    private static boolean listReportTypes() throws IOException {
        // Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
        ListReportTypesResponse reportTypesListResponse = youtubeReporting.reportTypes().list()
            .execute();
        List<ReportType> reportTypeList = reportTypesListResponse.getReportTypes();

        if (reportTypeList == null || reportTypeList.isEmpty()) {
          System.out.println("No report types found.");
          return false;
        } else {
            // Print information from the API response.
            System.out.println("\n================== Report Types ==================\n");
            for (ReportType reportType : reportTypeList) {
                System.out.println("  - Id: " + reportType.getId());
                System.out.println("  - Name: " + reportType.getName());
                System.out.println("\n-------------------------------------------------------------\n");
           }
        }
        return true;
    }

    /**
     * Creates a reporting job. (jobs.create)
     *
     * @param reportTypeId Id of the job's report type.
     * @param name name of the job.
     * @throws IOException
     */
    private static void createReportingJob(String reportTypeId, String name)
        throws IOException {
        // Create a reporting job with a name and a report type id.
        Job job = new Job();
        job.setReportTypeId(reportTypeId);
        job.setName(name);

        // Call the YouTube Reporting API's jobs.create method to create a job.
        Job createdJob = youtubeReporting.jobs().create(job).execute();

        // Print information from the API response.
        System.out.println("\n================== Created reporting job ==================\n");
        System.out.println("  - ID: " + createdJob.getId());
        System.out.println("  - Name: " + createdJob.getName());
        System.out.println("  - Report Type Id: " + createdJob.getReportTypeId());
        System.out.println("  - Create Time: " + createdJob.getCreateTime());
        System.out.println("\n-------------------------------------------------------------\n");
    }

    /*
     * Prompt the user to enter a name for the job. Then return the name.
     */
    private static String getNameFromUser() throws IOException {

        String name = "";

        System.out.print("Please enter the name for the job [javaTestJob]: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        name = bReader.readLine();

        if (name.length() < 1) {
            // If nothing is entered, defaults to "javaTestJob".
          name = "javaTestJob";
        }

        System.out.println("You chose " + name + " as the name for the job.");
        return name;
    }

    /*
     * Prompt the user to enter a report type id for the job. Then return the id.
     */
    private static String getReportTypeIdFromUser() throws IOException {

        String id = "";

        System.out.print("Please enter the reportTypeId for the job: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        id = bReader.readLine();

        System.out.println("You chose " + id + " as the report type Id for the job.");
        return id;
    }
}
CreateReportingJob.java

مثال ۲: بازیابی یک گزارش

این نمونه کد، متد jobs.list را برای بازیابی لیستی از کارهای گزارش‌دهی فراخوانی می‌کند. سپس متد reports.list را با پارامتر jobId که روی یک شناسه کار خاص تنظیم شده است، فراخوانی می‌کند تا گزارش‌های ایجاد شده توسط آن کار را بازیابی کند. در نهایت، این نمونه، URL دانلود هر گزارش را چاپ می‌کند.

/*
 * Copyright (c) 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.services.samples.youtube.cmdline.reporting;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.GenericUrl;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.YouTubeReporting.Media.Download;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListJobsResponse;
import com.google.api.services.youtubereporting.model.ListReportsResponse;
import com.google.api.services.youtubereporting.model.Report;

import com.google.common.collect.Lists;

import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

import javax.print.attribute.standard.Media;

/**
 * This sample retrieves reports created by a specific job by:
 *
 * 1. Listing the jobs using the "jobs.list" method.
 * 2. Retrieving reports using the "reports.list" method.
 *
 * @author Ibrahim Ulukaya
 */
public class RetrieveReports {

    /**
     * Define a global instance of a YouTube Reporting object, which will be used to make
     * YouTube Reporting API requests.
     */
    private static YouTubeReporting youtubeReporting;


    /**
     * Retrieve reports.
     *
     * @param args command line args (not used).
     */
    public static void main(String[] args) {

        /*
         * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
         * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
         * use this scope.
         */
        List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");

        try {
            // Authorize the request.
            Credential credential = Auth.authorize(scopes, "retrievereports");

            // This object is used to make YouTube Reporting API requests.
            youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
                    .setApplicationName("youtube-cmdline-retrievereports-sample").build();

            if (listReportingJobs()) {
              if(retrieveReports(getJobIdFromUser())) {
                downloadReport(getReportUrlFromUser());
              }
            }
        } catch (GoogleJsonResponseException e) {
            System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
                    + " : " + e.getDetails().getMessage());
            e.printStackTrace();

        } catch (IOException e) {
            System.err.println("IOException: " + e.getMessage());
            e.printStackTrace();
        } catch (Throwable t) {
            System.err.println("Throwable: " + t.getMessage());
            t.printStackTrace();
        }
    }

    /**
     * Lists reporting jobs. (jobs.listJobs)
     * @return true if at least one reporting job exists
     * @throws IOException
     */
    private static boolean listReportingJobs() throws IOException {
        // Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
        ListJobsResponse jobsListResponse = youtubeReporting.jobs().list().execute();
        List<Job> jobsList = jobsListResponse.getJobs();

        if (jobsList == null || jobsList.isEmpty()) {
          System.out.println("No jobs found.");
          return false;
        } else {
            // Print information from the API response.
            System.out.println("\n================== Reporting Jobs ==================\n");
            for (Job job : jobsList) {
                System.out.println("  - Id: " + job.getId());
                System.out.println("  - Name: " + job.getName());
                System.out.println("  - Report Type Id: " + job.getReportTypeId());
                System.out.println("\n-------------------------------------------------------------\n");
            }
        }
        return true;
    }

    /**
     * Lists reports created by a specific job. (reports.listJobsReports)
     *
     * @param jobId The ID of the job.
     * @throws IOException
     */
    private static boolean retrieveReports(String jobId)
        throws IOException {
        // Call the YouTube Reporting API's reports.list method
        // to retrieve reports created by a job.
        ListReportsResponse reportsListResponse = youtubeReporting.jobs().reports().list(jobId).execute();
        List<Report> reportslist = reportsListResponse.getReports();

        if (reportslist == null || reportslist.isEmpty()) {
            System.out.println("No reports found.");
            return false;
        } else {
            // Print information from the API response.
            System.out.println("\n============= Reports for the job " + jobId + " =============\n");
            for (Report report : reportslist) {
                System.out.println("  - Id: " + report.getId());
                System.out.println("  - From: " + report.getStartTime());
                System.out.println("  - To: " + report.getEndTime());
                System.out.println("  - Download Url: " + report.getDownloadUrl());
                System.out.println("\n-------------------------------------------------------------\n");
            }
        }
        return true;
    }

    /**
     * Download the report specified by the URL. (media.download)
     *
     * @param reportUrl The URL of the report to be downloaded.
     * @throws IOException
     */
    private static boolean downloadReport(String reportUrl)
        throws IOException {
        // Call the YouTube Reporting API's media.download method to download a report.
        Download request = youtubeReporting.media().download("");
        FileOutputStream fop = new FileOutputStream(new File("report"));
        request.getMediaHttpDownloader().download(new GenericUrl(reportUrl), fop);
        return true;
    }

    /*
     * Prompt the user to enter a job id for report retrieval. Then return the id.
     */
    private static String getJobIdFromUser() throws IOException {

        String id = "";

        System.out.print("Please enter the job id for the report retrieval: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        id = bReader.readLine();

        System.out.println("You chose " + id + " as the job Id for the report retrieval.");
        return id;
    }

    /*
     * Prompt the user to enter a URL for report download. Then return the URL.
     */
    private static String getReportUrlFromUser() throws IOException {

        String url = "";

        System.out.print("Please enter the report URL to download: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        url = bReader.readLine();

        System.out.println("You chose " + url + " as the URL to download.");
        return url;
    }}

RetrieveReports.java

پی اچ پی

نمونه‌های زیر از کتابخانه کلاینت PHP استفاده می‌کنند.

• مثال ۱: ایجاد یک گزارش شغلی
• مثال ۲: بازیابی یک گزارش

مثال ۱: ایجاد یک گزارش شغلی

نمونه کد زیر متد reportTypes.list را برای بازیابی لیستی از انواع گزارش‌های موجود فراخوانی می‌کند. سپس متد jobs.create را برای ایجاد یک کار گزارش‌گیری جدید فراخوانی می‌کند.

<?php

/**
 * This sample creates a reporting job by:
 *
 * 1. Listing the available report types using the "reportTypes.list" method.
 * 2. Creating a reporting job using the "jobs.create" method.
 *
 * @author Ibrahim Ulukaya
 */

/**
 * Library Requirements
 *
 * 1. Install composer (https://getcomposer.org)
 * 2. On the command line, change to this directory (api-samples/php)
 * 3. Require the google/apiclient library
 *    $ composer require google/apiclient:~2.0
 */
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
  throw new \Exception('please run "composer require google/apiclient:~2.0" in "' . __DIR__ .'"');
}

require_once __DIR__ . '/vendor/autoload.php';
session_start();

/*
 * You can acquire an OAuth 2.0 client ID and client secret from the
 * {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
 * For more information about using OAuth 2.0 to access Google APIs, please see:
 * <https://developers.google.com/youtube/v3/guides/authentication>
 * Please ensure that you have enabled the YouTube Data API for your project.
 */
$OAUTH2_CLIENT_ID = 'REPLACE_ME';
$OAUTH2_CLIENT_SECRET = 'REPLACE_ME';

$client = new Google_Client();
$client->setClientId($OAUTH2_CLIENT_ID);
$client->setClientSecret($OAUTH2_CLIENT_SECRET);

/*
 * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
 * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
 * use this scope.
 */
$client->setScopes('https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
$redirect = filter_var('http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'],
    FILTER_SANITIZE_URL);
$client->setRedirectUri($redirect);

// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);

// Check if an auth token exists for the required scopes
$tokenSessionKey = 'token-' . $client->prepareScopes();
if (isset($_GET['code'])) {
  if (strval($_SESSION['state']) !== strval($_GET['state'])) {
    die('The session state did not match.');
  }

  $client->authenticate($_GET['code']);
  $_SESSION[$tokenSessionKey] = $client->getAccessToken();
  header('Location: ' . $redirect);
}

if (isset($_SESSION[$tokenSessionKey])) {
  $client->setAccessToken($_SESSION[$tokenSessionKey]);
}

// Check to ensure that the access token was successfully acquired.
if ($client->getAccessToken()) {
  // This code executes if the user enters a name in the form
  // and submits the form. Otherwise, the page displays the form above.
  try {
    if (empty(listReportTypes($youtubeReporting, $htmlBody))) {
      $htmlBody .= sprintf('<p>No report types found.</p>');
    } else if ($_GET['reportTypeId']){
      createReportingJob($youtubeReporting, $_GET['reportTypeId'], $_GET['jobName'], $htmlBody);
    }
  } catch (Google_Service_Exception $e) {
    $htmlBody = sprintf('<p>A service error occurred: <code>%s</code></p>',
        htmlspecialchars($e->getMessage()));
  } catch (Google_Exception $e) {
    $htmlBody = sprintf('<p>An client error occurred: <code>%s</code></p>',
        htmlspecialchars($e->getMessage()));
  }
  $_SESSION[$tokenSessionKey] = $client->getAccessToken();
} elseif ($OAUTH2_CLIENT_ID == 'REPLACE_ME') {
  $htmlBody = <<<END
  <h3>Client Credentials Required</h3>
  <p>
    You need to set <code>\$OAUTH2_CLIENT_ID</code> and
    <code>\$OAUTH2_CLIENT_ID</code> before proceeding.
  <p>
END;
} else {
  // If the user hasn't authorized the app, initiate the OAuth flow
  $state = mt_rand();
  $client->setState($state);
  $_SESSION['state'] = $state;

  $authUrl = $client->createAuthUrl();
  $htmlBody = <<<END
  <h3>Authorization Required</h3>
  <p>You need to <a href="$authUrl">authorize access</a> before proceeding.<p>
END;
}


/**
 * Creates a reporting job. (jobs.create)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $reportTypeId Id of the job's report type.
 * @param string $name name of the job.
 * @param $htmlBody - html body.
 */
function createReportingJob(Google_Service_YouTubeReporting $youtubeReporting, $reportTypeId,
    $name, &$htmlBody) {
  # Create a reporting job with a name and a report type id.
  $reportingJob = new Google_Service_YouTubeReporting_Job();
  $reportingJob->setReportTypeId($reportTypeId);
  $reportingJob->setName($name);

  // Call the YouTube Reporting API's jobs.create method to create a job.
  $jobCreateResponse = $youtubeReporting->jobs->create($reportingJob);

  $htmlBody .= "<h2>Created reporting job</h2><ul>";
  $htmlBody .= sprintf('<li>"%s" for reporting type "%s" at "%s"</li>',
      $jobCreateResponse['name'], $jobCreateResponse['reportTypeId'], $jobCreateResponse['createTime']);
  $htmlBody .= '</ul>';
}


/**
 * Returns a list of report types. (reportTypes.listReportTypes)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param $htmlBody - html body.
 */
function listReportTypes(Google_Service_YouTubeReporting $youtubeReporting, &$htmlBody) {
  // Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
  $reportTypes = $youtubeReporting->reportTypes->listReportTypes();

  $htmlBody .= "<h3>Report Types</h3><ul>";
  foreach ($reportTypes as $reportType) {
    $htmlBody .= sprintf('<li>id: "%s", name: "%s"</li>', $reportType['id'], $reportType['name']);
  }
  $htmlBody .= '</ul>';

  return $reportTypes;
}
?>

<!doctype html>
<html>
<head>
<title>Create a reporting job</title>
</head>
<body>
  <form method="GET">
    <div>
      Job Name: <input type="text" id="jobName" name="jobName" placeholder="Enter Job Name">
    </div>
    <br>
    <div>
      Report Type Id: <input type="text" id="reportTypeId" name="reportTypeId" placeholder="Enter Report Type Id">
    </div>
    <br>
    <input type="submit" value="Create!">
  </form>
  <?=$htmlBody?>
</body>
</html>
create_reporting_job.php

مثال ۲: بازیابی یک گزارش

این نمونه کد، متد jobs.list را برای بازیابی لیستی از کارهای گزارش‌دهی فراخوانی می‌کند. سپس متد reports.list را با پارامتر jobId که روی یک شناسه کار خاص تنظیم شده است، فراخوانی می‌کند تا گزارش‌های ایجاد شده توسط آن کار را بازیابی کند. در نهایت، این نمونه، URL دانلود هر گزارش را چاپ می‌کند.

<?php

/**
 * This sample supports the following use cases:
 *
 * 1. Retrieve reporting jobs by content owner:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID"
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --includeSystemManaged==True
 * 2. Retrieving list of downloadable reports for a particular job:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --jobId="JOB_ID"
 * 3. Download a report:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --downloadUrl="DOWNLOAD_URL" --outputFile="report.txt"
 */

/**
 * Library Requirements
 *
 * 1. Install composer (https://getcomposer.org)
 * 2. On the command line, change to this directory (api-samples/php)
 * 3. Require the google/apiclient library
 *    $ composer require google/apiclient:~2.0
 */
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
  throw new \Exception('please run "composer require google/apiclient:~2.2.0" in "' . __DIR__ .'"');
}

require_once __DIR__ . '/vendor/autoload.php';
session_start();


define('CREDENTIALS_PATH', '~/.credentials/youtube-php.json');

$longOptions = array(
  'contentOwner::',
  'downloadUrl::',
  'includeSystemManaged::',
  'jobId::',
  'outputFile::',
);

$options = getopt('', $longOptions);

$CONTENT_OWNER_ID = ($options['contentOwner'] ? $options['contentOwner'] : '');
$DOWNLOAD_URL = (array_key_exists('downloadUrl', $options) ?
                 $options['downloadUrl'] : '');
$INCLUDE_SYSTEM_MANAGED = (array_key_exists('includeSystemManaged', $options) ?
                           $options['includeSystemManaged'] : '');
$JOB_ID = (array_key_exists('jobId', $options) ? $options['jobId'] : '');
$OUTPUT_FILE = (array_key_exists('outputFile', $options) ?
                $options['outputFile'] : '');

/*
 * You can obtain an OAuth 2.0 client ID and client secret from the
 * {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
 * For more information about using OAuth 2.0 to access Google APIs, please see:
 * <https://developers.google.com/youtube/v3/guides/authentication>
 * Please ensure that you have enabled the YouTube Data API for your project.
 */
function getClient() {
  $client = new Google_Client();
  $client->setAuthConfigFile('client_secrets_php.json');
  $client->addScope(
      'https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
  $client->setRedirectUri('urn:ietf:wg:oauth:2.0:oob');
  $client->setAccessType('offline');

  // Load previously authorized credentials from a file.
  $credentialsPath = expandHomeDirectory(CREDENTIALS_PATH);
  if (file_exists($credentialsPath)) {
    $accessToken = json_decode(file_get_contents($credentialsPath), true);
  } else {
    // Request authorization from the user.
    $authUrl = $client->createAuthUrl();
    printf('Open the following link in your browser:\n%s\n', $authUrl);
    print 'Enter verification code: ';
    $authCode = trim(fgets(STDIN));

    // Exchange authorization code for an access token.
    $accessToken = $client->authenticate($authCode);
    $refreshToken = $client->getRefreshToken();

    // Store the credentials to disk.
    if(!file_exists(dirname($credentialsPath))) {
      mkdir(dirname($credentialsPath), 0700, true);
    }
    file_put_contents($credentialsPath, json_encode($accessToken));
    printf('Credentials saved to %s\n', $credentialsPath);

    //fclose($fp);
  }
  $client->setAccessToken($accessToken);

  // Refresh the token if it's expired.
  if ($client->isAccessTokenExpired()) {
    $client->fetchAccessTokenWithRefreshToken($client->getRefreshToken());
    file_put_contents($credentialsPath, json_encode($client->getAccessToken()));
  }

  return $client;
}

/**
 * Expands the home directory alias '~' to the full path.
 * @param string $path the path to expand.
 * @return string the expanded path.
 */
function expandHomeDirectory($path) {
  $homeDirectory = getenv('HOME');
  if (empty($homeDirectory)) {
    $homeDirectory = getenv('HOMEDRIVE') . getenv('HOMEPATH');
  }
  return str_replace('~', realpath($homeDirectory), $path);
}

/**
 * Returns a list of reporting jobs. (jobs.listJobs)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $onBehalfOfContentOwner A content owner ID.
 */
function listReportingJobs(Google_Service_YouTubeReporting $youtubeReporting,
    $onBehalfOfContentOwner = '', $includeSystemManaged = False) {
  $reportingJobs = $youtubeReporting->jobs->listJobs(
      array('onBehalfOfContentOwner' => $onBehalfOfContentOwner,
            'includeSystemManaged' => $includeSystemManaged));
  print ('REPORTING JOBS' . PHP_EOL . '**************' . PHP_EOL);
  foreach ($reportingJobs as $job) {
    print($job['reportTypeId'] . ':' . $job['id'] . PHP_EOL);
  }
  print(PHP_EOL);
}

/**
 * Lists reports created by a specific job. (reports.listJobsReports)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $jobId The ID of the job.
 * @param string $onBehalfOfContentOwner A content owner ID.
 */
function listReportsForJob(Google_Service_YouTubeReporting $youtubeReporting,
    $jobId, $onBehalfOfContentOwner = '') {
  $reports = $youtubeReporting->jobs_reports->listJobsReports($jobId,
      array('onBehalfOfContentOwner' => $onBehalfOfContentOwner));
  print ('DOWNLOADABLE REPORTS' . PHP_EOL . '********************' . PHP_EOL);
  foreach ($reports['reports'] as $report) {
    print('Created: ' . date('d M Y', strtotime($report['createTime'])) .
          ' (' . date('d M Y', strtotime($report['startTime'])) .
          ' to ' . date('d M Y', strtotime($report['endTime'])) . ')' .
          PHP_EOL .  '    ' . $report['downloadUrl'] . PHP_EOL . PHP_EOL);
  }
}

/**
 * Download the report specified by the URL. (media.download)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $reportUrl The URL of the report to be downloaded.
 * @param string $outputFile The file to write the report to locally.
 * @param $htmlBody - html body.
 */
function downloadReport(Google_Service_YouTubeReporting $youtubeReporting,
    $reportUrl, $outputFile) {
  $client = $youtubeReporting->getClient();
  // Setting the defer flag to true tells the client to return a request that
  // can be called with ->execute(); instead of making the API call immediately.
  $client->setDefer(true);

  // Call YouTube Reporting API's media.download method to download a report.
  $request = $youtubeReporting->media->download('', array('alt' => 'media'));
  $request = $request->withUri(new \GuzzleHttp\Psr7\Uri($reportUrl));
  $responseBody = '';
  try {
    $response = $client->execute($request);
    $responseBody = $response->getBody();
  } catch (Google_Service_Exception $e) {
    $responseBody = $e->getTrace()[0]['args'][0]->getResponseBody();
  }
  file_put_contents($outputFile, $responseBody);
  $client->setDefer(false);
}

// Define an object that will be used to make all API requests.
$client = getClient();
// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);

if ($CONTENT_OWNER_ID) {
  if (!$DOWNLOAD_URL && !$JOB_ID) {
    listReportingJobs($youtubeReporting, $CONTENT_OWNER_ID,
                      $INCLUDE_SYSTEM_MANAGED);
  } else if ($JOB_ID) {
    listReportsForJob($youtubeReporting, $JOB_ID, $CONTENT_OWNER_ID);
  } else if ($DOWNLOAD_URL && $OUTPUT_FILE) {
    downloadReport($youtubeReporting, $DOWNLOAD_URL, $OUTPUT_FILE);
  }
}

?>
retrieve_reports.php

پایتون

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

• مثال ۱: ایجاد یک گزارش شغلی
• مثال ۲: بازیابی یک گزارش

مثال ۱: ایجاد یک گزارش شغلی

نمونه کد زیر متد reportTypes.list را برای بازیابی لیستی از انواع گزارش‌های موجود فراخوانی می‌کند. سپس متد jobs.create را برای ایجاد یک کار گزارش‌گیری جدید فراخوانی می‌کند.

#!/usr/bin/python

# Create a reporting job for the authenticated user's channel or
# for a content owner that the user's account is linked to.
# Usage example:
# python create_reporting_job.py --name='<name>'
# python create_reporting_job.py --content-owner='<CONTENT OWNER ID>'
# python create_reporting_job.py --content-owner='<CONTENT_OWNER_ID>' --report-type='<REPORT_TYPE_ID>' --name='<REPORT_NAME>'

import argparse
import os

import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from google_auth_oauthlib.flow import InstalledAppFlow


# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains

# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
#   https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
#   https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'

# This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
# authenticated user's account. Any request that retrieves earnings or ad performance metrics must
# use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'

# Authorize the request and store authorization credentials.
def get_authenticated_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
  good_kwargs = {}
  if kwargs is not None:
    for key, value in kwargs.iteritems():
      if value:
        good_kwargs[key] = value
  return good_kwargs

# Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
def list_report_types(youtube_reporting, **kwargs):
  # Provide keyword arguments that have values as request parameters.
  kwargs = remove_empty_kwargs(**kwargs)
  results = youtube_reporting.reportTypes().list(**kwargs).execute()
  reportTypes = results['reportTypes']

  if 'reportTypes' in results and results['reportTypes']:
    reportTypes = results['reportTypes']
    for reportType in reportTypes:
      print 'Report type id: %s\n name: %s\n' % (reportType['id'], reportType['name'])
  else:
    print 'No report types found'
    return False

  return True


# Call the YouTube Reporting API's jobs.create method to create a job.
def create_reporting_job(youtube_reporting, report_type_id, **kwargs):
  # Provide keyword arguments that have values as request parameters.
  kwargs = remove_empty_kwargs(**kwargs)

  reporting_job = youtube_reporting.jobs().create(
    body=dict(
      reportTypeId=args.report_type,
      name=args.name
    ),
    **kwargs
  ).execute()

  print ('Reporting job "%s" created for reporting type "%s" at "%s"'
         % (reporting_job['name'], reporting_job['reportTypeId'],
             reporting_job['createTime']))


# Prompt the user to enter a report type id for the job. Then return the id.
def get_report_type_id_from_user():
  report_type_id = raw_input('Please enter the reportTypeId for the job: ')
  print ('You chose "%s" as the report type Id for the job.' % report_type_id)
  return report_type_id

# Prompt the user to set a job name
def prompt_user_to_set_job_name():
  job_name = raw_input('Please set a name for the job: ')
  print ('Great! "%s" is a memorable name for this job.' % job_name)
  return job_name


if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  # The 'name' option specifies the name that will be used for the reporting job.
  parser.add_argument('--content-owner', default='',
      help='ID of content owner for which you are retrieving jobs and reports.')
  parser.add_argument('--include-system-managed', default=False,
      help='Whether the API response should include system-managed reports')
  parser.add_argument('--name', default='',
    help='Name for the reporting job. The script prompts you to set a name ' +
         'for the job if you do not provide one using this argument.')
  parser.add_argument('--report-type', default=None,
    help='The type of report for which you are creating a job.')
  args = parser.parse_args()

  youtube_reporting = get_authenticated_service()

  try:
    # Prompt user to select report type if they didn't set one on command line.
    if not args.report_type:
      if list_report_types(youtube_reporting,
                           onBehalfOfContentOwner=args.content_owner,
                           includeSystemManaged=args.include_system_managed):
        args.report_type = get_report_type_id_from_user()
    # Prompt user to set job name if not set on command line.
    if not args.name:
      args.name = prompt_user_to_set_job_name()
    # Create the job.
    if args.report_type:
      create_reporting_job(youtube_reporting,
                           args,
                           onBehalfOfContentOwner=args.content_owner)
  except HttpError, e:
    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)
create_reporting_job.py

مثال ۲: بازیابی یک گزارش

این نمونه کد، متد jobs.list را برای بازیابی لیستی از کارهای گزارش‌دهی فراخوانی می‌کند. سپس متد reports.list را با پارامتر jobId که روی یک شناسه کار خاص تنظیم شده است، فراخوانی می‌کند تا گزارش‌های ایجاد شده توسط آن کار را بازیابی کند. در نهایت، این نمونه، URL دانلود هر گزارش را چاپ می‌کند.

#!/usr/bin/python

###
#
# This script retrieves YouTube Reporting API reports. Use cases:
# 1. If you specify a report URL, the script downloads that report.
# 2. Otherwise, if you specify a job ID, the script retrieves a list of
#    available reports for that job and prompts you to select a report.
#    Then it retrieves that report as in case 1.
# 3. Otherwise, the list retrieves a list of jobs for the user or,
#    if specified, the content owner that the user is acting on behalf of.
#    Then it prompts the user to select a job, and then executes case 2 and
#    then case 1.
# Usage examples:
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --job_id=<JOB_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --report_url=<REPORT_URL> --local_file=<LOCAL_FILE>
#
###

import argparse
import os

import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaIoBaseDownload
from google_auth_oauthlib.flow import InstalledAppFlow
from io import FileIO


# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains
# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
#   https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
#   https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'

# This OAuth 2.0 access scope allows for read access to YouTube Analytics
# monetary reports for the authenticated user's account. Any request that
# retrieves earnings or ad performance metrics must use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'

# Authorize the request and store authorization credentials.
def get_authenticated_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
  good_kwargs = {}
  if kwargs is not None:
    for key, value in kwargs.iteritems():
      if value:
        good_kwargs[key] = value
  return good_kwargs

# Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
def list_reporting_jobs(youtube_reporting, **kwargs):
  # Only include the onBehalfOfContentOwner keyword argument if the user
  # set a value for the --content_owner argument.
  kwargs = remove_empty_kwargs(**kwargs)

  # Retrieve the reporting jobs for the user (or content owner).
  results = youtube_reporting.jobs().list(**kwargs).execute()

  if 'jobs' in results and results['jobs']:
    jobs = results['jobs']
    for job in jobs:
      print ('Reporting job id: %s\n name: %s\n for reporting type: %s\n'
        % (job['id'], job['name'], job['reportTypeId']))
  else:
    print 'No jobs found'
    return False

  return True

# Call the YouTube Reporting API's reports.list method to retrieve reports created by a job.
def retrieve_reports(youtube_reporting, **kwargs):
  # Only include the onBehalfOfContentOwner keyword argument if the user
  # set a value for the --content_owner argument.
  kwargs = remove_empty_kwargs(**kwargs)

  # Retrieve available reports for the selected job.
  results = youtube_reporting.jobs().reports().list(
    **kwargs
  ).execute()

  if 'reports' in results and results['reports']:
    reports = results['reports']
    for report in reports:
      print ('Report dates: %s to %s\n       download URL: %s\n'
        % (report['startTime'], report['endTime'], report['downloadUrl']))


# Call the YouTube Reporting API's media.download method to download the report.
def download_report(youtube_reporting, report_url, local_file):
  request = youtube_reporting.media().download(
    resourceName=' '
  )
  request.uri = report_url
  fh = FileIO(local_file, mode='wb')
  # Stream/download the report in a single request.
  downloader = MediaIoBaseDownload(fh, request, chunksize=-1)

  done = False
  while done is False:
    status, done = downloader.next_chunk()
    if status:
      print 'Download %d%%.' % int(status.progress() * 100)
  print 'Download Complete!'


# Prompt the user to select a job and return the specified ID.
def get_job_id_from_user():
  job_id = raw_input('Please enter the job id for the report retrieval: ')
  print ('You chose "%s" as the job Id for the report retrieval.' % job_id)
  return job_id

# Prompt the user to select a report URL and return the specified URL.
def get_report_url_from_user():
  report_url = raw_input('Please enter the report URL to download: ')
  print ('You chose "%s" to download.' % report_url)
  return report_url

if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  parser.add_argument('--content_owner', default='',
      help='ID of content owner for which you are retrieving jobs and reports')
  parser.add_argument('--job_id', default=None,
      help='ID of the job for which you are retrieving reports. If not ' +
           'provided AND report_url is also not provided, then the script ' +
           'calls jobs.list() to retrieve a list of jobs.')
  parser.add_argument('--report_url', default=None,
      help='URL of the report to retrieve. If not specified, the script ' +
           'calls reports.list() to retrieve a list of reports for the ' +
           'selected job.')
  parser.add_argument('--local_file', default='yt_report.txt',
      help='The name of the local file where the downloaded report will be written.')
  args = parser.parse_args()

  youtube_reporting = get_authenticated_service()
  try:
    # If the user has not specified a job ID or report URL, retrieve a list
    # of available jobs and prompt the user to select one.
    if not args.job_id and not args.report_url:
      if list_reporting_jobs(youtube_reporting,
                             onBehalfOfContentOwner=args.content_owner):
        args.job_id = get_job_id_from_user()

    # If the user has not specified a report URL, retrieve a list of reports
    # available for the specified job and prompt the user to select one.
    if args.job_id and not args.report_url:
      retrieve_reports(youtube_reporting,
                       jobId=args.job_id,
                       onBehalfOfContentOwner=args.content_owner)
      args.report_url = get_report_url_from_user()

    # Download the selected report.
    if args.report_url:
      download_report(youtube_reporting, args.report_url, args.local_file)
  except HttpError, e:
    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)
retrieve_reports.py