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

Network.Google.YouTubeAnalytics

Contents

Service Configuration
API Declaration
Resources
Types

Description

Retrieve your YouTube Analytics reports.

See: YouTube Analytics API Reference

Synopsis

Service Configuration

youTubeAnalyticsService :: Service Source

Default request referring to version v1 of the YouTube Analytics API. This contains the host and root path used as a starting point for constructing service requests.

API Declaration

Represents the entirety of the methods and resources available for the YouTube Analytics API service.

Resources

youtubeAnalytics.batchReportDefinitions.list

module Network.Google.Resource.YouTubeAnalytics.BatchReportDefinitions.List

youtubeAnalytics.batchReports.list

module Network.Google.Resource.YouTubeAnalytics.BatchReports.List

youtubeAnalytics.groupItems.delete

module Network.Google.Resource.YouTubeAnalytics.GroupItems.Delete

youtubeAnalytics.groupItems.insert

module Network.Google.Resource.YouTubeAnalytics.GroupItems.Insert

youtubeAnalytics.groupItems.list

module Network.Google.Resource.YouTubeAnalytics.GroupItems.List

youtubeAnalytics.groups.delete

module Network.Google.Resource.YouTubeAnalytics.Groups.Delete

youtubeAnalytics.groups.insert

module Network.Google.Resource.YouTubeAnalytics.Groups.Insert

youtubeAnalytics.groups.list

module Network.Google.Resource.YouTubeAnalytics.Groups.List

youtubeAnalytics.groups.update

module Network.Google.Resource.YouTubeAnalytics.Groups.Update

youtubeAnalytics.reports.query

module Network.Google.Resource.YouTubeAnalytics.Reports.Query

Types

GroupContentDetails

groupContentDetails :: GroupContentDetails Source

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

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

gcdItemType
gcdItemCount

gcdItemType :: Lens' GroupContentDetails (Maybe Text) Source

gcdItemCount :: Lens' GroupContentDetails (Maybe Word64) Source

Group

data Group Source

Instances

Eq Group Source
Data Group Source
Show Group Source
Generic Group Source
ToJSON Group Source
FromJSON Group Source
type Rep Group Source

group' :: Group Source

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

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

gEtag :: Lens' Group (Maybe Text) Source

gSnippet :: Lens' Group (Maybe GroupSnippet) Source

gKind :: Lens' Group Text Source

gContentDetails :: Lens' Group (Maybe GroupContentDetails) Source

gId :: Lens' Group (Maybe Text) Source

GroupItemResource

groupItemResource :: GroupItemResource Source

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

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

girKind
girId

girKind :: Lens' GroupItemResource (Maybe Text) Source

girId :: Lens' GroupItemResource (Maybe Text) Source

ResultTableColumnHeadersItem

resultTableColumnHeadersItem :: ResultTableColumnHeadersItem Source

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

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

rtchiColumnType :: Lens' ResultTableColumnHeadersItem (Maybe Text) Source

The type of the column (DIMENSION or METRIC).

rtchiName :: Lens' ResultTableColumnHeadersItem (Maybe Text) Source

The name of the dimension or metric.

rtchiDataType :: Lens' ResultTableColumnHeadersItem (Maybe Text) Source

The type of the data in the column (STRING, INTEGER, FLOAT, etc.).

ResultTable

data ResultTable Source

Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending on the metric or dimension, the cell can contain a string (video ID, country code) or a number (number of views or number of likes).

See: resultTable smart constructor.

Instances

Eq ResultTable Source
Data ResultTable Source
Show ResultTable Source
Generic ResultTable Source
ToJSON ResultTable Source
FromJSON ResultTable Source
type Rep ResultTable Source

resultTable :: ResultTable Source

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

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

rtKind :: Lens' ResultTable Text Source

This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable.

rtRows :: Lens' ResultTable [[JSONValue]] Source

The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days.

rtColumnHeaders :: Lens' ResultTable [ResultTableColumnHeadersItem] Source

This value specifies information about the data returned in the rows fields. Each item in the columnHeaders list identifies a field returned in the rows value, which contains a list of comma-delimited data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage.

BatchReportDefinition

data BatchReportDefinition Source

Contains single batchReportDefinition resource.

See: batchReportDefinition smart constructor.

