Introduction

מסמך זה מסביר את נקודות הדמיון וההבדלים בין הדרכים שבהן ממשק ה-API של YouTube Analytics ו-YouTube Reporting API מספקים גישה לנתוני YouTube Analytics. מטרת המסמך היא לעזור לכם לבחור את ממשק ה-API המתאים לאפליקציה שלכם.

שני ממשקי ה-API מאפשרים למפתחים לאחזר נתונים של YouTube Analytics. בנוסף, שני ממשקי ה-API תומכים בבעלי ערוצים ב-YouTube ובבעלי תוכן ב-YouTube, שכל אחד מהם יכול לגשת לקבוצה ספציפית של דוחות:

  • דוחות ערוצים מכילים מדדי פעילות משתמשים עבור ערוץ מסוים.

  • בדוחות של בעלי התוכן נצברות מדדים לגבי כל הערוצים המקושרים לבעלי תוכן מסוימים ב-YouTube. לדוגמה, לייבל יכול לאחזר דוח שמכיל נתונים סטטיסטיים משולבים לגבי ערוצי YouTube של כל אומני הלייבל. חלק מהדוחות של בעלי התוכן מכילים מדדים של פעילות המשתמשים, ואילו דוחות אחרים מכילים מדדים הקשורים להכנסה ולביצועי מודעות.

Reporting API גם מאפשר לבעלי תוכן מסוימים לגשת לדוחות של הכנסות ממודעות שמנוהלים על ידי המערכת. ניתן לאחזר את הנתונים בדוחות המנוהלים על ידי המערכת רק באמצעות Reporting API.

כל הבקשות ל-YouTube Analytics ול-YouTube Reporting API חייבות להיות מאושרות על ידי הערוץ או בעלי התוכן שבבעלותם הנתונים המבוקשים.

תוכן הדוח

הדוחות שממשקי ה-API מאחזרים מכילים שני סוגי נתונים:

  • מאפיינים הם קריטריונים נפוצים שמשמשים לצבירת נתונים, כמו התאריך שבו התרחשה פעילות המשתמש או המדינה שבה הם היו.

    לכל שורת נתונים בדוח יש שילוב ייחודי של ערכי מאפיינים. לכן, שילוב ערכי המאפיינים בכל שורה משמש כמפתח הראשי של אותה שורה.

  • מדדים הם מדידות נפרדות של פעילות המשתמשים, ביצועי המודעות או ההכנסה המשוערת. מדדי פעילות המשתמשים כוללים נתונים כמו ספירת צפיות בסרטונים ודירוגים (לייקים ודיסלייקים).

בחירת ה-API המתאים לאפליקציה שלכם

ממשק API של YouTube Analytics
YouTube Analytics API תומך בשאילתות ממוקדות בזמן אמת כדי ליצור דוחות YouTube Analytics בהתאמה אישית. ממשק ה-API מספק פרמטרים של סינון ומיון, כך שאפליקציית הקריאות לא צריכה לתמוך בפונקציות האלה במקור.

בכל בקשת API מצוין טווח התאריכים שעבורו יוחזרו הנתונים. ה-API מאפשר גם לאחזר קבוצות נתונים שבועיות וחודשיות. לכן, אפליקציית השיחות לא צריכה לאחסן קבוצות נתונים שאוחזרו או נתונים סטטיסטיים מצטברים בטווחי תאריכים שונים.
Reporting API של YouTube
YouTube Reporting API מאחזר דוחות בכמות גדולה המכילים נתונים מ-YouTube Analytics עבור ערוץ או בעלי תוכן. הוא מיועד לאפליקציות שיכולות לייבא קבוצות נתונים גדולות ומספקות כלים לסינון, מיון וכריית נתונים.

כל דוח מכיל קבוצה מוגדרת מראש של שדות. המפתחים משתמשים ב-API כדי לתזמן משימות דיווח. כל אחת מהמשימות מזהה דוח שהמערכת של YouTube צריכה להפיק. לאחר מכן, המערכת של YouTube יוצרת דוח יומי שניתן להוריד באופן אסינכרוני. כל דוח מכיל נתונים עבור תקופה ייחודית של 24 שעות.

