Network.Google.Resource.YouTube.Activities.List

Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.

See: YouTube Data API Reference for youtube.activities.list.

REST Resource

type ActivitiesListResource = "youtube" :> ("v3" :> ("activities" :> (QueryParam "part" Text :> (QueryParam "publishedAfter" DateTime' :> (QueryParam "home" Bool :> (QueryParam "mine" Bool :> (QueryParam "regionCode" Text :> (QueryParam "channelId" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "publishedBefore" DateTime' :> (QueryParam "alt" AltJSON :> Get `[JSON]` ActivityListResponse))))))))))))

A resource alias for youtube.activities.list method which the ActivitiesList request conforms to.

Creating a Request

activitiesList

Arguments

:: Text

alPart

-> ActivitiesList

Creates a value of ActivitiesList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• alPublishedAfter
• alPart
• alHome
• alMine
• alRegionCode
• alChannelId
• alPageToken
• alMaxResults
• alPublishedBefore

data ActivitiesList

Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.

See: activitiesList smart constructor.

Instances

Eq ActivitiesList

Data ActivitiesList

Show ActivitiesList

Generic ActivitiesList

GoogleRequest ActivitiesList

type Rep ActivitiesList

type Rs ActivitiesList = ActivityListResponse

Request Lenses

alPublishedAfter :: Lens' ActivitiesList (Maybe UTCTime)

The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

alPart :: Lens' ActivitiesList Text

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.

alHome :: Lens' ActivitiesList (Maybe Bool)

Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.

alMine :: Lens' ActivitiesList (Maybe Bool)

Set this parameter's value to true to retrieve a feed of the authenticated user's activities.

alRegionCode :: Lens' ActivitiesList (Maybe Text)

The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.

alChannelId :: Lens' ActivitiesList (Maybe Text)

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

alPageToken :: Lens' ActivitiesList (Maybe Text)

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

alMaxResults :: Lens' ActivitiesList Word32

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

alPublishedBefore :: Lens' ActivitiesList (Maybe UTCTime)

The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.