batchReportDefinition :: BatchReportDefinition Source

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

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

brdStatus :: Lens' BatchReportDefinition (Maybe Text) Source

Status of the report definition.

brdKind :: Lens' BatchReportDefinition Text Source

This value specifies the type of data of this item. For batch report definition the kind property value is youtubeAnalytics#batchReportDefinition.

brdName :: Lens' BatchReportDefinition (Maybe Text) Source

Name of the report definition.

brdId :: Lens' BatchReportDefinition (Maybe Text) Source

The ID that YouTube assigns and uses to uniquely identify the report definition.

brdType :: Lens' BatchReportDefinition (Maybe Text) Source

Type of the report definition.

BatchReport

data BatchReport Source

Contains single batchReport resource.

See: batchReport smart constructor.

Instances

Eq BatchReport Source
Data BatchReport Source
Show BatchReport Source
Generic BatchReport Source
ToJSON BatchReport Source
FromJSON BatchReport Source
type Rep BatchReport Source

batchReport :: BatchReport Source

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

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

brTimeUpdated :: Lens' BatchReport (Maybe UTCTime) Source

The time when the report was updated.

brKind :: Lens' BatchReport Text Source

This value specifies the type of data of this item. For batch report the kind property value is youtubeAnalytics#batchReport.

brReportId :: Lens' BatchReport (Maybe Text) Source

The ID of the the report definition.

brTimeSpan :: Lens' BatchReport (Maybe BatchReportTimeSpan) Source

Period included in the report. For reports containing all entities endTime is not set. Both startTime and endTime are inclusive.

brOutputs :: Lens' BatchReport [BatchReportOutputsItem] Source

Report outputs.

brId :: Lens' BatchReport (Maybe Text) Source

The ID that YouTube assigns and uses to uniquely identify the report.

GroupSnippet

groupSnippet :: GroupSnippet Source

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

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

gsPublishedAt
gsTitle

gsPublishedAt :: Lens' GroupSnippet (Maybe UTCTime) Source

gsTitle :: Lens' GroupSnippet (Maybe Text) Source

GroupItem

data GroupItem Source

Instances

Eq GroupItem Source
Data GroupItem Source
Show GroupItem Source
Generic GroupItem Source
ToJSON GroupItem Source
FromJSON GroupItem Source
type Rep GroupItem Source

groupItem :: GroupItem Source

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

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

giEtag :: Lens' GroupItem (Maybe Text) Source

giKind :: Lens' GroupItem Text Source

giResource :: Lens' GroupItem (Maybe GroupItemResource) Source

giGroupId :: Lens' GroupItem (Maybe Text) Source

giId :: Lens' GroupItem (Maybe Text) Source

BatchReportDefinitionList

data BatchReportDefinitionList Source

A paginated list of batchReportDefinition resources returned in response to a youtubeAnalytics.batchReportDefinitions.list request.

See: batchReportDefinitionList smart constructor.

batchReportDefinitionList :: BatchReportDefinitionList Source

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

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

brdlKind
brdlItems

brdlKind :: Lens' BatchReportDefinitionList Text Source

This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportDefinitionList.

brdlItems :: Lens' BatchReportDefinitionList [BatchReportDefinition] Source

A list of batchReportDefinition resources that match the request criteria.

BatchReportList

data BatchReportList Source

A paginated list of batchReport resources returned in response to a youtubeAnalytics.batchReport.list request.

See: batchReportList smart constructor.

batchReportList :: BatchReportList Source

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

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

brlKind
brlItems

brlKind :: Lens' BatchReportList Text Source

This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportList.

brlItems :: Lens' BatchReportList [BatchReport] Source

A list of batchReport resources that match the request criteria.

BatchReportOutputsItem

batchReportOutputsItem :: BatchReportOutputsItem Source

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

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

broiFormat :: Lens' BatchReportOutputsItem (Maybe Text) Source

Format of the output.

broiDownloadURL :: Lens' BatchReportOutputsItem (Maybe Text) Source

Cloud storage URL to download this report. This URL is valid for 30 minutes.

broiType :: Lens' BatchReportOutputsItem Text Source

Type of the output.

BatchReportTimeSpan

data BatchReportTimeSpan Source

Period included in the report. For reports containing all entities endTime is not set. Both startTime and endTime are inclusive.

