Activities: list

YouTube wycofał funkcję biuletynu kanału. Metoda activities.list nadal 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ń aktywności na kanale, które spełniają kryteria żądania. Możesz na przykład pobrać zdarzenia powiązane z konkretnym kanałem lub z własnym kanałem użytkownika.

Wpływ na limit: wywołanie tej metody wiąże się z kosztem limitu wynoszącym 1 jednostkę.

Częste zastosowania

Żądanie

Żądanie HTTP

GET https://www.googleapis.com/youtube/v3/activities

Parametry

W tabeli poniżej znajdziesz 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 1 właściwości zasobu activity, które mają być uwzględnione w odpowiedzi interfejsu API.

Jeśli parametr identyfikuje właściwość, która zawiera właściwości podrzędne, te właściwości podrzędne zostaną uwzględnione w odpowiedzi. Na przykład w zasobie activity właściwość snippet zawiera inne właściwości, które identyfikują typ aktywności, tytuł wyświetlany aktywności itp. Jeśli ustawisz part=snippet, odpowiedź interfejsu API będzie też zawierać wszystkie te właściwości zagnieżdżone.

Poniższa lista zawiera nazwy part, które możesz uwzględnić w wartości parametru:
  • contentDetails
  • id
  • snippet
Filtry (określ dokładnie 1 z tych parametrów)
channelId string
Parametr channelId określa unikalny identyfikator kanału w YouTube. Interfejs API zwróci wtedy listę aktywności tego kanału.
home boolean
Uwaga: ten parametr został wycofany.
W przypadku żądań, które ustawiają ten parametr, odpowiedź interfejsu API zawiera elementy podobne do tych, które widzi wylogowany użytkownik na stronie głównej YouTube. Pamiętaj, że ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu.
mine boolean
Ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu. Aby pobrać listę aktywności uwierzytelnionego użytkownika, ustaw wartość tego parametru na true.
Parametry opcjonalne
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które mają być zwracane w zbiorze wyników. Akceptowane wartości to od 0 do 50 włącznie. Wartość domyślna to 5.
pageToken string
Parametr pageToken identyfikuje konkretną stronę w zbiorze wyników, która ma zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken identyfikują inne strony, które można pobrać.
publishedAfter datetime
Parametr publishedAfter określa najwcześniejszą datę i godzinę, w których mogła wystąpić aktywność, aby została ona uwzględniona w odpowiedzi interfejsu API. Jeśli wartość parametru określa dzień, ale nie godzinę, w zbiorze wyników zostaną uwzględnione wszystkie aktywności, które miały miejsce tego dnia. Wartość jest podawana w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
publishedBefore datetime
Parametr publishedBefore określa datę i godzinę, przed którymi musiała wystąpić aktywność, aby została ona uwzględniona w odpowiedzi interfejsu API. Jeśli wartość parametru określa dzień, ale nie godzinę, w zbiorze wyników nie zostaną uwzględnione żadne aktywności, które miały miejsce tego dnia. Wartość jest podawana w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
regionCode string
Parametr regionCode nakazuje interfejsowi API zwracanie wyników dla określonego kraju. Wartość parametru to 2-literowy kod kraju ISO 3166-1 alpha-2. YouTube używa tej wartości, gdy poprzednia aktywność autoryzowanego użytkownika w YouTube nie zawiera wystarczających informacji do wygenerowania listy aktywności.

Treść żądania

Podczas wywoływania tej metody nie podawaj treści żądania.

Odpowiedź

Jeśli operacja się uda, ta metoda zwróci treść odpowiedzi o tej strukturze:

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    activity Resource
  ]
}

Właściwości

W tabeli poniżej znajdziesz definicje właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość to youtube#activityListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać następną stronę w zbiorze wyników.
prevPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać poprzednią stronę w zbiorze wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zbiorze wyników.
pageInfo.resultsPerPage integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
items[] list
Lista aktywności 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 prawidłowo autoryzowane.
forbidden (403) homeParameterDeprecated Dane o 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 true.
notFound (404) channelNotFound Nie można znaleźć identyfikatora kanału określonego przez parametr channelId w żądaniu.
notFound (404) homeChannelNotFound Nie można znaleźć listy aktywności 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

Aby wywołać ten interfejs API i zobaczyć żądanie do interfejsu API oraz odpowiedź, użyj APIs Explorer.