כמו כן, המערכת של YouTube יוצרת באופן אוטומטי קבוצה של דוחות בניהול המערכת עבור בעלי תוכן שיש להם גישה לדוחות המתאימים ב-YouTube Studio. הדוחות האלה מספקים גישה פרוגרמטית לנתוני הכנסות מפרסום.

דוחות נתמכים

בטבלה הבאה מפורטים סוגי הדוחות השונים שניתן לאחזר באמצעות ממשקי ה-API. אפשר לעיין בשאילתות המטורגטות דרך YouTube Analytics API, ואת הדוחות בכמות גדולה אפשר לקבל דרך YouTube Reporting API.

ייתכן שנתונים שזמינים בממשק API אחד לא יהיו זמינים בממשק API אחר. לדוגמה, ממשק ה-API של YouTube Analytics מאפשר לאחזר מדדי פעילות משתמשים על בסיס שבועי או חודשי, אבל ממשק ה-API של דיווח של YouTube מחייב אתכם לצבור את הנתונים האלה בעצמכם. לעומת זאת, ממשק ה-API לדיווח של YouTube תומך בדוחות נכסים עבור בעלי תוכן, אך הנתונים האלה לא יהיו זמינים בממשק ה-API של YouTube Analytics.

סוגי דוחות
דוחות סרטונים נתמכת בערוצים (שאילתות או בכמות גדולה) ובבעלי תוכן (שאילתות או בכמות גדולה).

דוחות סרטונים מספקים נתונים סטטיסטיים לגבי כל פעילות המשתמשים שקשורה לסרטונים בערוץ או לסרטונים של בעלי התוכן. לדוגמה, הדוחות האלה מכילים את מספר הצפיות בסרטונים שלכם. ב-YouTube Analytics API, חלק מהדוחות של סרטונים של בעלי תוכן כוללים גם הכנסות משוערות ומדדים של ביצועי מודעות.
דוחות לגבי פלייליסטים נתמכת בערוצים (שאילתות או בכמות גדולה) ובבעלי תוכן (שאילתות או בכמות גדולה).

דוחות פלייליסטים מספקים נתונים סטטיסטיים שקשורים באופן ספציפי לצפיות בסרטונים שמתרחשות בהקשר של פלייליסט. YouTube Reporting API תומך בדוחות שימור קהל של פלייליסטים, אבל ממשק ה-API של YouTube Analytics לא תומך בדוח דומה.
דוח ביצועי מודעות נתמכת לבעלי תוכן (שאילתות או כמות גדולה).

דוחות ביצועי המודעות מספקים מדדים מבוססי-חשיפות לגבי מודעות שהוצגו במהלך הפעלת הסרטונים. המדדים האלה מביאים בחשבון כל חשיפה של מודעה, וכל הפעלה של סרטון יכולה להניב מספר חשיפות.
דוחות של הכנסות משוערות נתמכת לבעלי תוכן (בכמות גדולה).

דוחות 'הכנסות משוערות' מציגים את סך כל ההכנסות המשוערות מסרטונים ממקורות פרסום שנמכרו על ידי Google וממקורות שאינם פרסום. הדוחות האלה מכילים גם כמה מדדים של ביצועי מודעות. שימו לב שדוחות שמנוהלים על ידי המערכת מכילים את ההכנסות בפועל.
דוחות נכסים נתמכת לבעלי תוכן (בכמות גדולה).

דוחות הנכסים מספקים מדדי פעילות של משתמשים הקשורים לסרטונים שמקושרים לנכסים של בעלי התוכן. סרטון נכלל בדוח של בעלי התוכן אם בעלי התוכן הצהירו על זכויות יוצרים בסרטון הזה כהתאמה לאחד מהנכסים של בעלי התוכן. ייתכן שהסרטון הועלה על ידי בעלי התוכן או על ידי משתמש אחר ב-YouTube.
דוחות בניהול המערכת התכונה נתמכת לבעלי תוכן שיש להם גישה לדוחות התואמים בקטע דוחות ב-YouTube Studio.

דוחות בניהול המערכת מספקים נתוני הכנסות בפועל שהתקבלו מנכסים ומסרטונים. דוח נוסף מפרט את הסרטונים שהוגשה לגביהם תלונה על הפרת זכויות יוצרים ואת הנכסים שנמצאה בהם התאמה לסרטונים האלה. הערה: לא כל הדוחות של הסטודיו ליוצרים זמינים כרגע ב-API.

