YouTube Reporting API - Data Model

ملاحظة: يؤثّر تغيير مرتقب في السياسة على المدة الزمنية التي يمكنك خلالها استرداد تقارير YouTube Reporting API. بعد التغيير، ستصبح تقارير واجهة برمجة التطبيقات اليومية وتقارير إعادة التعبئة متاحة لمدة 60 يومًا (بدلاً من 180 يومًا) من تاريخ إنشائها. ستتوفّر تقارير البيانات السابقة لمدة 30 يومًا من تاريخ إنشائها.

من المقرر حاليًا دخول هذا التغيير حيّز التنفيذ في تموز (يوليو) 2018، وستسري السياسة الجديدة عالميًا على جميع التقارير ومهام إعداد التقارير. انظر سجل النُسخ السابقة لواجهة برمجة التطبيقات للحصول على تفاصيل كاملة حول هذا التغيير.

تتيح واجهة YouTube Reporting API التقارير مسبقة التحديد التي تتضمّن مجموعة شاملة من بيانات "إحصاءات YouTube" لقناة أو مالك محتوى معيّن. تتيح لك هذه التقارير تنزيل مجموعات البيانات المجمّعة التي يمكنك طلبها باستخدام YouTube Analytics API أو في قسم الإحصاءات من "استوديو صنّاع المحتوى".

نظرة عامة

تتضمّن حقول التقارير في هذه التقارير سمات أو مقاييس:

• السمات هي معايير شائعة تُستخدَم لتجميع البيانات، مثل تاريخ حدوث الإجراء أو البلد الذي يقيم فيه المستخدمون. في أيّ تقرير، يحتوي كلّ صف من البيانات على مجموعة فريدة من قيم السمات.
• المقاييس هي مقاييس فردية مرتبطة بنشاط المستخدم أو أداء الإعلانات أو الأرباح المقدَّرة. وتشمل مقاييس نشاط المستخدم عناصر مثل عدد مشاهدات الفيديو والتقييمات (الإعجابات وغير المعجبين).

على سبيل المثال، يحتوي تقرير نشاط المستخدم الأساسي للقنوات على السمات التالية:

• date: تاريخ حدوث النشاط.
• channel_id: القناة على YouTube المرتبطة بالنشاط
• video_id: الفيديو على YouTube المرتبط بالنشاط
• live_or_on_demand: قيمة تشير إلى ما إذا كان المستخدمون يشاهدون بث فيديو مباشرًا.
• subscribed_status: قيمة تشير إلى ما إذا كان المشاهدون مشتركين في القناة.
• country_code: البلد الذي يقيم فيه المشاهدون.

يتضمّن التقرير أيضًا الكثير من المقاييس، مثل المشاهدات والمعجبين وaverage_view_duration_seconds. بعد استرداد التقرير واستيراده، يمكن أن يُجري أحد التطبيقات العديد من العمليات الحسابية المختلفة استنادًا إلى قيم السمات الشائعة.

استرداد تقارير YouTube Analytics

الخطوة 1: استرداد بيانات اعتماد التفويض

يجب أن يتم السماح بجميع طلبات البيانات من YouTube Reporting API. يشرح دليل التفويض كيفية استخدام بروتوكول OAuth 2.0 لاسترداد رموز التفويض.

تستخدم طلبات YouTube Reporting API نطاقات التفويض التالية:

المستويات
https://www.googleapis.com/auth/yt-analytics.readonly	الاطّلاع على تقارير "إحصاءات YouTube" للمحتوى الخاص بك على YouTube يوفّر هذا النطاق إمكانية الوصول إلى مقاييس نشاط المستخدم، مثل عدد المشاهدات وعدد التقييمات.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	يمكنك الاطّلاع على تقارير "إحصاءات YouTube" المالية للمحتوى الخاص بك على YouTube. يوفّر هذا النطاق إمكانية الوصول إلى مقاييس نشاط المستخدِم وإلى مقاييس الأرباح وأداء الإعلانات المقدَّرة.

