Activities: list

Funkcja biuletynu kanału została wycofana w YouTube. Metoda activities.list nadal nie zwraca biuletynów kanałów, 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 powiązane z określonym kanałem lub z kanałem użytkownika.

Wpływ na limit: wywołanie tej metody ma koszt limitu wynoszący 1 jednostkę.

Typowe przypadki użycia

Prośba

Żą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 oddzieloną przecinkami listę właściwości zasobu activity, które będzie zawierać odpowiedź interfejsu API.

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

Na poniższej liście znajdziesz nazwy parametrów part, które możesz uwzględnić w wartości parametru:
  • contentDetails
  • id
  • snippet
Filtry (określ dokładnie jeden z tych parametrów)
channelId string
Parametr channelId określa unikalny identyfikator kanału w YouTube. Interfejs API zwróci listę działań tego kanału.
home boolean
Uwaga: ten parametr został wycofany.
W przypadku żądań ustawiających ten parametr odpowiedź interfejsu API zawiera elementy podobne do tych, które użytkownik mógł zobaczyć na stronie głównej YouTube po wylogowaniu się. Pamiętaj, że tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu.
mine boolean
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Ustaw wartość tego parametru na true, aby pobierać plik danych o działaniach uwierzytelnionego użytkownika.
Parametry opcjonalne
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zbiorze wyników. Akceptowane wartości to od 0 do 50 (włącznie). Wartością domyślną jest 5.
pageToken string
Parametr pageToken wskazuje w zestawie wyników konkretną stronę, 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ę wystąpienia aktywności, która może zostać uwzględniona w odpowiedzi interfejsu API. Jeśli wartość parametru określa dzień, ale nie godzinę, wszystkie działania, które miały miejsce w tym dniu, zostaną uwzględnione w zbiorze wyników. Wartość należy podać w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
publishedBefore datetime
Parametr publishedBefore określa datę i godzinę, przed którą musi wystąpić działanie, aby zostało ono uwzględnione w odpowiedzi interfejsu API. Jeśli wartość parametru określa dzień, ale nie godzinę, wszystkie działania, które miały miejsce w tym dniu, będą wykluczone ze zbioru wyników. Wartość należy podać w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
regionCode string
Parametr regionCode informuje interfejs API, że ma zwrócić wyniki dla określonego kraju. Jego wartością jest kod kraju zgodny ze standardem ISO 3166-1 alfa-2. YouTube używa tej wartości, gdy poprzednia aktywność autoryzowanego użytkownika w YouTube nie zapewnia wystarczających informacji do wygenerowania obszaru aktywności.

Treść żądania

Nie podawaj treści żądania podczas wywoływania tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:

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

Właściwości

Poniższa tabela przedstawia właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartością będzie youtube#activityListResponse.
etag etag
ETag tego zasobu.
nextPageToken string
Token, który może być używany jako wartość parametru pageToken w celu pobrania następnej strony w zestawie wyników.
prevPageToken string
Token, który może być używany jako wartość parametru pageToken do pobierania poprzedniej strony w zestawie wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zestawie.
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 szczegółów 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 Ten interfejs API nie ma dostępu do danych o aktywności użytkownika na stronie głównej. Ten błąd może wystąpić, jeśli w nieautoryzowanym żądaniu ustawisz parametr home na true.
notFound (404) channelNotFound Nie udało się znaleźć identyfikatora kanału określonego przez parametr channelId żądania.
notFound (404) homeChannelNotFound W przypadku obecnie uwierzytelnionego użytkownika nie udało się znaleźć kanału na stronie głównej YouTube.
unauthorized (401) authorizationRequired Żądanie używa parametru home, ale nie jest prawidłowo autoryzowane.

Wypróbuj

Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.