הערה: המערכת של YouTube יוצרת באופן אוטומטי דוחות שמנוהלים על ידי המערכת לבעלי תוכן שיש להם גישה לדוחות התואמים ב-YouTube Studio. לכן, התהליך לאחזור הדוחות האלה שונה מהתהליך של סוגי הדוחות האחרים שברשימה. מידע נוסף זמין בדוחות בניהול המערכת.

הבדלים עיקריים

בטבלה הבאה מודגשים ההבדלים החשובים בין ממשק ה-API של YouTube Analytics לממשק ה-API לדיווח.

התכונה ממשק API של YouTube Analytics Reporting API של YouTube
תהליך אחזור הנתונים בכל בקשת API מציינים את המאפיינים והמדדים שיש להחזיר, וכן את תקופת הזמן שעבורה הנתונים יוחזרו. משימות דיווח לתזמון אפליקציות. עבור כל משימה, המערכת של YouTube יוצרת דוחות יומיים שניתן להוריד באופן אסינכרוני.
טווחי תאריכים דוחות API מסוימים מציינים את התאריך שבו התרחשה פעילות המשתמש. חלק מהדוחות האלה תומכים במאפיינים לצבירת מדדי פעילות משתמשים לפי חודש. בכל דוחות ה-API מצוין היום שבו התרחשה פעילות המשתמש. אפליקציות שמשתמשות ב-API יכולות להטמיע תכונות לצבירה של נתונים לפרקי זמן תקופתיים.
סינון נתונים אפשר לסנן דוחות כך שיכללו רק שורות שבהן למאפיין יש ערך ספציפי. ה-API תומך גם במאפיינים מסוימים, כמו יבשת ותת-יבשת, שמשמשים רק כמסננים. ה-API תומך בהורדות בכמות גדולה של קבוצות נתונים מלאות. הוא לא תומך בסינון או בהצגת נתונים של מאפיינים עם סינון בלבד. אפליקציית הלקוח מאחסנת את הנתונים שהורדו ומטמיעה תכונות משלה לסינון הנתונים.
עוד כלים ניתן למיין דוחות לפי ערכי מדדים שהוחזרו. חלק מהדוחות תומכים רק במספר מוגבל של תוצאות. לדוגמה, הדוח שמציג את הסרטונים הנצפים ביותר בערוץ מחזיר 200 שורות לכל היותר. ה-API הזה תומך בהורדות בכמות גדולה של קבוצות נתונים מלאות. אפליקציות לקוח יכולות להטמיע תכונות משלהן כדי למיין את הנתונים שהורדו.
ספירות דוחות API מכילים ערכי טקסט, כגון "Android" או "CHANNEL", לזיהוי ערכי מאפיינים ממוספרים. דוחות API מכילים מספרים שלמים שאפשר למפות לערכי טקסט.
מכסה שרת ה-API מבצע הערכה של כל שאילתה כדי לקבוע את עלות המכסה שלה. בקטע שימוש במכסות יש הסבר מפורט על המתודולוגיה. אין בעיה בשימוש במכסה, כי הנתונים מאוחזרים פעם אחת ולאחר מכן מסוננים, ממוינים ונשלחים שאילתות באפליקציה.
דוחות ייחודיים
  • פעילות משתמש הקשורה לכתוביות
  • נתונים לגבי שימור קהל של פלייליסטים
  • דוחות של הכנסות משוערות לבעלי תוכן (קיימים 2 דוחות שונים)
  • דוחות נכסים לבעלי תוכן (קיימים 11 דוחות שונים)