الخطوة 2: تحديد التقرير المطلوب استرداده

استدعِ طريقة reportTypes.list الخاصة بواجهة برمجة التطبيقات لاسترداد قائمة بالتقارير التي يمكن إنشاؤها للقناة أو لمالك المحتوى. وتعرض الطريقة قائمة بأرقام تعريف التقارير وأسماءها. سجِّل قيمة السمة id للتقارير التي تريد إنشاءها. على سبيل المثال، رقم تعريف تقرير نشاط المستخدم الأساسي للقنوات هو channel_basic_a1.

يمكنك أيضًا العثور على أسماء التقارير في المستندات التي تحدّد تقارير القنوات وتقارير مالكي المحتوى المتوافقة.

الخطوة 3: إنشاء وظيفة إعداد تقارير

ولا يبدأ YouTube بإنشاء تقريرك قبل إنشاء وظيفة إبلاغ لهذا التقرير. (بالتالي، يتم إنشاء التقارير فقط للقنوات ومالكي المحتوى الذين يريدون استردادها).

لإنشاء مهمة إعداد تقارير، عليك طلب طريقة jobs.create الخاصة بواجهة برمجة التطبيقات. اضبط القيم التالية في نص الطلب:

• اضبط قيمة السمة reportTypeId على رقم تعريف التقرير الذي تم استرداده في الخطوة 2.
• اضبط قيمة السمة name على الاسم الذي تريد ربطه بالتقرير.

تشتمل استجابة واجهة برمجة التطبيقات للطريقة jobs.create على مورد Job الذي يحدّد السمة ID التي تُعرّف المهمة بشكل فريد. يمكنك بدء استرجاع التقرير في غضون 48 ساعة من وقت إنشاء الوظيفة، وسيكون أول تقرير متاح هو اليوم الذي حددت فيه الوظيفة.

على سبيل المثال، في حال جدولة وظيفة في 1 أيلول (سبتمبر) 2015، سيكون تقرير 1 أيلول (سبتمبر) 2015 جاهزًا في 3 أيلول (سبتمبر) 2015. سيتم نشر التقرير بتاريخ 2 أيلول (سبتمبر) 2015 في 4 أيلول (سبتمبر) 2015، وهكذا.

الخطوة 4: استرداد معرّف الوظيفة

ملاحظة: إذا خزّن طلبك معرّف الوظيفة المعروض في الخطوة 3، يمكنك تخطّي هذه الخطوة.

عليك استدعاء الطريقة "jobs.list" لاسترداد قائمة المهام المُجدوَلة. تحدد السمة reportTypeId في كل مورد Job تم عرضه نوع التقرير الذي تنشئه هذه المهمة. يحتاج تطبيقك إلى قيمة السمة id من المورد نفسه في الخطوة التالية.

الخطوة 5: استرداد عنوان URL لتنزيل التقرير

استدعِ الطريقة jobs.reports.list لاسترداد قائمة بالتقارير التي تم إنشاؤها للمهمة. في الطلب، اضبط المَعلمة jobId على معرّف الوظيفة للتقرير الذي تريد استرداده.

ملاحظة: استخدِم المَعلمة createdAfter للإشارة إلى أنّه يجب أن تعرض واجهة برمجة التطبيقات التقارير التي تم إنشاؤها بعد فترة زمنية معيّنة فقط. يمكن استخدام هذه المَعلمة لضمان عرض واجهة برمجة التطبيقات للتقارير التي لم تعالجها من قبل.

تتضمّن استجابة واجهة برمجة التطبيقات قائمة تتضمّن Report موردًا لهذه المهمة. يشير كل مورد إلى تقرير يحتوي على بيانات لمدة 24 ساعة فريدة. تجدر الإشارة إلى أنّ YouTube ينشئ تقارير قابلة للتنزيل للأيام التي لم تتوفر فيها أي بيانات. تحتوي هذه التقارير على صف العنوان، ولكنها لا تحتوي على بيانات إضافية.

