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 |
- youTubeReportingService :: ServiceConfig
- youTubeAnalyticsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/yt-analytics.readonly"]
- youTubeAnalyticsMonetaryReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/yt-analytics-monetary.readonly"]
- data ListReportsResponse
- listReportsResponse :: ListReportsResponse
- lrrNextPageToken :: Lens' ListReportsResponse (Maybe Text)
- lrrReports :: Lens' ListReportsResponse [Report]
- data Empty
- empty :: Empty
- data Report
- report :: Report
- rJobId :: Lens' Report (Maybe Text)
- rStartTime :: Lens' Report (Maybe Text)
- rDownloadURL :: Lens' Report (Maybe Text)
- rEndTime :: Lens' Report (Maybe Text)
- rId :: Lens' Report (Maybe Text)
- rCreateTime :: Lens' Report (Maybe Text)
- rJobExpireTime :: Lens' Report (Maybe Text)
- data ListReportTypesResponse
- listReportTypesResponse :: ListReportTypesResponse
- lrtrNextPageToken :: Lens' ListReportTypesResponse (Maybe Text)
- lrtrReportTypes :: Lens' ListReportTypesResponse [ReportType]
- data Media
- media :: Media
- mResourceName :: Lens' Media (Maybe Text)
- data Job
- job :: Job
- jName :: Lens' Job (Maybe Text)
- jId :: Lens' Job (Maybe Text)
- jSystemManaged :: Lens' Job (Maybe Bool)
- jReportTypeId :: Lens' Job (Maybe Text)
- jExpireTime :: Lens' Job (Maybe Text)
- jCreateTime :: Lens' Job (Maybe Text)
- data ListJobsResponse
- listJobsResponse :: ListJobsResponse
- ljrNextPageToken :: Lens' ListJobsResponse (Maybe Text)
- ljrJobs :: Lens' ListJobsResponse [Job]
- data ReportType
- reportType :: ReportType
- rtName :: Lens' ReportType (Maybe Text)
- rtId :: Lens' ReportType (Maybe Text)
- rtDeprecateTime :: Lens' ReportType (Maybe Text)
- rtSystemManaged :: Lens' ReportType (Maybe Bool)
Service Configuration
youTubeReportingService :: ServiceConfig Source #
Default request referring to version v1
of the YouTube Reporting API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
youTubeAnalyticsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/yt-analytics.readonly"] Source #
View YouTube Analytics reports for your YouTube content
youTubeAnalyticsMonetaryReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/yt-analytics-monetary.readonly"] Source #
View monetary and non-monetary YouTube Analytics reports for your YouTube content
ListReportsResponse
data ListReportsResponse Source #
Response message for ReportingService.ListReports.
See: listReportsResponse
smart constructor.
listReportsResponse :: ListReportsResponse Source #
Creates a value of ListReportsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrrNextPageToken :: Lens' ListReportsResponse (Maybe Text) Source #
A token to retrieve next page of results. Pass this value in the ListReportsRequest.page_token field in the subsequent call to `ListReports` method to retrieve the next page of results.
lrrReports :: Lens' ListReportsResponse [Report] Source #
The list of report types.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
Report
A report's metadata including the URL from which the report itself can be downloaded.
See: report
smart constructor.
Creates a value of Report
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rStartTime :: Lens' Report (Maybe Text) Source #
The start of the time period that the report instance covers. The value is inclusive.
rDownloadURL :: Lens' Report (Maybe Text) Source #
The URL from which the report can be downloaded (max. 1000 characters).
rEndTime :: Lens' Report (Maybe Text) Source #
The end of the time period that the report instance covers. The value is exclusive.
rJobExpireTime :: Lens' Report (Maybe Text) Source #
The date/time when the job this report belongs to will expire/expired.
ListReportTypesResponse
data ListReportTypesResponse Source #
Response message for ReportingService.ListReportTypes.
See: listReportTypesResponse
smart constructor.
listReportTypesResponse :: ListReportTypesResponse Source #
Creates a value of ListReportTypesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrtrNextPageToken :: Lens' ListReportTypesResponse (Maybe Text) Source #
A token to retrieve next page of results. Pass this value in the ListReportTypesRequest.page_token field in the subsequent call to `ListReportTypes` method to retrieve the next page of results.
lrtrReportTypes :: Lens' ListReportTypesResponse [ReportType] Source #
The list of report types.
Media
Media resource.
See: media
smart constructor.
Creates a value of Media
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Job
A job creating reports of a specific type.
See: job
smart constructor.
Creates a value of Job
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jSystemManaged :: Lens' Job (Maybe Bool) Source #
True if this a system-managed job that cannot be modified by the user; otherwise false.
jReportTypeId :: Lens' Job (Maybe Text) Source #
The type of reports this job creates. Corresponds to the ID of a ReportType.
jExpireTime :: Lens' Job (Maybe Text) Source #
The date/time when this job will expire/expired. After a job expired, no new reports are generated.
ListJobsResponse
data ListJobsResponse Source #
Response message for ReportingService.ListJobs.
See: listJobsResponse
smart constructor.
listJobsResponse :: ListJobsResponse Source #
Creates a value of ListJobsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ljrNextPageToken :: Lens' ListJobsResponse (Maybe Text) Source #
A token to retrieve next page of results. Pass this value in the ListJobsRequest.page_token field in the subsequent call to `ListJobs` method to retrieve the next page of results.
ReportType
data ReportType Source #
A report type.
See: reportType
smart constructor.
reportType :: ReportType Source #
Creates a value of ReportType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtDeprecateTime :: Lens' ReportType (Maybe Text) Source #
The date/time when this report type was/will be deprecated.
rtSystemManaged :: Lens' ReportType (Maybe Bool) Source #
True if this a system-managed report type; otherwise false. Reporting jobs for system-managed report types are created automatically and can thus not be used in the `CreateJob` method.