Network.Google.Resource.YouTubeAnalytics.Reports.Query

Retrieve your YouTube Analytics reports.

See: YouTube Analytics API Reference for youtubeAnalytics.reports.query.

REST Resource

type ReportsQueryResource = "v2" :> ("reports" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "metrics" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "endDate" Text :> (QueryParam "includeHistoricalChannelData" Bool :> (QueryParam "filters" Text :> (QueryParam "uploadType" Text :> (QueryParam "ids" Text :> (QueryParam "startDate" Text :> (QueryParam "currency" Text :> (QueryParam "sort" Text :> (QueryParam "dimensions" Text :> (QueryParam "startIndex" (Textual Int32) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] QueryResponse))))))))))))))))))

A resource alias for youtubeAnalytics.reports.query method which the ReportsQuery request conforms to.

Creating a Request

reportsQuery :: ReportsQuery

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

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

• rqXgafv
• rqMetrics
• rqUploadProtocol
• rqAccessToken
• rqEndDate
• rqIncludeHistoricalChannelData
• rqFilters
• rqUploadType
• rqIds
• rqStartDate
• rqCurrency
• rqSort
• rqDimensions
• rqStartIndex
• rqMaxResults
• rqCallback

data ReportsQuery

Retrieve your YouTube Analytics reports.

See: reportsQuery smart constructor.

Instances

Eq ReportsQuery

Defined in Network.Google.Resource.YouTubeAnalytics.Reports.Query

Methods

(==) :: ReportsQuery -> ReportsQuery -> Bool

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

Data ReportsQuery

Defined in Network.Google.Resource.YouTubeAnalytics.Reports.Query

Methods

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

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

toConstr :: ReportsQuery -> Constr

dataTypeOf :: ReportsQuery -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ReportsQuery -> ReportsQuery

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

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

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

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

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

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

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

Show ReportsQuery

Defined in Network.Google.Resource.YouTubeAnalytics.Reports.Query

Methods

showsPrec :: Int -> ReportsQuery -> ShowS

show :: ReportsQuery -> String

showList :: [ReportsQuery] -> ShowS

Generic ReportsQuery

Defined in Network.Google.Resource.YouTubeAnalytics.Reports.Query

Associated Types

type Rep ReportsQuery :: Type -> Type

Methods

from :: ReportsQuery -> Rep ReportsQuery x

to :: Rep ReportsQuery x -> ReportsQuery

GoogleRequest ReportsQuery

Defined in Network.Google.Resource.YouTubeAnalytics.Reports.Query

Associated Types

type Rs ReportsQuery :: Type

type Scopes ReportsQuery :: [Symbol]

Methods

requestClient :: ReportsQuery -> GClient (Rs ReportsQuery)

type Rep ReportsQuery

Defined in Network.Google.Resource.YouTubeAnalytics.Reports.Query

type Rep ReportsQuery = D1 (MetaData "ReportsQuery" "Network.Google.Resource.YouTubeAnalytics.Reports.Query" "gogol-youtube-analytics-0.4.0-IrfU7WJzyla4uJR5p2EXts" False) (C1 (MetaCons "ReportsQuery'" PrefixI True) ((((S1 (MetaSel (Just "_rqXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_rqMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_rqUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rqAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_rqEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rqIncludeHistoricalChannelData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_rqFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rqUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_rqIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rqStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_rqCurrency") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rqSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_rqDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rqStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :*: (S1 (MetaSel (Just "_rqMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_rqCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes ReportsQuery

Defined in Network.Google.Resource.YouTubeAnalytics.Reports.Query

type Scopes ReportsQuery = "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 ReportsQuery

Defined in Network.Google.Resource.YouTubeAnalytics.Reports.Query

type Rs ReportsQuery = QueryResponse

Request Lenses

rqXgafv :: Lens' ReportsQuery (Maybe Xgafv)

V1 error format.

rqMetrics :: Lens' ReportsQuery (Maybe Text)

A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. required: true, pattern: [0-9a-zA-Z,]+

rqUploadProtocol :: Lens' ReportsQuery (Maybe Text)

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

rqAccessToken :: Lens' ReportsQuery (Maybe Text)

OAuth access token.

rqEndDate :: Lens' ReportsQuery (Maybe Text)

The end date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}

rqIncludeHistoricalChannelData :: Lens' ReportsQuery (Maybe Bool)

If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",

rqFilters :: Lens' ReportsQuery (Maybe Text)

A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (`;`), and the returned result table will satisfy both filters. For example, a filters parameter value of `video==dMH0bHeiRNg;country==IT` restricts the result set to include data for the given video in Italy.",

rqUploadType :: Lens' ReportsQuery (Maybe Text)

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

rqIds :: Lens' ReportsQuery (Maybe Text)

Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the `ids` parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+

rqStartDate :: Lens' ReportsQuery (Maybe Text)

The start date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}

rqCurrency :: Lens' ReportsQuery (Maybe Text)

The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.", pattern: [A-Z]{3}

rqSort :: Lens' ReportsQuery (Maybe Text)

A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+

rqDimensions :: Lens' ReportsQuery (Maybe Text)

A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+

rqStartIndex :: Lens' ReportsQuery (Maybe Int32)

An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1

rqMaxResults :: Lens' ReportsQuery (Maybe Int32)

The maximum number of rows to include in the response.", minValue: 1

rqCallback :: Lens' ReportsQuery (Maybe Text)

JSONP