• وتحدّد السمتان startTime وendTime في المورد الفترة الزمنية التي تغطيها بيانات التقرير.
• تحدّد السمة downloadUrl في المورد عنوان URL الذي يمكن جلب التقرير منه.

• تحدّد السمة createTime في المورد التاريخ والوقت اللذين تم فيهما إنشاء التقرير. ويجب أن يخزِّن تطبيقك هذه القيمة ويستخدمها لتحديد ما إذا كانت التقارير التي تم تنزيلها سابقًا قد تغيّرت أم لا.

الخطوة 6: تنزيل التقرير

أرسِل طلب HTTP GET إلى downloadUrl الذي تم الحصول عليه في الخطوة 5 لاسترداد التقرير.

يمكنك تقليل معدل نقل البيانات اللازم لتنزيل التقارير عن طريق تفعيل ضغط gzip في طلبات التنزيل. على الرغم من أنّ تطبيقك سيحتاج إلى وقت إضافي في وحدة المعالجة المركزية لفك ضغط استجابات واجهة برمجة التطبيقات، فعادةً ما تكون ميزة استهلاك موارد الشبكة أقل من هذه التكلفة.

لتلقّي استجابة بترميز gzip، اضبط عنوان طلب HTTP Accept-Encoding على gzip كما هو موضّح في المثال التالي:

Accept-Encoding: gzip

جارٍ معالجة التقارير

أفضل الممارسات

يجب أن تتّبع التطبيقات التي تستخدم YouTube Reporting API دائمًا الممارسات التالية:

• استخدِم صفّ عنوان التقرير لتحديد ترتيب أعمدة التقرير. على سبيل المثال، لا تفترض أنّ المشاهدات ستكون المقياس الأول الذي يتم عرضه في التقرير لمجرد أنّه المقياس الأول المُدرَج في وصف التقرير. بدلاً من ذلك، يمكنك استخدام صف العنوان في التقرير لتحديد العمود الذي يحتوي على هذه البيانات.

• احتفِظ بسجلّ للتقارير التي نزّلتها لتجنّب تكرار معالجة التقرير نفسه. وتقترح القائمة التالية طريقتين لإجراء ذلك.

  • عند استدعاء الإجراء reports.list، استخدِم المَعلمة createdAfter لاسترداد التقارير التي تمّ إنشاؤها بعد تاريخ محدّد فقط. (يمكنك حذف المعلَمة createdAfter في المرة الأولى التي تسترد فيها التقارير).

    في كلّ مرة يتمّ فيها استرداد التقارير ومعالجتها بنجاح، يمكنك تخزين الطابع الزمني المقابل للتاريخ والوقت الذي تمّ فيه إنشاء أحدث هذه التقارير. بعد ذلك، يمكنك تعديل قيمة المَعلمة createdAfter في كل استدعاء متتابع للطريقة reports.list لضمان استرداد التقارير الجديدة فقط، بما في ذلك التقارير الجديدة التي تتضمّن بيانات سابقة، وذلك في كل مرة يتم فيها طلب واجهة برمجة التطبيقات.

    قبل استرداد التقرير، يُرجى التأكّد أيضًا من أنّ رقم تعريف التقرير غير مدرَج في قاعدة البيانات كإجراء وقائي.

  • خزِّن رقم التعريف لكل تقرير تم تنزيله ومعالجته. يمكنك أيضًا تخزين معلومات إضافية، مثل التاريخ والوقت الذي تم فيه إنشاء كل تقرير أو startTime وendTime في التقرير، واللذَين يحدّدان معًا الفترة التي يحتوي التقرير على بيانات لها. تجدر الإشارة إلى أنّه من المحتمل أن يكون لكل مهمة تقارير متعدّدة لأنّ كل تقرير يحتوي على بيانات لمدة 24 ساعة.

    يمكنك استخدام رقم تعريف التقرير لتحديد التقارير التي لا تزال بحاجة إلى تنزيلها واستيرادها. وإذا كان هناك تقريران جديدان يتضمّنان قيم السمات startTime وendTime نفسها، عليك استيراد التقرير فقط بقيمة createTime الأحدث.

