import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common'; import { Readable } from 'stream'; export declare namespace youtubereporting_v1 { export interface Options extends GlobalOptions { version: 'v1'; } interface StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth; /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * YouTube Reporting API * * Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files. * * @example * ```js * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * ``` */ export class Youtubereporting { context: APIRequestContext; jobs: Resource$Jobs; media: Resource$Media; reportTypes: Resource$Reporttypes; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * 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); \} */ export interface Schema$Empty { } /** * gdata */ export interface Schema$GdataBlobstore2Info { /** * gdata */ blobGeneration?: string | null; /** * gdata */ blobId?: string | null; /** * gdata */ downloadExternalReadToken?: string | null; /** * gdata */ downloadReadHandle?: string | null; /** * gdata */ readToken?: string | null; /** * gdata */ uploadMetadataContainer?: string | null; } /** * gdata */ export interface Schema$GdataCompositeMedia { /** * gdata */ blobRef?: string | null; /** * gdata */ blobstore2Info?: Schema$GdataBlobstore2Info; /** * gdata */ cosmoBinaryReference?: string | null; /** * gdata */ crc32cHash?: number | null; /** * gdata */ inline?: string | null; /** * gdata */ length?: string | null; /** * gdata */ md5Hash?: string | null; /** * gdata */ objectId?: Schema$GdataObjectId; /** * gdata */ path?: string | null; /** * gdata */ referenceType?: string | null; /** * gdata */ sha1Hash?: string | null; } /** * gdata */ export interface Schema$GdataContentTypeInfo { /** * gdata */ bestGuess?: string | null; /** * gdata */ fromBytes?: string | null; /** * gdata */ fromFileName?: string | null; /** * gdata */ fromHeader?: string | null; /** * gdata */ fromUrlPath?: string | null; } /** * gdata */ export interface Schema$GdataDiffChecksumsResponse { /** * gdata */ checksumsLocation?: Schema$GdataCompositeMedia; /** * gdata */ chunkSizeBytes?: string | null; /** * gdata */ objectLocation?: Schema$GdataCompositeMedia; /** * gdata */ objectSizeBytes?: string | null; /** * gdata */ objectVersion?: string | null; } /** * gdata */ export interface Schema$GdataDiffDownloadResponse { /** * gdata */ objectLocation?: Schema$GdataCompositeMedia; } /** * gdata */ export interface Schema$GdataDiffUploadRequest { /** * gdata */ checksumsInfo?: Schema$GdataCompositeMedia; /** * gdata */ objectInfo?: Schema$GdataCompositeMedia; /** * gdata */ objectVersion?: string | null; } /** * gdata */ export interface Schema$GdataDiffUploadResponse { /** * gdata */ objectVersion?: string | null; /** * gdata */ originalObject?: Schema$GdataCompositeMedia; } /** * gdata */ export interface Schema$GdataDiffVersionResponse { /** * gdata */ objectSizeBytes?: string | null; /** * gdata */ objectVersion?: string | null; } /** * gdata */ export interface Schema$GdataDownloadParameters { /** * gdata */ allowGzipCompression?: boolean | null; /** * gdata */ ignoreRange?: boolean | null; } /** * gdata */ export interface Schema$GdataMedia { /** * gdata */ algorithm?: string | null; /** * gdata */ bigstoreObjectRef?: string | null; /** * gdata */ blobRef?: string | null; /** * gdata */ blobstore2Info?: Schema$GdataBlobstore2Info; /** * gdata */ compositeMedia?: Schema$GdataCompositeMedia[]; /** * gdata */ contentType?: string | null; /** * gdata */ contentTypeInfo?: Schema$GdataContentTypeInfo; /** * gdata */ cosmoBinaryReference?: string | null; /** * gdata */ crc32cHash?: number | null; /** * gdata */ diffChecksumsResponse?: Schema$GdataDiffChecksumsResponse; /** * gdata */ diffDownloadResponse?: Schema$GdataDiffDownloadResponse; /** * gdata */ diffUploadRequest?: Schema$GdataDiffUploadRequest; /** * gdata */ diffUploadResponse?: Schema$GdataDiffUploadResponse; /** * gdata */ diffVersionResponse?: Schema$GdataDiffVersionResponse; /** * gdata */ downloadParameters?: Schema$GdataDownloadParameters; /** * gdata */ filename?: string | null; /** * gdata */ hash?: string | null; /** * gdata */ hashVerified?: boolean | null; /** * gdata */ inline?: string | null; /** * gdata */ isPotentialRetry?: boolean | null; /** * gdata */ length?: string | null; /** * gdata */ md5Hash?: string | null; /** * gdata */ mediaId?: string | null; /** * gdata */ objectId?: Schema$GdataObjectId; /** * gdata */ path?: string | null; /** * gdata */ referenceType?: string | null; /** * gdata */ sha1Hash?: string | null; /** * gdata */ sha256Hash?: string | null; /** * gdata */ timestamp?: string | null; /** * gdata */ token?: string | null; } /** * gdata */ export interface Schema$GdataObjectId { /** * gdata */ bucketName?: string | null; /** * gdata */ generation?: string | null; /** * gdata */ objectName?: string | null; } /** * A job creating reports of a specific type. */ export interface Schema$Job { /** * The creation date/time of the job. */ createTime?: string | null; /** * The date/time when this job will expire/expired. After a job expired, no new reports are generated. */ expireTime?: string | null; /** * The server-generated ID of the job (max. 40 characters). */ id?: string | null; /** * The name of the job (max. 100 characters). */ name?: string | null; /** * The type of reports this job creates. Corresponds to the ID of a ReportType. */ reportTypeId?: string | null; /** * True if this a system-managed job that cannot be modified by the user; otherwise false. */ systemManaged?: boolean | null; } /** * Response message for ReportingService.ListJobs. */ export interface Schema$ListJobsResponse { /** * The list of jobs. */ jobs?: Schema$Job[]; /** * 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. */ nextPageToken?: string | null; } /** * Response message for ReportingService.ListReports. */ export interface Schema$ListReportsResponse { /** * 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. */ nextPageToken?: string | null; /** * The list of report types. */ reports?: Schema$Report[]; } /** * Response message for ReportingService.ListReportTypes. */ export interface Schema$ListReportTypesResponse { /** * 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. */ nextPageToken?: string | null; /** * The list of report types. */ reportTypes?: Schema$ReportType[]; } /** * A report's metadata including the URL from which the report itself can be downloaded. */ export interface Schema$Report { /** * The date/time when this report was created. */ createTime?: string | null; /** * The URL from which the report can be downloaded (max. 1000 characters). */ downloadUrl?: string | null; /** * The end of the time period that the report instance covers. The value is exclusive. */ endTime?: string | null; /** * The server-generated ID of the report. */ id?: string | null; /** * The date/time when the job this report belongs to will expire/expired. */ jobExpireTime?: string | null; /** * The ID of the job that created this report. */ jobId?: string | null; /** * The start of the time period that the report instance covers. The value is inclusive. */ startTime?: string | null; } /** * A report type. */ export interface Schema$ReportType { /** * The date/time when this report type was/will be deprecated. */ deprecateTime?: string | null; /** * The ID of the report type (max. 100 characters). */ id?: string | null; /** * The name of the report type (max. 100 characters). */ name?: string | null; /** * 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. */ systemManaged?: boolean | null; } export class Resource$Jobs { context: APIRequestContext; reports: Resource$Jobs$Reports; constructor(context: APIRequestContext); /** * Creates a job and returns it. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/youtubereporting.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly', * 'https://www.googleapis.com/auth/yt-analytics.readonly', * ], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await youtubereporting.jobs.create({ * // The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). * onBehalfOfContentOwner: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "createTime": "my_createTime", * // "expireTime": "my_expireTime", * // "id": "my_id", * // "name": "my_name", * // "reportTypeId": "my_reportTypeId", * // "systemManaged": false * // } * }, * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", * // "expireTime": "my_expireTime", * // "id": "my_id", * // "name": "my_name", * // "reportTypeId": "my_reportTypeId", * // "systemManaged": false * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ create(params: Params$Resource$Jobs$Create, options: StreamMethodOptions): Promise>; create(params?: Params$Resource$Jobs$Create, options?: MethodOptions): Promise>; create(params: Params$Resource$Jobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Jobs$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Jobs$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * Deletes a job. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/youtubereporting.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly', * 'https://www.googleapis.com/auth/yt-analytics.readonly', * ], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await youtubereporting.jobs.delete({ * // The ID of the job to delete. * jobId: 'placeholder-value', * // The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). * onBehalfOfContentOwner: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // {} * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ delete(params: Params$Resource$Jobs$Delete, options: StreamMethodOptions): Promise>; delete(params?: Params$Resource$Jobs$Delete, options?: MethodOptions): Promise>; delete(params: Params$Resource$Jobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Jobs$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Jobs$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * Gets a job. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/youtubereporting.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly', * 'https://www.googleapis.com/auth/yt-analytics.readonly', * ], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await youtubereporting.jobs.get({ * // The ID of the job to retrieve. * jobId: 'placeholder-value', * // The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). * onBehalfOfContentOwner: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", * // "expireTime": "my_expireTime", * // "id": "my_id", * // "name": "my_name", * // "reportTypeId": "my_reportTypeId", * // "systemManaged": false * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ get(params: Params$Resource$Jobs$Get, options: StreamMethodOptions): Promise>; get(params?: Params$Resource$Jobs$Get, options?: MethodOptions): Promise>; get(params: Params$Resource$Jobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Jobs$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Jobs$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * Lists jobs. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/youtubereporting.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly', * 'https://www.googleapis.com/auth/yt-analytics.readonly', * ], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await youtubereporting.jobs.list({ * // If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted. * includeSystemManaged: 'placeholder-value', * // The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). * onBehalfOfContentOwner: 'placeholder-value', * // Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default. * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method. * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "jobs": [], * // "nextPageToken": "my_nextPageToken" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ list(params: Params$Resource$Jobs$List, options: StreamMethodOptions): Promise>; list(params?: Params$Resource$Jobs$List, options?: MethodOptions): Promise>; list(params: Params$Resource$Jobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Jobs$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Jobs$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } export interface Params$Resource$Jobs$Create extends StandardParameters { /** * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** * Request body metadata */ requestBody?: Schema$Job; } export interface Params$Resource$Jobs$Delete extends StandardParameters { /** * The ID of the job to delete. */ jobId?: string; /** * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; } export interface Params$Resource$Jobs$Get extends StandardParameters { /** * The ID of the job to retrieve. */ jobId?: string; /** * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; } export interface Params$Resource$Jobs$List extends StandardParameters { /** * If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted. */ includeSystemManaged?: boolean; /** * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** * Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** * A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method. */ pageToken?: string; } export class Resource$Jobs$Reports { context: APIRequestContext; constructor(context: APIRequestContext); /** * Gets the metadata of a specific report. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/youtubereporting.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly', * 'https://www.googleapis.com/auth/yt-analytics.readonly', * ], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await youtubereporting.jobs.reports.get({ * // The ID of the job. * jobId: 'placeholder-value', * // The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). * onBehalfOfContentOwner: 'placeholder-value', * // The ID of the report to retrieve. * reportId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", * // "downloadUrl": "my_downloadUrl", * // "endTime": "my_endTime", * // "id": "my_id", * // "jobExpireTime": "my_jobExpireTime", * // "jobId": "my_jobId", * // "startTime": "my_startTime" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ get(params: Params$Resource$Jobs$Reports$Get, options: StreamMethodOptions): Promise>; get(params?: Params$Resource$Jobs$Reports$Get, options?: MethodOptions): Promise>; get(params: Params$Resource$Jobs$Reports$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Jobs$Reports$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Jobs$Reports$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/youtubereporting.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly', * 'https://www.googleapis.com/auth/yt-analytics.readonly', * ], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await youtubereporting.jobs.reports.list({ * // If set, only reports created after the specified date/time are returned. * createdAfter: 'placeholder-value', * // The ID of the job. * jobId: 'placeholder-value', * // The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). * onBehalfOfContentOwner: 'placeholder-value', * // Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default. * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the `ListReports` method. * pageToken: 'placeholder-value', * // If set, only reports whose start time is greater than or equal the specified date/time are returned. * startTimeAtOrAfter: 'placeholder-value', * // If set, only reports whose start time is smaller than the specified date/time are returned. * startTimeBefore: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", * // "reports": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ list(params: Params$Resource$Jobs$Reports$List, options: StreamMethodOptions): Promise>; list(params?: Params$Resource$Jobs$Reports$List, options?: MethodOptions): Promise>; list(params: Params$Resource$Jobs$Reports$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Jobs$Reports$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Jobs$Reports$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } export interface Params$Resource$Jobs$Reports$Get extends StandardParameters { /** * The ID of the job. */ jobId?: string; /** * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** * The ID of the report to retrieve. */ reportId?: string; } export interface Params$Resource$Jobs$Reports$List extends StandardParameters { /** * If set, only reports created after the specified date/time are returned. */ createdAfter?: string; /** * The ID of the job. */ jobId?: string; /** * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** * Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** * A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the `ListReports` method. */ pageToken?: string; /** * If set, only reports whose start time is greater than or equal the specified date/time are returned. */ startTimeAtOrAfter?: string; /** * If set, only reports whose start time is smaller than the specified date/time are returned. */ startTimeBefore?: string; } export class Resource$Media { context: APIRequestContext; constructor(context: APIRequestContext); /** * Method for media download. Download is supported on the URI `/v1/media/{+name\}?alt=media`. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/youtubereporting.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly', * 'https://www.googleapis.com/auth/yt-analytics.readonly', * ], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await youtubereporting.media.download({ * // Name of the media that is being downloaded. * resourceName: '.*', * }); * console.log(res.data); * * // Example response * // { * // "algorithm": "my_algorithm", * // "bigstoreObjectRef": "my_bigstoreObjectRef", * // "blobRef": "my_blobRef", * // "blobstore2Info": {}, * // "compositeMedia": [], * // "contentType": "my_contentType", * // "contentTypeInfo": {}, * // "cosmoBinaryReference": "my_cosmoBinaryReference", * // "crc32cHash": 0, * // "diffChecksumsResponse": {}, * // "diffDownloadResponse": {}, * // "diffUploadRequest": {}, * // "diffUploadResponse": {}, * // "diffVersionResponse": {}, * // "downloadParameters": {}, * // "filename": "my_filename", * // "hash": "my_hash", * // "hashVerified": false, * // "inline": "my_inline", * // "isPotentialRetry": false, * // "length": "my_length", * // "md5Hash": "my_md5Hash", * // "mediaId": "my_mediaId", * // "objectId": {}, * // "path": "my_path", * // "referenceType": "my_referenceType", * // "sha1Hash": "my_sha1Hash", * // "sha256Hash": "my_sha256Hash", * // "timestamp": "my_timestamp", * // "token": "my_token" * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ download(params: Params$Resource$Media$Download, options: StreamMethodOptions): Promise>; download(params?: Params$Resource$Media$Download, options?: MethodOptions): Promise>; download(params: Params$Resource$Media$Download, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; download(params: Params$Resource$Media$Download, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; download(params: Params$Resource$Media$Download, callback: BodyResponseCallback): void; download(callback: BodyResponseCallback): void; } export interface Params$Resource$Media$Download extends StandardParameters { /** * Name of the media that is being downloaded. */ resourceName?: string; } export class Resource$Reporttypes { context: APIRequestContext; constructor(context: APIRequestContext); /** * Lists report types. * @example * ```js * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/youtubereporting.googleapis.com * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis * // ``` * * const {google} = require('googleapis'); * const youtubereporting = google.youtubereporting('v1'); * * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly', * 'https://www.googleapis.com/auth/yt-analytics.readonly', * ], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); * * // Do the magic * const res = await youtubereporting.reportTypes.list({ * // If set to true, also system-managed report types will be returned; otherwise only the report types that can be used to create new reporting jobs will be returned. * includeSystemManaged: 'placeholder-value', * // The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). * onBehalfOfContentOwner: 'placeholder-value', * // Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default. * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListReportTypes` method. * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", * // "reportTypes": [] * // } * } * * main().catch(e => { * console.error(e); * throw e; * }); * * ``` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ list(params: Params$Resource$Reporttypes$List, options: StreamMethodOptions): Promise>; list(params?: Params$Resource$Reporttypes$List, options?: MethodOptions): Promise>; list(params: Params$Resource$Reporttypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Reporttypes$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Reporttypes$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } export interface Params$Resource$Reporttypes$List extends StandardParameters { /** * If set to true, also system-managed report types will be returned; otherwise only the report types that can be used to create new reporting jobs will be returned. */ includeSystemManaged?: boolean; /** * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** * Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** * A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListReportTypes` method. */ pageToken?: string; } export {}; }