API Reference

Interfejs YouTube Analytics API umożliwia pobieranie danych ze Statystyk YouTube kanału i właściciela treści. Interfejs API obsługuje zapytania w czasie rzeczywistym i generuje raport na podstawie parametrów żądania do interfejsu API.

Interfejs API obsługuje 2 typy funkcji:

  • Pobieranie raportów – metoda interfejsu API reports.query umożliwia pobieranie raportów Statystyk YouTube.

  • Zarządzanie grupami w Statystykach YouTube – grupa w YouTube Analytics to niestandardowa kolekcja zawierająca maksymalnie 500 kanałów, filmów, playlist lub zasobów. Interfejs API obsługuje kilka metod tworzenia, pobierania i aktualizowania grup Statystyk YouTube. Właściciele kanałów i treści mogą następnie używać metody reports.query do pobierania danych zbiorczych dla wszystkich elementów w grupie, co może ułatwić analizę skuteczności.

Ta strona zawiera krótki przegląd zasobów i metod interfejsu API, które umożliwiają korzystanie z tych funkcji.

Upoważnienie

Wszystkie żądania do interfejsu YouTube Analytics API muszą być autoryzowane. Przewodnik po autoryzacji zawiera instrukcje pobierania tokenów autoryzacji za pomocą protokołu OAuth 2.0.

Żądania do interfejsu YouTube Analytics API używają tych zakresów autoryzacji:

Zakresy
https://www.googleapis.com/auth/yt-analytics.readonly Wyświetlaj raporty Statystyk YouTube dotyczące treści w YouTube. Zakres ten zapewnia dostęp do danych o aktywności użytkowników, takich jak liczba wyświetleń i oceny.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Wyświetlanie raportów finansowych Statystyk YouTube dotyczących treści w YouTube Zakres ten umożliwia dostęp do danych o aktywności użytkowników oraz szacunkowych danych o przychodach i skuteczności reklam.
https://www.googleapis.com/auth/youtube Zarządzaj swoim kontem YouTube. W interfejsie YouTube Analytics API właściciele kanałów używają tego zakresu do zarządzania grupami i elementami grup w YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Wyświetlanie zasobów YouTube i powiązanych treści w YouTube oraz zarządzanie nimi. W interfejsie YouTube Analytics API właściciele treści używają tego zakresu do zarządzania grupami i elementami grup w YouTube Analytics.

Pobieranie raportu

Metoda reports.query interfejsu API umożliwia pobieranie wielu różnych raportów Statystyk YouTube. Każde żądanie używa parametrów zapytania do określenia identyfikatora kanału lub właściciela treści, daty rozpoczęcia i zakończenia oraz co najmniej 1 rodzaju danych. Możesz też podać dodatkowe parametry zapytania, takie jak wymiary, filtry i instrukcje sortowania.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://youtubeanalytics.googleapis.com/v2
query GET /reports Pobiera raport YouTube Analytics. Każde żądanie interfejsu API używa parametrów zapytania do określenia identyfikatora kanału lub właściciela treści, daty rozpoczęcia i zakończenia oraz co najmniej 1 rodzaju danych. Możesz też podać dodatkowe parametry zapytania, takie jak wymiary, filtry lub instrukcje sortowania.
  • Dane to indywidualne pomiary aktywności użytkowników, takie jak wyświetlenia filmów lub oceny (oceny pozytywne i negatywne).
  • Wymiary to typowe kryteria używane do agregowania danych, takie jak data aktywności użytkownika lub kraj zamieszkania. W każdym wierszu danych w raporcie występuje unikalna kombinacja wartości wymiaru.
  • Filtry to wartości wymiarów określające dane, które zostaną pobrane. Możesz na przykład pobrać dane dotyczące konkretnego kraju, konkretnego filmu lub grupy filmów.
Listy obsługiwanych raportów dotyczących kanałów i raportów właściciela treści definiują poprawne kombinacje danych, wymiarów i filtrów.

Zarządzanie grupami

Interfejs API udostępnia 2 zasoby do tworzenia grup w YouTube Analytics i zarządzania nimi:

Grupy

Zasób group reprezentuje grupę w YouTube Analytics, która jest niestandardową kolekcją maksymalnie 500 kanałów, filmów, playlist lub zasobów.

Wszystkie elementy w grupie muszą mieć ten sam typ zasobu. Nie możesz na przykład utworzyć grupy zawierającej 100 filmów i 100 playlist.

Grupa w Analytics może zawierać tylko zasoby, które zostały przez Ciebie przesłane lub objęte roszczeniem albo są połączone z kanałem, którym zarządzasz. W rezultacie właściciele kanałów mogą tworzyć grupy filmów i playlist. Właściciele treści mogą tworzyć grupy filmów, playlist, kanałów i zasobów.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://youtubeanalytics.googleapis.com/v2
list GET /groups Zwraca listę grup pasujących do parametrów żądania do interfejsu API. Możesz na przykład pobrać wszystkie grupy, których właścicielem jest uwierzytelniony użytkownik, albo pobrać jedną lub kilka grup według ich unikalnych identyfikatorów.
insert POST /groups Tworzy grupę Statystyk YouTube. Po utworzeniu grupy użyj metody groupItems.insert, aby dodać elementy do grupy.
update PUT /groups Modyfikuje metadane grupy. Obecnie jedyną usługą, którą można zaktualizować, jest tytuł grupy. Aby dodawać i usuwać elementy, użyj groupItems.insert i groupItems.delete.
delete DELETE /groups Usunięcie grupy.

Obiekty GroupGroup

Zasób groupItem reprezentuje element w grupie YouTube Analytics.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://youtubeanalytics.googleapis.com/v2
list GET /groupItems Zwraca kolekcję elementów grupy, które pasują do parametrów żądania do interfejsu API.
insert POST /groupItems Tworzy element grupy.
delete DELETE /groupItems Usuwa element z grupy.