• تتضمن التقارير معرّفات مرتبطة بموارد YouTube، ويمكنك استخدام YouTube Data API لاسترداد البيانات الوصفية الإضافية لهذه الموارد. كما هو موضّح في سياسات المطوّرين لخدمات واجهة برمجة تطبيقات YouTube (الأقسام من III.E.4.b إلى 3.E.4.d)، على برامج واجهة برمجة التطبيقات حذف البيانات الوصفية للموارد المخزَّنة أو إعادة تحميلها من واجهة برمجة التطبيقات هذه بعد 30 يومًا.

خصائص التقرير

تصدر تقارير واجهة برمجة التطبيقات بإصدار ملفات .csv (قيم مفصولة بفواصل) وتتميز بالخصائص التالية:

• يحتوي كل تقرير على بيانات فريدة لمدة 24 ساعة تمتدّ من 12:00 صباحًا إلى 11:59 مساءً بتوقيت المحيط الهادئ. وبالتالي، في أيّ تقرير، تكون قيمة سمة التاريخ دائمًا كما هي.

• ويتم تعديل التقارير يوميًا.

• ينشئ YouTube تقارير قابلة للتنزيل للأيام التي لم تتوفر فيها أي بيانات. وستحتوي هذه التقارير على صف للعناوين، ولكنها لن تحتوي على بيانات إضافية.

• ملاحظة: يؤثّر تغيير مرتقب في السياسة على المدة الزمنية التي يمكنك خلالها استرداد تقارير YouTube Reporting API. من المقرر أن يدخل هذا التغيير حيّز التنفيذ حاليًا في شهر تموز (يوليو) 2018، وسيسري بشكلٍ عام على جميع التقارير ووظائف إعداد التقارير.

  • وقبل التغيير، ستكون تقارير واجهة برمجة التطبيقات متاحة لمدة تصل إلى 180 يومًا من تاريخ إنشائها.
  • وبعد هذا التغيير، ستكون تقارير واجهة برمجة التطبيقات متاحة لمدة 60 يومًا من تاريخ إنشائها، باستثناء البيانات السابقة التي يتم إنشاؤها لمهام إعداد التقارير الجديدة. ولن يبقى بإمكانك الوصول إلى التقارير التي مضى عليها أكثر من 60 يومًا عندما يصبح تغيير السياسة ساريًا.
  • بعد التغيير، ستظل التقارير التي تحتوي على البيانات السابقة متاحة لمدة 30 يومًا من تاريخ إنشائها. لن يصبح من الممكن الوصول إلى التقارير التي تحتوي على البيانات السابقة والتي مضى عليها أكثر من 30 يومًا عندما يصبح تغيير السياسة ساريًا.

• لا تتم فلترة بيانات التقرير. وبناءً على ذلك، يحتوي تقرير القناة على جميع البيانات المتعلقة بالفيديوهات أو قوائم التشغيل على القناة، باستثناء ما هو مذكور في الفقرة التالية المتعلّقة بالموارد المحذوفة. وبالمثل، يحتوي تقرير مالك المحتوى على جميع البيانات المتعلقة بقنوات مالكي المحتوى (الفيديوهات وقوائم التشغيل وأداء الإعلانات وغيرها) باستثناء ما يلي.

  وعلى الرغم من أنّه لا تتم فلترة بيانات التقارير، فإنّ التقارير التي تحتوي على بيانات لفترة زمنية في 1 حزيران (يونيو) 2018 أو بعده لن تحتوي على أي إشارات إلى موارد YouTube التي تم حذفها قبل 30 يومًا على الأقل من تاريخ إنشاء التقرير.

