Copyright | (c) 2015-2016 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
.
Synopsis
- 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)))))))))))
- groupsList :: GroupsList
- data GroupsList
- glXgafv :: Lens' GroupsList (Maybe Xgafv)
- glMine :: Lens' GroupsList (Maybe Bool)
- glUploadProtocol :: Lens' GroupsList (Maybe Text)
- glAccessToken :: Lens' GroupsList (Maybe Text)
- glUploadType :: Lens' GroupsList (Maybe Text)
- glOnBehalfOfContentOwner :: Lens' GroupsList (Maybe Text)
- glId :: Lens' GroupsList (Maybe Text)
- glPageToken :: Lens' GroupsList (Maybe Text)
- glCallback :: Lens' GroupsList (Maybe Text)
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
Request Lenses
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.
glCallback :: Lens' GroupsList (Maybe Text) Source #
JSONP