Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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
.
- type GroupsListResource = "youtube" :> ("analytics" :> ("v1" :> ("groups" :> (QueryParam "mine" Bool :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "id" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` GroupListResponse)))))))
- groupsList :: GroupsList
- data GroupsList
- glMine :: Lens' GroupsList (Maybe Bool)
- glOnBehalfOfContentOwner :: Lens' GroupsList (Maybe Text)
- glId :: Lens' GroupsList (Maybe Text)
REST Resource
type GroupsListResource = "youtube" :> ("analytics" :> ("v1" :> ("groups" :> (QueryParam "mine" Bool :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "id" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` GroupListResponse))))))) 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.
Request Lenses
glMine :: Lens' GroupsList (Maybe Bool) Source
Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.
glOnBehalfOfContentOwner :: Lens' GroupsList (Maybe Text) Source
Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.