• لا يتم ترتيب بيانات التقرير.

• لا تتضمّن التقارير الصفوف التي لا تحتوي على مقاييس. بعبارة أخرى، يتم استبعاد الصفوف التي لا تحتوي على أي مقاييس من التقرير. على سبيل المثال، إذا لم يحصد أحد الفيديوهات في ألبانيا أي مرات مشاهدة في يوم معيّن، لن يتضمّن تقرير ذلك اليوم صفوفًا لألبانيا.

• لا تحتوي التقارير على صفوف توفر بيانات ملخصة للمقاييس، مثل إجمالي عدد مشاهدات جميع مقاطع الفيديو التابعة للقناة. ويمكنك حساب هذه القيم الإجمالية باعتبارها مجموع القيم الواردة في التقرير، ولكن قد لا يشتمل هذا المجموع على مقاييس للفيديوهات المحذوفة كما هو موضّح أعلاه. يمكنك أيضًا استخدام YouTube Analytics API لعرض الأعداد الإجمالية. تعرض واجهة برمجة تطبيقات YouTube Analytics القيم الإجمالية التي تتضمن مقاييس للموارد المحذوفة على الرغم من عدم الإشارة إلى هذه الموارد بشكل صريح في الردود على واجهة برمجة التطبيقات.

إعادة تعبئة البيانات

تشير بيانات إعادة التعبئة إلى مجموعة بيانات تستبدل مجموعة تم تسليمها سابقًا. عندما يتوفّر تقرير بيانات إعادة التعبئة، يجب أن يسترد تطبيقك التقرير الجديد ويحدِّث البيانات المخزَّنة لتتطابق مع مجموعة البيانات التي تمّت مراجعتها. على سبيل المثال، يمكن لتطبيقك حذف البيانات السابقة للفترة الزمنية المشمولة في التقرير، ثم استيراد مجموعة البيانات الجديدة.

إذا كانت YouTube تتضمّن بيانات إضافة بيانات سابقة، تنشئ تقريرًا جديدًا باستخدام معرّف تقرير جديد. في هذه الحالة، ستتطابق قيم السمتَين startTime وendTime في التقرير مع وقتَي البدء والانتهاء لأي تقرير كان متاحًا في السابق وربّما نزّلته في السابق.

لن تحتوي تقارير إعادة التعبئة التي تتضمّن بيانات لفترة زمنية في 1 حزيران (يونيو) 2018 أو بعده على أي إشارات إلى موارد YouTube التي تم حذفها قبل 30 يومًا على الأقل من تاريخ إنشاء التقرير.

البيانات السابقة

وعند جدولة وظيفة جديدة لإعداد التقارير، يُنشئ YouTube تقارير سابقة تغطي فترة زمنية سابقة على إنشاء الوظيفة. وبالتالي، تشير البيانات السابقة في هذه المستندات إلى تقرير يحتوي على بيانات لفترة زمنية تسبق جدولة مهمة إعداد التقارير.

ملاحظة مهمّة: يؤثّر تغيير مرتقب في السياسة في طول الفترة الزمنية التي يتم خلالها إنشاء بيانات التقرير السابقة. من المقرر أن يدخل هذا التغيير حيّز التنفيذ حاليًا في شهر تموز (يوليو) 2018، وسيسري بشكلٍ عام على جميع التقارير ووظائف إعداد التقارير.

• قبل تغيير السياسة، عند جدولة مهمة إعداد تقارير جديدة، سينشئ YouTube تقارير تغطي فترة الـ 180 يومًا السابقة للوقت الذي أنشأت فيه الوظيفة.
• وعند جدولة مهمة إعداد تقارير جديدة بعد تغيير السياسة، سينشئ فريق YouTube تقارير من ذلك اليوم فصاعدًا ويغطّي فترة 30 يومًا قبل وقت إنشاء الوظيفة.