See: batchReportTimeSpan smart constructor.

batchReportTimeSpan :: BatchReportTimeSpan Source

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

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

brtsStartTime
brtsEndTime

brtsStartTime :: Lens' BatchReportTimeSpan (Maybe UTCTime) Source

Start of the period included in the report. Inclusive.

brtsEndTime :: Lens' BatchReportTimeSpan (Maybe UTCTime) Source

End of the period included in the report. Inclusive. For reports containing all entities endTime is not set.

GroupItemListResponse

data GroupItemListResponse Source

A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.

See: groupItemListResponse smart constructor.

groupItemListResponse :: GroupItemListResponse Source

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

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

gilrEtag :: Lens' GroupItemListResponse (Maybe Text) Source

gilrKind :: Lens' GroupItemListResponse Text Source

gilrItems :: Lens' GroupItemListResponse [GroupItem] Source

GroupListResponse

data GroupListResponse Source

A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.

See: groupListResponse smart constructor.

groupListResponse :: GroupListResponse Source

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

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

glrEtag :: Lens' GroupListResponse (Maybe Text) Source

glrKind :: Lens' GroupListResponse Text Source

glrItems :: Lens' GroupListResponse [Group] Source

Eq GroupContentDetails Source
Data GroupContentDetails Source
Show GroupContentDetails Source
Generic GroupContentDetails Source
ToJSON GroupContentDetails Source
FromJSON GroupContentDetails Source
type Rep GroupContentDetails Source

Eq GroupItemResource Source
Data GroupItemResource Source
Show GroupItemResource Source
Generic GroupItemResource Source
ToJSON GroupItemResource Source
FromJSON GroupItemResource Source
type Rep GroupItemResource Source

Eq ResultTableColumnHeadersItem Source
Data ResultTableColumnHeadersItem Source
Show ResultTableColumnHeadersItem Source
Generic ResultTableColumnHeadersItem Source
ToJSON ResultTableColumnHeadersItem Source
FromJSON ResultTableColumnHeadersItem Source
type Rep ResultTableColumnHeadersItem Source

Eq BatchReportDefinition Source
Data BatchReportDefinition Source
Show BatchReportDefinition Source
Generic BatchReportDefinition Source
ToJSON BatchReportDefinition Source
FromJSON BatchReportDefinition Source
type Rep BatchReportDefinition Source

Eq GroupSnippet Source
Data GroupSnippet Source
Show GroupSnippet Source
Generic GroupSnippet Source
ToJSON GroupSnippet Source
FromJSON GroupSnippet Source
type Rep GroupSnippet Source

Eq BatchReportDefinitionList Source
Data BatchReportDefinitionList Source
Show BatchReportDefinitionList Source
Generic BatchReportDefinitionList Source
ToJSON BatchReportDefinitionList Source
FromJSON BatchReportDefinitionList Source
type Rep BatchReportDefinitionList Source

Eq BatchReportList Source
Data BatchReportList Source
Show BatchReportList Source
Generic BatchReportList Source
ToJSON BatchReportList Source
FromJSON BatchReportList Source
type Rep BatchReportList Source

Eq BatchReportOutputsItem Source
Data BatchReportOutputsItem Source
Show BatchReportOutputsItem Source
Generic BatchReportOutputsItem Source
ToJSON BatchReportOutputsItem Source
FromJSON BatchReportOutputsItem Source
type Rep BatchReportOutputsItem Source

Eq BatchReportTimeSpan Source
Data BatchReportTimeSpan Source
Show BatchReportTimeSpan Source
Generic BatchReportTimeSpan Source
ToJSON BatchReportTimeSpan Source
FromJSON BatchReportTimeSpan Source
type Rep BatchReportTimeSpan Source

Eq GroupItemListResponse Source
Data GroupItemListResponse Source
Show GroupItemListResponse Source
Generic GroupItemListResponse Source
ToJSON GroupItemListResponse Source
FromJSON GroupItemListResponse Source
type Rep GroupItemListResponse Source

Eq GroupListResponse Source
Data GroupListResponse Source
Show GroupListResponse Source
Generic GroupListResponse Source
ToJSON GroupListResponse Source
FromJSON GroupListResponse Source
type Rep GroupListResponse Source