Network.Google.YouTubeReporting.Types

Service Configuration

youTubeReportingService :: Service

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

ytAnalyticsReadonlyScope :: OAuthScope

View YouTube Analytics reports for your YouTube content

ytAnalyticsMonetaryReadonlyScope :: OAuthScope

View monetary and non-monetary YouTube Analytics reports for your YouTube content

ListReportsResponse

data ListReportsResponse

Response message for ReportingService.ListReports.

See: listReportsResponse smart constructor.

Instances

Eq ListReportsResponse

Data ListReportsResponse

Show ListReportsResponse

Generic ListReportsResponse

ToJSON ListReportsResponse

FromJSON ListReportsResponse

type Rep ListReportsResponse

listReportsResponse :: ListReportsResponse

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
• lrrReports

lrrNextPageToken :: Lens' ListReportsResponse (Maybe Text)

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]

The list of report types.

Empty

data 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.

Instances

Eq Empty

Data Empty

Show Empty

Generic Empty

ToJSON Empty

FromJSON Empty

type Rep Empty

empty :: Empty

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

Report

data Report

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

See: report smart constructor.

Instances

Eq Report

Data Report

Show Report

Generic Report

ToJSON Report

FromJSON Report

type Rep Report

report :: Report

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
• rStartTime
• rDownloadURL
• rEndTime
• rId
• rCreateTime

rJobId :: Lens' Report (Maybe Text)

The ID of the job that created this report.

rStartTime :: Lens' Report (Maybe Text)

The start of the time period that the report instance covers. The value is inclusive.

rDownloadURL :: Lens' Report (Maybe Text)

The URL from which the report can be downloaded (max. 1000 characters).

rEndTime :: Lens' Report (Maybe Text)

The end of the time period that the report instance covers. The value is exclusive.

rId :: Lens' Report (Maybe Text)

The server-generated ID of the report.

rCreateTime :: Lens' Report (Maybe Text)

The date/time when this report was created.

ListReportTypesResponse

data ListReportTypesResponse

Response message for ReportingService.ListReportTypes.

See: listReportTypesResponse smart constructor.

Instances

Eq ListReportTypesResponse

Data ListReportTypesResponse

Show ListReportTypesResponse

Generic ListReportTypesResponse

ToJSON ListReportTypesResponse

FromJSON ListReportTypesResponse

type Rep ListReportTypesResponse

listReportTypesResponse :: ListReportTypesResponse

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
• lrtrReportTypes

lrtrNextPageToken :: Lens' ListReportTypesResponse (Maybe Text)

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]

The list of report types.

Media

data Media

Media resource.

See: media smart constructor.

Instances

Eq Media

Data Media

Show Media

Generic Media

ToJSON Media

FromJSON Media

type Rep Media

media :: Media

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

mResourceName :: Lens' Media (Maybe Text)

Name of the media resource.

Job

data Job

A job creating reports of a specific type.

See: job smart constructor.

Instances

Eq Job

Data Job

Show Job

Generic Job

ToJSON Job

FromJSON Job

type Rep Job

job :: Job

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
• jId
• jReportTypeId
• jCreateTime

jName :: Lens' Job (Maybe Text)

The name of the job (max. 100 characters). TODO(lanthaler) Clarify what this will actually be used for

jId :: Lens' Job (Maybe Text)

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

jReportTypeId :: Lens' Job (Maybe Text)

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

jCreateTime :: Lens' Job (Maybe Text)

The creation date/time of the job.

ListJobsResponse

data ListJobsResponse

Response message for ReportingService.ListJobs.

See: listJobsResponse smart constructor.

Instances

Eq ListJobsResponse

Data ListJobsResponse

Show ListJobsResponse

Generic ListJobsResponse

ToJSON ListJobsResponse

FromJSON ListJobsResponse

type Rep ListJobsResponse

listJobsResponse :: ListJobsResponse

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
• ljrJobs

ljrNextPageToken :: Lens' ListJobsResponse (Maybe Text)

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]

The list of jobs.

ReportType

data ReportType

A report type.

See: reportType smart constructor.

Instances

Eq ReportType

Data ReportType

Show ReportType

Generic ReportType

ToJSON ReportType

FromJSON ReportType

type Rep ReportType

reportType :: ReportType

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
• rtId

rtName :: Lens' ReportType (Maybe Text)

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

rtId :: Lens' ReportType (Maybe Text)

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