Activities: list

O YouTube descontinuou o recurso de boletim do canal. O método activities.list ainda não retorna boletins do canal, e o método activities.insert não é mais compatível. Para mais detalhes, consulte a Central de Ajuda do YouTube.

Retorna uma lista de eventos de atividade do canal que correspondem aos critérios da solicitação. Por exemplo, é possível recuperar eventos associados a um canal específico ou ao canal do usuário.

Impacto na cota:uma chamada para esse método tem um custo de cota de 1 unidade.

Casos de uso comuns

Solicitação

Solicitação HTTP

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

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. 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 a resposta da API vai incluir.

Se o parâmetro identificar uma propriedade que contém propriedades filhas, elas 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 vai conter todas essas propriedades aninhadas.

A lista a seguir contém os nomes de part que podem ser incluídos no valor de parâmetro:
  • contentDetails
  • id
  • snippet
Filtros (especifique exatamente um dos seguintes parâmetros)
channelId string
O parâmetro channelId especifica um ID exclusivo do canal do YouTube. A API vai retornar uma lista das atividades desse canal.
home boolean
Observação: esse parâmetro foi descontinuado.
Para solicitações que definem esse parâmetro, a resposta da API contém itens semelhantes aos que um usuário desconectado veria na página inicial do YouTube. Esse parâmetro só pode ser usado em uma solicitação devidamente autorizada.
mine boolean
Esse parâmetro só pode ser usado em uma solicitação devidamente autorizada. Defina o valor desse parâmetro como true para recuperar um feed das atividades do usuário autenticado.
Parâmetros opcionais
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados 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 precisa ser retornada. 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 data e hora mais antigas em que uma atividade pode ter ocorrido para ser incluída na resposta da API. Se o valor de parâmetro especificar um dia, mas não um horário, todas as atividades que ocorreram naquele 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 da qual uma atividade precisa ter ocorrido para ser incluída na resposta da API. Se o valor do parâmetro especificar um dia, mas não um horário, todas as atividades que ocorreram naquele 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 a retornar resultados para o país especificado. O valor de parâmetro é um código do país ISO 3166-1 Alfa-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 da solicitação

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

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

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

Propriedades

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

Propriedades
kind string
Identifica o tipo de recurso da API. O valor será youtube#activityListResponse.
etag etag
O Etag desse recurso.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados.
prevPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior no 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
Uma lista de atividades ou eventos que correspondem aos critérios da solicitação.

Erros

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

Tipo de erro Detalhe do erro Descrição
forbidden (403) forbidden A solicitação não está devidamente autorizada.
forbidden (403) homeParameterDeprecated Os dados de atividade da página inicial do usuário não estão disponíveis nessa API. Esse erro poderá ocorrer se você definir o parâmetro home como true em uma solicitação não autorizada.
notFound (404) channelNotFound Não foi possível encontrar o ID do canal identificado pelo parâmetro channelId da solicitação.
notFound (404) homeChannelNotFound O feed da página inicial do YouTube não pode ser encontrado para o usuário autenticado no momento.
unauthorized (401) authorizationRequired A solicitação usa o parâmetro home, mas não está devidamente autorizada.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.