gogol-youtube-reporting-0.0.1: Google YouTube Reporting SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.YouTubeReporting

Contents

Description

An API to schedule reporting jobs and download the resulting bulk data reports about YouTube channels, videos etc. in the form of CSV files.

See: YouTube Reporting API Reference

Synopsis

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

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

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

data Empty Source

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.

empty :: Empty Source

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

Report

data Report Source

A report's metadata including the URL from which the report itself can be downloaded.

See: report smart constructor.

report :: Report Source

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:

rJobId :: Lens' Report (Maybe Text) Source

The ID of the job that created this report.

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.

rId :: Lens' Report (Maybe Text) Source

The server-generated ID of the report.

rCreateTime :: Lens' Report (Maybe Text) Source

The date/time when this report was created.

ListReportTypesResponse

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.

Media

data Media Source

Media resource.

See: media smart constructor.

media :: Media Source

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:

mResourceName :: Lens' Media (Maybe Text) Source

Name of the media resource.

Job

data Job Source

A job creating reports of a specific type.

See: job smart constructor.

job :: Job Source

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

jId :: Lens' Job (Maybe Text) Source

The server-generated ID of the job (max. 40 characters).

jReportTypeId :: Lens' Job (Maybe Text) Source

The type of reports this job creates. Corresponds to the ID of a ReportType.

jCreateTime :: Lens' Job (Maybe Text) Source

The creation date/time of the job.

ListJobsResponse

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

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:

rtName :: Lens' ReportType (Maybe Text) Source

The name of the report type (max. 100 characters).

rtId :: Lens' ReportType (Maybe Text) Source

The ID of the report type (max. 100 characters).