Network.Google.Resource.YouTubeAnalytics.Groups.List

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.

REST Resource

type GroupsListResource = "youtube" :> ("analytics" :> ("v1" :> ("groups" :> (QueryParam "mine" Bool :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GroupListResponse))))))))

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

Creating a Request

groupsList :: GroupsList

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:

• glMine
• glOnBehalfOfContentOwner
• glId
• glPageToken

data GroupsList

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

Methods

(==) :: GroupsList -> GroupsList -> Bool

(/=) :: GroupsList -> GroupsList -> Bool

Data GroupsList

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

Methods

showsPrec :: Int -> GroupsList -> ShowS

show :: GroupsList -> String

showList :: [GroupsList] -> ShowS

Generic GroupsList

Associated Types

type Rep GroupsList :: * -> *

Methods

from :: GroupsList -> Rep GroupsList x

to :: Rep GroupsList x -> GroupsList

GoogleRequest GroupsList

Associated Types

type Rs GroupsList :: *

type Scopes GroupsList :: [Symbol]

Methods

requestClient :: GroupsList -> Client (Rs GroupsList)

type Rep GroupsList

type Rep GroupsList = D1 (MetaData "GroupsList" "Network.Google.Resource.YouTubeAnalytics.Groups.List" "gogol-youtube-analytics-0.2.0-2Ze7g1Sgl6kDT0zCKWDncX" False) (C1 (MetaCons "GroupsList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_glMine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_glOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_glId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_glPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes GroupsList

type Scopes GroupsList = (:) Symbol "https://www.googleapis.com/auth/youtube" ((:) Symbol "https://www.googleapis.com/auth/youtube.readonly" ((:) Symbol "https://www.googleapis.com/auth/youtubepartner" ((:) Symbol "https://www.googleapis.com/auth/yt-analytics.readonly" ([] Symbol))))

type Rs GroupsList

type Rs GroupsList = GroupListResponse

Request Lenses

glMine :: Lens' GroupsList (Maybe Bool)

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)

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.

glId :: Lens' GroupsList (Maybe Text)

The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID.

glPageToken :: Lens' GroupsList (Maybe Text)

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.