يتم نشر التقارير السابقة فور توفُّرها. عادةً ما يتم نشر جميع البيانات التاريخية لوظيفة في غضون يومين. كما هو موضّح في قسم خصائص التقرير، بعد تغيير السياسة الذي من المقرر أن يدخل حيّز التنفيذ في تموز (يوليو) 2018، ستكون التقارير التي تحتوي على البيانات السابقة متاحة لمدة 30 يومًا من تاريخ إنشائها. وستتوفّر التقارير التي تتضمّن بيانات غير سابقة لمدّة 60 يومًا بعد تغيير السياسة.

إخفاء هوية البيانات

لضمان إخفاء هوية مشاهدي YouTube، لا يتم عرض قيم لبعض السمات إلا إذا كان مقياس معيّن في الصف نفسه يستوفي حدًا معيّنًا.

على سبيل المثال، في تقرير مصدر زيارات الفيديو للقنوات، يحتوي كلّ صف على عدد من السمات، بما في ذلك traffic_source_type وtraffic_source_detail. يحتوي كل صف أيضًا على مقاييس مختلفة، بما في ذلك المشاهدات. في الصفوف التي تصف الزيارات الناتجة من بحث على YouTube، تحدِّد السمة traffic_source_detail عبارة البحث التي أدّت إلى تلك الزيارات.

في هذا المثال، تنطبق القواعد التالية:

• يحدِّد تقرير مصدر الزيارات عبارة طلب البحث (traffic_source_detail) فقط إذا أدّت إلى عدد معيّن من المشاهدات لفيديو معيّن على الأقل في يوم معيّن. في هذه الحالة، يكون المشاهدات هو المقياس، ويمثل video_id السمة المجمّعة، وtraffic_source_detail السمة المخفية الهوية.

• يتضمّن التقرير صفًا إضافيًا يجمع المقاييس لجميع قيم traffic_source_detail التي لا تستوفي الحدّ الأدنى لعدد المشاهدات. يسجِّل هذا الصف إجمالي عدد المشاهدات المرتبطة بعبارات طلب البحث هذه، ولكنّه لا يحدّد العبارات بحد ذاتها.

توضح الجداول التالية هذه القواعد. يحتوي الجدول الأول على مجموعة افتراضية من البيانات الأولية التي قد يستخدمها YouTube لإنشاء تقرير عن مصدر الزيارات، ويحتوي الجدول الثاني على التقرير نفسه. في هذا المثال، يكون الحدّ الأدنى لعدد المشاهدات هو 10، ما يعني أنّ التقرير يحدّد عبارة بحث فقط إذا أدّت إلى 10 مشاهدات على الأقل لفيديو معيّن في يوم معيّن. (تخضع الحدود الفعلية للتغيير).

البيانات الأولية لعدد زيارات البحث على YouTube لفيديو معيّن

افترض أن البيانات أدناه تصف عدد زيارات البحث على YouTube لفيديو معين في يوم معين.

عبارة البحث	مشاهدة	عدد دقائق المشاهدة المقدّرة
غانغنام ستايل	100	200
جني	15	25
بسي غانغنام	9	15
أوبا غانغنام	5	8
رقصة ركوب الخيل	2	5

نموذج تقرير مصدر الزيارات

يعرض الجدول التالي مقتطفًا من تقرير مصدر الزيارات الذي سيُنشئه YouTube للبيانات الأولية في القسم السابق. (سيحتوى التقرير الفعلي على المزيد من السمات والمقاييس). في هذا المثال، لا يحدّد التقرير عبارات البحث إلا إذا أدّت إلى 10 مشاهدات على الأقل. إنّ الحدود الفعلية عرضة للتغيير.

في الصف الثالث من التقرير، تكون قيمة السمة trafficSourceDetail هي NULL. يتضمّن المقياسان views وestimatedMinutesWatched إجمالي المشاهدات ودقائق المشاهدة لعبارات البحث الثلاث التي أدّت إلى أقل من 10 مشاهدات.

