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 |
An API to schedule reporting jobs and download the resulting bulk data reports about YouTube channels, videos etc. in the form of CSV files.
- youTubeReportingService :: Service
- type YouTubeReportingAPI = JobsReportsListResource :<|> (JobsReportsGetResource :<|> (JobsListResource :<|> (JobsGetResource :<|> (JobsCreateResource :<|> (JobsDeleteResource :<|> (MediaDownloadResource :<|> ReportTypesListResource))))))
- module Network.Google.Resource.YouTubeReporting.Jobs.Create
- module Network.Google.Resource.YouTubeReporting.Jobs.Delete
- module Network.Google.Resource.YouTubeReporting.Jobs.Get
- module Network.Google.Resource.YouTubeReporting.Jobs.List
- module Network.Google.Resource.YouTubeReporting.Jobs.Reports.Get
- module Network.Google.Resource.YouTubeReporting.Jobs.Reports.List
- module Network.Google.Resource.YouTubeReporting.Media.Download
- module Network.Google.Resource.YouTubeReporting.ReportTypes.List
- 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)
- 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)
- jReportTypeId :: 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)
Service Configuration
youTubeReportingService :: Service 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.
API Declaration
type YouTubeReportingAPI = JobsReportsListResource :<|> (JobsReportsGetResource :<|> (JobsListResource :<|> (JobsGetResource :<|> (JobsCreateResource :<|> (JobsDeleteResource :<|> (MediaDownloadResource :<|> ReportTypesListResource)))))) Source
Represents the entirety of the methods and resources available for the YouTube Reporting API service.
Resources
youtubereporting.jobs.create
youtubereporting.jobs.delete
youtubereporting.jobs.get
youtubereporting.jobs.list
youtubereporting.jobs.reports.get
youtubereporting.jobs.reports.list
youtubereporting.media.download
youtubereporting.reportTypes.list
Types
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.
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:
jName :: Lens' Job (Maybe Text) Source
The name of the job (max. 100 characters). TODO(lanthaler) Clarify what this will actually be used for
jReportTypeId :: Lens' Job (Maybe Text) Source
The type of reports this job creates. Corresponds to the ID of a ReportType.
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.
ljrJobs :: Lens' ListJobsResponse [Job] Source
The list of jobs.
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: