Activities: list

Retorna uma lista de eventos de atividade do canal que correspondem aos critérios da solicitação. Por exemplo, você pode recuperar eventos associados a um determinado canal, eventos associados a inscrições do usuário e amigos do Google+ ou o feed da página inicial do YouTube, que é personalizado para cada usuário. Faça um teste agora.

Solicitação

Solicitação HTTP

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

Parâmetros

A tabela a seguir lista os parâmetros que esta consulta suporta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part string
O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recurso activity que serão incluídas pela resposta da API. Os nomes part que podem ser incluídos no valor do parâmetro são id, snippet e contentDetails.

Se o parâmetro identificar uma propriedade que contenha propriedades criança, estas serão incluídas na resposta. Por exemplo, em um recurso activity, a propriedade snippet contém outras propriedades que identificam o tipo de atividade, um título de exibição para a atividade e assim por diante. Se você definir part=snippet, a resposta da API também conterá todas essas propriedades aninhadas.
Filtros (especifique exatamente um dos seguintes parâmetros)
channelId string
O parâmetro channelId especifica um ID único de canal do YouTube. A API retornará uma lista das atividades desse canal.
home boolean
Este parâmetro pode ser usado apenas em uma solicitação autorizada adequadamente. Defina o valor deste parâmetro como true para recuperar o feed de atividade exibido na página inicial do YouTube para o usuário autenticado no momento.
mine boolean
Este parâmetro pode ser usado apenas em uma solicitação autorizada adequadamente. Defina o valor deste parâmetro como true para recuperar um feed de atividades do usuário autenticado.
Parâmetros opcionais
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que deve ser retornado no conjunto de resultados Os valores aceitáveis são {0/} a 50, inclusive. O valor padrão é 5.
pageToken string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que será retornado. Em uma resposta da API, as propriedades nextPageToken e prevPageToken identificam outras páginas que podem ser recuperadas.
publishedAfter datetime
O parâmetro publishedAfter especifica a primeira data e hora em que uma atividade possa ter ocorrido para ela seja incluída na resposta da API. Se o valor do parâmetro especifica um dia, mas não um horário, todas as atividades ocorridas nesse dia serão incluídas no conjunto de resultados. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
publishedBefore datetime
O parâmetro publishedBefore especifica a data e hora antes das quais uma atividade possa ter ocorrido para ela seja incluída na resposta da API. Se o valor do parâmetro especifica um dia, mas não um horário, todas as atividades ocorridas nesse dia serão excluídas do conjunto de resultados. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
regionCode string
O parâmetro regionCode instrui a API para retornar resultados para o país especificado. O valor do parâmetro é um código de país ISO 3166-1 Alpha 2. O YouTube usa esse valor quando a atividade anterior do usuário autorizado no YouTube não fornece informações suficientes para gerar o feed de atividade.

Corpo de solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, este método retorna um corpo de resposta com a seguinte estrutura:

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

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
kind string
O tipo do recurso da API. O valor será youtube#activityListResponse.
etag etag
A Etag deste recurso.
nextPageToken string
O token que pode ser utilizado como o valor do parâmetro pageToken para recuperar a página seguinte do conjunto de resultados.
prevPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior do conjunto de resultados.
pageInfo object
O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults integer
O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage integer
O número de resultados incluídos na resposta da API.
items[] list
A lista de atividades ou eventos que correspondem aos critérios de solicitação.

Erros

A tabela abaixo identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para este método. Consulte a documentação mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
notFound channelNotFound O ID de canal identificado pelo parâmetro channelId da solicitação não pode ser encontrado.
notFound homeChannelNotFound O feed da página inicial do YouTube não pode ser encontrado para o usuário autenticado no momento.
unauthorized authorizationRequired A solicitação usa o parâmetro home, mas não está devidamente autorizada.

Conheça agora.

Use o Explorador API para chamar este método em dados ativos e ver a solicitação e a resposta da API.