activities.list
nie zwraca biuletynów kanału, a metoda activities.insert
nie jest już obsługiwana. Więcej informacji znajdziesz w Centrum pomocy YouTube.
Zwraca listę zdarzeń związanych z aktywnością na kanale, które spełniają kryteria żądania. Możesz na przykład pobierać zdarzenia dotyczące konkretnego kanału lub kanału użytkownika.
Wpływ limitu: wywołanie tej metody ma limit limitu wynoszący 1 jednostkę.
Typowe przypadki użycia
Żądanie
Żądanie HTTP
GET https://www.googleapis.com/youtube/v3/activities
Parametry
W poniższej tabeli podano parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.
Parametry | ||
---|---|---|
Parametry wymagane | ||
part |
string Parametr part określa rozdzieloną przecinkami listę co najmniej jednej właściwości zasobu activity , która ma być uwzględniona w odpowiedzi interfejsu API.Jeśli parametr wskazuje właściwość zawierającą właściwości podrzędne, zostaną one uwzględnione w odpowiedzi. Na przykład w zasobie activity właściwość snippet zawiera inne właściwości, które identyfikują rodzaj działania, wyświetlany tytuł aktywności itd. Jeśli ustawisz part=snippet , odpowiedź interfejsu API będzie też zawierać wszystkie te zagnieżdżone właściwości.Ta lista zawiera nazwy part , które możesz uwzględnić w wartości parametru:
|
|
Filtry (podaj jeden z tych parametrów) | ||
channelId |
string Parametr channelId określa unikalny identyfikator kanału w YouTube. Interfejs API zwróci listę aktywności na tym kanale. |
|
home |
boolean Uwaga: ten parametr został wycofany. W przypadku żądań, które go ustawiają, odpowiedź interfejsu API zawiera elementy podobne do tych, które widzą niezalogowani użytkownicy na stronie głównej YouTube. Pamiętaj, że tego parametru możesz używać tylko w prawidłowym żądaniu. |
|
mine |
boolean Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Ustaw wartość tego parametru na true , aby pobierać kanał aktywności uwierzytelnionego użytkownika. |
|
Parametry opcjonalne | ||
maxResults |
unsigned integer Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zestawie wyników. Akceptowane wartości to 0 –50 (włącznie). Wartością domyślną jest 5 . |
|
pageToken |
string Parametr pageToken wskazuje konkretną stronę w zestawie wyników, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken wskazują inne strony, które można pobrać. |
|
publishedAfter |
datetime Parametr publishedAfter określa najwcześniejszą datę i godzinę, w jakim mogło wystąpić działanie na potrzeby uwzględnienia w odpowiedzi interfejsu API. Jeśli wartość parametru określa dzień, ale nie godzinę, wszystkie działania, które miały miejsce w danym dniu, zostaną uwzględnione w zestawie wyników. Wartość ma format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ). |
|
publishedBefore |
datetime Parametr publishedBefore określa datę i godzinę wystąpienia aktywności, po której ma się ona pojawić w odpowiedzi interfejsu API. Jeśli wartość parametru określa dzień, ale nie godzinę, wszystkie działania, które miały miejsce w danym dniu, zostaną wykluczone z zestawu wyników. Wartość ma format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ). |
|
regionCode |
string Parametr regionCode nakazuje interfejsowi API zwrócenie wyników dla określonego kraju. Wartością tego parametru jest kod kraju w formacie ISO 3166-1 alfa-2. YouTube używa tej wartości, gdy wcześniejsza aktywność autoryzowanego użytkownika w YouTube nie dostarcza wystarczających informacji do wygenerowania kanału aktywności. |
Treść żądania
Podczas wywoływania tej metody nie podawaj treści żądania.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź w następującym formacie:
{ "kind": "youtube#activityListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ activity Resource ] }
Usługi
Poniższa tabela określa właściwości, które pojawiają się w tym zasobie:
Usługi | |
---|---|
kind |
string Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#activityListResponse . |
etag |
etag Otagowanie tego zasobu. |
nextPageToken |
string Token, który może zostać użyty jako wartość parametru pageToken , by pobrać następną stronę z zestawu wyników. |
prevPageToken |
string Token, którego można użyć jako wartości parametru pageToken w celu pobrania poprzedniej strony z zestawu wyników. |
pageInfo |
object Obiekt pageInfo zawiera informacje o stronicowaniu dla zestawu wyników. |
pageInfo.totalResults |
integer Łączna liczba wyników w zestawie wyników. |
pageInfo.resultsPerPage |
integer Liczba wyników zawartych w odpowiedzi interfejsu API. |
items[] |
list Lista działań lub zdarzeń, które spełniają kryteria żądania. |
Błędy
W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej informacji znajdziesz w dokumentacji komunikatów o błędach.
Typ błędu | Szczegóły błędu | Opis |
---|---|---|
forbidden (403) |
forbidden |
Żądanie nie jest poprawnie autoryzowane. |
forbidden (403) |
homeParameterDeprecated |
Dane dotyczące aktywności na stronie głównej użytkownika nie są dostępne za pomocą tego interfejsu API. Ten błąd może wystąpić, jeśli w nieautoryzowanym żądaniu ustawisz parametr home na wartość true . |
notFound (404) |
channelNotFound |
Nie można znaleźć identyfikatora kanału zdefiniowanego w parametrze channelId żądania. |
notFound (404) |
homeChannelNotFound |
Nie udało się znaleźć kanału na stronie głównej YouTube dla aktualnie uwierzytelnionego użytkownika. |
unauthorized (401) |
authorizationRequired |
Żądanie używa parametru home , ale nie jest prawidłowo autoryzowane. |
Wypróbuj
Użyj APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.