gogol-youtube-analytics-0.4.0: Google YouTube Analytics SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.YouTubeAnalytics.Groups.List

Contents

Description

Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

See: YouTube Analytics API Reference for youtubeAnalytics.groups.list.

Synopsis

REST Resource

type GroupsListResource = "v2" :> ("groups" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "mine" Bool :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListGroupsResponse))))))))))) Source #

A resource alias for youtubeAnalytics.groups.list method which the GroupsList request conforms to.

Creating a Request

groupsList :: GroupsList Source #

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

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

data GroupsList Source #

Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

See: groupsList smart constructor.

Instances
Eq GroupsList Source # 
Instance details

Defined in Network.Google.Resource.YouTubeAnalytics.Groups.List

Data GroupsList Source # 
Instance details

Defined in Network.Google.Resource.YouTubeAnalytics.Groups.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GroupsList -> c GroupsList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GroupsList #

toConstr :: GroupsList -> Constr #

dataTypeOf :: GroupsList -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GroupsList) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GroupsList) #

gmapT :: (forall b. Data b => b -> b) -> GroupsList -> GroupsList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GroupsList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GroupsList -> r #

gmapQ :: (forall d. Data d => d -> u) -> GroupsList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GroupsList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GroupsList -> m GroupsList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GroupsList -> m GroupsList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GroupsList -> m GroupsList #

Show GroupsList Source # 
Instance details

Defined in Network.Google.Resource.YouTubeAnalytics.Groups.List

Generic GroupsList Source # 
Instance details

Defined in Network.Google.Resource.YouTubeAnalytics.Groups.List

Associated Types

type Rep GroupsList :: Type -> Type #

GoogleRequest GroupsList Source # 
Instance details

Defined in Network.Google.Resource.YouTubeAnalytics.Groups.List

Associated Types

type Rs GroupsList :: Type #

type Scopes GroupsList :: [Symbol] #

type Rep GroupsList Source # 
Instance details

Defined in Network.Google.Resource.YouTubeAnalytics.Groups.List

type Scopes GroupsList Source # 
Instance details

Defined in Network.Google.Resource.YouTubeAnalytics.Groups.List

type Scopes GroupsList = "https://www.googleapis.com/auth/youtube" ': ("https://www.googleapis.com/auth/youtube.readonly" ': ("https://www.googleapis.com/auth/youtubepartner" ': ("https://www.googleapis.com/auth/yt-analytics-monetary.readonly" ': ("https://www.googleapis.com/auth/yt-analytics.readonly" ': ([] :: [Symbol])))))
type Rs GroupsList Source # 
Instance details

Defined in Network.Google.Resource.YouTubeAnalytics.Groups.List

Request Lenses

glXgafv :: Lens' GroupsList (Maybe Xgafv) Source #

V1 error format.

glMine :: Lens' GroupsList (Maybe Bool) Source #

This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user.

glUploadProtocol :: Lens' GroupsList (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

glAccessToken :: Lens' GroupsList (Maybe Text) Source #

OAuth access token.

glUploadType :: Lens' GroupsList (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

glOnBehalfOfContentOwner :: Lens' GroupsList (Maybe Text) Source #

This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

glId :: Lens' GroupsList (Maybe Text) Source #

The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`.

glPageToken :: Lens' GroupsList (Maybe Text) Source #

The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved.