YouTube Reporting API

Interfejs API YouTube do raportowania umożliwia deweloperom planowanie zadań raportowania, a następnie pobieranie wygenerowanych raportów zbiorczych. Interfejs API obsługuje wstępnie zdefiniowany zestaw raportów, z których każdy zawiera obszerny zestaw danych ze Statystyk YouTube dotyczących kanału lub właściciela treści.

Poniżej znajdziesz instrukcje planowania zadań raportowania i pobierania raportów:

  1. Wywołaj metodę reportTypes.list(), aby pobrać listę raportów, które może pobrać kanał lub właściciel treści.
  2. Wywołaj metodę jobs.create(), aby określić raport, który ma zostać wygenerowany dla kanału lub właściciela treści. Następnie możesz użyć funkcji jobs.list() i jobs.delete() interfejsu API, aby pobrać lub zmienić listę generowanych raportów.
  3. Wywołaj metodę jobs.reports.list(), aby pobrać listę raportów wygenerowanych dla konkretnego zadania. Każdy zasób w odpowiedzi zawiera właściwość downloadUrl, która określa adres URL, z którego można pobrać raport.
  4. Wysyłanie autoryzowanego żądania GET w celu pobrania raportu z adresu URL pobierania.

Autoryzacja

Wszystkie żądania do interfejsu YouTube Reporting API muszą być autoryzowane. W przewodniku po autoryzacji znajdziesz informacje o tym, jak używać protokołu OAuth 2.0 do pobierania tokenów autoryzacji.

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

Zakresy
https://www.googleapis.com/auth/yt-analytics.readonly Wyświetlanie raportów Statystyk YouTube dotyczących treści w YouTube. Ten zakres 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 zapewnia dostęp do danych o aktywności użytkowników oraz do szacunkowych danych o przychodach i skuteczności reklam.

Typy zasobów

W sekcjach poniżej znajdziesz ogólne opisy zasobów i metod interfejsu API. Wszystkie identyfikatory URI metod podane w tabelach są względne względem https://youtubereporting.googleapis.com.

zadania

Metody
create POST /v1/jobs
Tworzy zadanie raportowania. Tworząc zadanie raportowania, instruujesz YouTube, aby codziennie generował ten raport. Raport jest dostępny w ciągu 24 godzin od utworzenia zadania.
delete DELETE /v1/jobs/{jobId}
Usuwa zadanie raportowania.
get GET /v1/jobs/{jobId}
Pobiera informacje o konkretnym zadaniu raportowania, które zostało zaplanowane dla kanału lub właściciela treści.
list GET /v1/jobs
Wyświetla listę zadań raportowania zaplanowanych dla kanału lub właściciela treści. Każdy zasób w odpowiedzi zawiera właściwość id, która określa identyfikator używany przez YouTube do jednoznacznego identyfikowania zadania. Jest on potrzebny do pobrania listy raportów wygenerowanych dla zadania lub do usunięcia zadania.

jobs.reports

Metody
get GET /v1/jobs/{jobId}/reports/{reportId}
Pobiera metadane określonego raportu.
list GET /v1/jobs/{jobId}/reports
Zawiera listę raportów wygenerowanych dla określonego zadania raportowania.

reportTypes

Metody
list GET /v1/reportTypes
Zwraca listę typów raportów, które może pobrać właściciel kanału lub treści.