trafficSourceDetail	مشاهدة	estimatedMinutesWatched
غانغنام ستايل	100	200
جني	15	25
فارغ	16	28

الأبعاد الخاضعة لإخفاء الهوية

يحدّد الجدول التالي قيم السمات التي يتم إخفاء هويتها إذا كانت قيم المقاييس المرتبطة لا تستوفي حدًا معيّنًا. في كل حالة، يتم تجميع قيمة المقياس عبر سمة أخرى. على سبيل المثال، إذا كان المقياس هو المشاهدات وكانت سمة التجميع هي video_id، يتم إخفاء هوية قيمة السمة ما لم تتم مشاهدة الفيديو للفيديو لعدد معيّن من المرّات.

المقياس	تجميع السمات	بُعد مجهول الهوية	قيمة مجهولة
subscribers_gained	channel_id	country_code	ZZ
subscribers_gained	channel_id	province_code	US-ZZ
subscribers_lost	channel_id	country_code	ZZ
subscribers_lost	channel_id	province_code	US-ZZ
التعليقات	video_id	country_code	ZZ
التعليقات	video_id	province_code	US-ZZ
عدد المعجبين	video_id	country_code	ZZ
عدد المعجبين	video_id	province_code	US-ZZ
من غير المعجبين	video_id	country_code	ZZ
من غير المعجبين	video_id	province_code	US-ZZ
مشاهدة	video_id	age_group	NULL
مشاهدة	video_id	gender (الجنس)	NULL
مشاهدة	video_id وtraffic_source_detail	traffic_source_detail	NULL
عدد المشتركين في القناة	channel_id	subscribed_status	NULL

عيّنات تعليمات برمجية

توضّح نماذج التعليمات البرمجية التالية كيفية استخدام واجهة برمجة التطبيقات لإنشاء مهمة إعداد تقارير ثم استرداد تقرير لهذه المهمة. يتم توفير نموذجين من التعليمات البرمجية لكل لغة:

1. يعرض النموذج الأول من الرمز البرمجي كيفية استرداد قائمة بأنواع التقارير المتاحة، ثم إنشاء مهمة إعداد تقارير جديدة.

2. يوضح عينة التعليمات البرمجية الثانية كيفية استرداد تقرير لمهمة معينة. يمكنك بدء استرداد التقارير خلال 48 ساعة من وقت إنشاء الوظيفة.

ملاحظة: قد لا تمثّل نماذج الرموز التالية جميع لغات البرمجة المتوافقة. راجِع مستندات مكتبات البرامج للحصول على قائمة باللغات المتوافقة.

Java

تستخدم النماذج التالية مكتبة عميل Java:

• مثال 1: إنشاء وظيفة إعداد تقارير
• المثال 2: استرداد تقرير

مثال 1: إنشاء وظيفة إعداد تقارير

يستدعي نموذج الرمز البرمجي التالي الطريقة 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

المثال 2: استرداد تقرير

يستدعي نموذج الرمز الطريقة 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

تستخدم النماذج التالية مكتبة برامج PHP.

• مثال 1: إنشاء وظيفة إعداد تقارير
• المثال 2: استرداد تقرير

مثال 1: إنشاء وظيفة إعداد تقارير

يستدعي نموذج الرمز البرمجي التالي الطريقة 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

المثال 2: استرداد تقرير

يستدعي نموذج الرمز الطريقة 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

Python

تستخدم النماذج التالية مكتبة عميل Python.

• مثال 1: إنشاء وظيفة إعداد تقارير
• المثال 2: استرداد تقرير

مثال 1: إنشاء وظيفة إعداد تقارير

يستدعي نموذج الرمز البرمجي التالي الطريقة 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

المثال 2: استرداد تقرير

يستدعي نموذج الرمز الطريقة 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