מאפיינים ייחודיים group (מאפיין מסנן בלבד)
continent (מאפיין filter-only)
subContinent (מאפיין filter-only)
חודש
isCurating==1 (מאפיין filter-only)
viewsPerPlaylistStart
TimeInPlaylist
annotation_id
annotation_type
asset_id
card_id
card_type
live_or_on_demand
subscribed_status
subtitle_language
מדדים ייחודיים Uniques
SubscriptionPerformancePerformance
viewsPerPlaylistStart
ממוצעTimeInPlaylist
card_click_rate
card_clicks
card_impressions
card_teaser_click_rate
card_teaser_clicks
card_playlist_impressions
estimated_partner_adsense_revenue
estimated_partner_doubleclick7/Revenueestimated_partner_doubleclick_revenue{1

הבדלים בשמות בין ממשקי API

בשלב זה שני ממשקי ה-API משתמשים במוסכמות שונות של מתן שמות לזיהוי מאפיינים ומדדים. בשלב זה, שמות ה-API של YouTube Analytics משתמשים ב-CalCase, ואילו בשמות של YouTube Reporting API המשתמשים בשמות מופרדים בקו תחתון.

בטבלאות הבאות מופיעים השמות השונים של שני ממשקי ה-API לזיהוי אותם מדדים ומאפיינים. במקרים מסוימים, ההבדל בין שני השמות גדול יותר ממה שתקבל לאחר המרת שם מ-CalCase לקווים תחתונים. לדוגמה, המאפיין video ב-YouTube Analytics API נקרא video_id ב-YouTube Reporting API.

מאפיינים

שם ממשק ה-API של YouTube Analytics השם של YouTube Reporting API
סוג המודעה ad_type
ageGroup age_group [קבוצת_גיל]
נכס asset_id
סוג הקהל audience_retention_type
channel channel_id
claimedStatus (סטטוס תלונה על הפרת זכויות יוצרים) claimed_status
contentOwner (בעלי תוכן) content_owner_id
country country_code [קוד מדינה]
יום date (תאריך)
סוג מכשיר device_type
e LapdVideoTimeRatio elapsed_video_time_percentage
gender gender
insightPlaybackLocationDetail playback_location_detail
insightPlaybackLocationType playback_location_type [סוג_מיקום]
insightTrafficSourceDetail traffic_source_detail
insightTrafficSourceType traffic_source_type
liveOrOnDemand live_or_on_demand
מערכת הפעלה operating_system,
פלייליסט playlist_id
province region_code [קוד_מחוז]
sharingService sharing_service
SubscribedStatus Subscribed_status
שפת המשנה שפת_כתוביות
סוג מעלה uploader_type,
סרטון video_id

מדדים

שם ממשק ה-API של YouTube Analytics השם של YouTube Reporting API
רווחים ממודעות estimated_partner_ad_revenue
חשיפות של הערות annotation_impressions
annotationClickableImpressions annotation_clickable_impressions
annotationClicks annotation_clicks
annotationClickThroughRate annotation_click_through_rate
הערות שניתנות לחשיפות annotation_closable_impressions
annotationCloses annotation_closes
annotationCloseRate annotation_close_rate
audienceWatchRatio (יחס קהל) audience_retention_percentage
AvgViewDuration Avg_view_duration_seconds
AvgViewPercentage Avg_view_duration_percentage
שיעור קליקים על כרטיס card_click_rate
cardClicks card_clicks
חשיפות של כרטיסים card_impressions
cardTeaserClickRate card_teaser_click_rate
cardTeaserClicks card_teaser_clicks
חשיפות של CardTeaser card_teaser_impressions
תגובות תגובות
דיסלייקים דיסלייקים
רווחים estimated_partner_revenue
estimatedMinutesWatched watch_time_minutes
הכנסות משוערות ב-PartnerAdSense estimated_partner_adsense_revenue
אומדן PartnerDoubleClickRevenue estimated_partner_doubleclick_revenue
הכנסה ברוטו estimated_youtube_ad_revenue
impressionBasedCpm אומדן_עלות לאלף חשיפות
חשיפות ad_impressions
לייקים לייקים
הפעלות מונטיזציה estimated_monetized_playbacks
playbackBasedCpm estimated_playback_based_cpm
playlistStarts playlist_starts
savesAdded playlist_saves_added
savesRemoved playlist_saves_removed
מניות מניות
מנויים שנוספו subscribers_gained
מנויים שאבדו subscribers_lost
סרטונים שנוספו לפלייליסטים videos_added_to_playlists
videosRemovedFromפלייליסטים videos_removed_from_playlist
viewerPercentage, views_percentage
צפיות צפיות