API Reference

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

Interfejs API obsługuje 2 rodzaje funkcji:

  • Pobieranie raportów – metoda reports.query w interfejsie API pobiera raporty Statystyk YouTube.

  • Zarządzanie grupami w Statystykach YouTube – grupa w Statystykach YouTube 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 w Statystykach YouTube. Właściciele kanałów i treści mogą następnie używać metody reports.query do pobierania zagregowanych danych o wszystkich elementach w grupie, co może ułatwić analizę skuteczności.

Na tej stronie znajdziesz krótkie omówienie zasobów interfejsu API i metod, które umożliwiają wykonywanie tych funkcji.

Autoryzacja

Wszystkie żądania do interfejsu YouTube Analytics API muszą być autoryzowane. W przewodniku Autoryzacja znajdziesz informacje o pobieraniu tokenów autoryzacji za pomocą protokołu OAuth 2.0.

Żądania do interfejsu API Statystyk YouTube korzystają z tych zakresów uprawnień:

Zakresy
https://www.googleapis.com/auth/yt-analytics.readonly Wyświetlanie raportów Statystyk YouTube dotyczących treści w YouTube Ten zakres uprawnień zapewnia dostęp do danych o aktywności użytkowników, takich jak liczba wyświetleń i ocen.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Wyświetlanie raportów finansowych Statystyk YouTube dotyczących treści w YouTube Ten zakres uprawnień zapewnia dostęp do danych o aktywności użytkowników oraz szacowanych przychodów i danych o skuteczności reklam.
https://www.googleapis.com/auth/youtube Zarządzanie kontem YouTube. W interfejsie API Statystyk YouTube właściciele kanałów używają tego zakresu do zarządzania grupami i elementami grup w Statystykach YouTube.
https://www.googleapis.com/auth/youtubepartner Wyświetlanie zasobów w YouTube oraz powiązanych z nimi treści i zarządzanie nimi w serwisie YouTube W interfejsie YouTube Analytics API właściciele treści używają tego zakresu do zarządzania grupami i elementami w Statystykach YouTube.

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, daty zakończenia i 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 względne do https://youtubeanalytics.googleapis.com/v2
query GET /reports Pobiera raport Statystyk YouTube. 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, daty zakończenia i co najmniej 1 rodzaju danych. Możesz też podać dodatkowe parametry zapytania, takie jak wymiary, filtry lub instrukcje sortowania.
  • Dane to poszczególne pomiary aktywności użytkowników, np. liczba wyświetleń filmu lub ocen (polubień i głosów na nie).
  • Wymiary to wspólne kryteria służące do agregowania danych, np. data aktywności użytkownika lub kraj, w którym się on znajduje. W raporcie każdy wiersz danych ma unikalną kombinację wartości wymiarów.
  • Filtry to wartości wymiarów, które określają 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 kanałów i raportów właścicieli treści określają prawidłowe kombinacje danych, wymiarów i filtrów.

Zarządzanie grupami

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

Grupy

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

Wszystkie elementy w grupie muszą reprezentować ten sam typ zasobu. Nie możesz np. utworzyć grupy zawierającej 100 filmów i 100 playlist.

Grupa Analytics może zawierać tylko zasoby, które zostały przez Ciebie przesłane lub zgłoszone, albo które są połączone z kanałem, którym zarządzasz. Dzięki temu 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 lub zasobów.

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne do https://youtubeanalytics.googleapis.com/v2
list GET /groups Zwraca listę grup, które pasują do parametrów żądania interfejsu API. Możesz na przykład pobrać wszystkie grupy należące do uwierzytelnionego użytkownika lub pobrać co najmniej 1 grupę według jej unikalnego identyfikatora.
insert POST /groups Tworzy grupę w Statystykach YouTube. Po utworzeniu grupy możesz dodawać do niej elementy za pomocą metody groupItems.insert.
update PUT /groups Modyfikuje metadane grupy. Obecnie jedyną właściwością, którą można zaktualizować, jest tytuł grupy. (użyj elementów groupItems.insert i groupItems.delete, aby dodawać i usuwać elementy grupy).
delete DELETE /groups usuwa grupę.

GroupItems

Zasób groupItem reprezentuje element w grupie w Statystykach YouTube.

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

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