googleapis
Version:
Google APIs Client Library for Node.js
517 lines • 23.3 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace chromemanagement_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;
}
/**
* Chrome Management API
*
* The Chrome Management API is a suite of services that allows Chrome administrators to view, manage and gain insights on their Chrome OS and Chrome Browser devices.
*
* @example
* ```js
* const {google} = require('googleapis');
* const chromemanagement = google.chromemanagement('v1');
* ```
*/
export class Chromemanagement {
context: APIRequestContext;
customers: Resource$Customers;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Describes a browser version and its install count.
*/
export interface Schema$GoogleChromeManagementV1BrowserVersion {
/**
* Output only. The release channel of the installed browser.
*/
channel?: string | null;
/**
* Output only. Count grouped by device_system and major version
*/
count?: string | null;
/**
* Output only. Version of the system-specified operating system.
*/
deviceOsVersion?: string | null;
/**
* Output only. The device operating system.
*/
system?: string | null;
/**
* Output only. The full version of the installed browser.
*/
version?: string | null;
}
/**
* Response containing requested browser versions details and counts.
*/
export interface Schema$GoogleChromeManagementV1CountChromeVersionsResponse {
/**
* List of all browser versions and their install counts.
*/
browserVersions?: Schema$GoogleChromeManagementV1BrowserVersion[];
/**
* Token to specify the next page in the list.
*/
nextPageToken?: string | null;
/**
* Total number browser versions matching request.
*/
totalSize?: number | null;
}
/**
* Response containing details of queried installed apps.
*/
export interface Schema$GoogleChromeManagementV1CountInstalledAppsResponse {
/**
* List of installed apps matching request.
*/
installedApps?: Schema$GoogleChromeManagementV1InstalledApp[];
/**
* Token to specify next page in the list.
*/
nextPageToken?: string | null;
/**
* Total number of installed apps matching request.
*/
totalSize?: number | null;
}
/**
* Describes a device reporting Chrome browser information.
*/
export interface Schema$GoogleChromeManagementV1Device {
/**
* Output only. The ID of the device that reported this Chrome browser information.
*/
deviceId?: string | null;
/**
* Output only. The name of the machine within its local network.
*/
machine?: string | null;
}
/**
* Response containing a list of devices with queried app installed.
*/
export interface Schema$GoogleChromeManagementV1FindInstalledAppDevicesResponse {
/**
* A list of devices which have the app installed. Sorted in ascending alphabetical order on the Device.machine field.
*/
devices?: Schema$GoogleChromeManagementV1Device[];
/**
* Token to specify the next page in the list.
*/
nextPageToken?: string | null;
/**
* Total number of devices matching request.
*/
totalSize?: number | null;
}
/**
* Describes an installed app.
*/
export interface Schema$GoogleChromeManagementV1InstalledApp {
/**
* Output only. Unique identifier of the app. For Chrome apps and extensions, the 32-character id (e.g. ehoadneljpdggcbbknedodolkkjodefl). For Android apps, the package name (e.g. com.evernote).
*/
appId?: string | null;
/**
* Output only. How the app was installed.
*/
appInstallType?: string | null;
/**
* Output only. Source of the installed app.
*/
appSource?: string | null;
/**
* Output only. Type of the app.
*/
appType?: string | null;
/**
* Output only. Count of browser devices with this app installed.
*/
browserDeviceCount?: string | null;
/**
* Output only. Description of the installed app.
*/
description?: string | null;
/**
* Output only. Whether the app is disabled.
*/
disabled?: boolean | null;
/**
* Output only. Name of the installed app.
*/
displayName?: string | null;
/**
* Output only. Homepage uri of the installed app.
*/
homepageUri?: string | null;
/**
* Output only. Count of ChromeOS users with this app installed.
*/
osUserCount?: string | null;
/**
* Output only. Permissions of the installed app.
*/
permissions?: string[] | null;
}
export class Resource$Customers {
context: APIRequestContext;
reports: Resource$Customers$Reports;
constructor(context: APIRequestContext);
}
export class Resource$Customers$Reports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Generate report of installed Chrome versions.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const chromemanagement = google.chromemanagement('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/chrome.management.reports.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 chromemanagement.customers.reports.countChromeVersions({
* // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
* customer: 'customers/my-customer',
* // Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date
* filter: 'placeholder-value',
* // The ID of the organizational unit.
* orgUnitId: 'placeholder-value',
* // Maximum number of results to return. Maximum and default are 100.
* pageSize: 'placeholder-value',
* // Token to specify the next page in the list.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "browserVersions": [],
* // "nextPageToken": "my_nextPageToken",
* // "totalSize": 0
* // }
* }
*
* 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.
*/
countChromeVersions(params: Params$Resource$Customers$Reports$Countchromeversions, options: StreamMethodOptions): GaxiosPromise<Readable>;
countChromeVersions(params?: Params$Resource$Customers$Reports$Countchromeversions, options?: MethodOptions): GaxiosPromise<Schema$GoogleChromeManagementV1CountChromeVersionsResponse>;
countChromeVersions(params: Params$Resource$Customers$Reports$Countchromeversions, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
countChromeVersions(params: Params$Resource$Customers$Reports$Countchromeversions, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1CountChromeVersionsResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1CountChromeVersionsResponse>): void;
countChromeVersions(params: Params$Resource$Customers$Reports$Countchromeversions, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1CountChromeVersionsResponse>): void;
countChromeVersions(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1CountChromeVersionsResponse>): void;
/**
* Generate report of app installations.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const chromemanagement = google.chromemanagement('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/chrome.management.reports.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 chromemanagement.customers.reports.countInstalledApps({
* // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
* customer: 'customers/my-customer',
* // Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name
* filter: 'placeholder-value',
* // Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count
* orderBy: 'placeholder-value',
* // The ID of the organizational unit.
* orgUnitId: 'placeholder-value',
* // Maximum number of results to return. Maximum and default are 100.
* pageSize: 'placeholder-value',
* // Token to specify next page in the list.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "installedApps": [],
* // "nextPageToken": "my_nextPageToken",
* // "totalSize": 0
* // }
* }
*
* 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.
*/
countInstalledApps(params: Params$Resource$Customers$Reports$Countinstalledapps, options: StreamMethodOptions): GaxiosPromise<Readable>;
countInstalledApps(params?: Params$Resource$Customers$Reports$Countinstalledapps, options?: MethodOptions): GaxiosPromise<Schema$GoogleChromeManagementV1CountInstalledAppsResponse>;
countInstalledApps(params: Params$Resource$Customers$Reports$Countinstalledapps, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
countInstalledApps(params: Params$Resource$Customers$Reports$Countinstalledapps, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1CountInstalledAppsResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1CountInstalledAppsResponse>): void;
countInstalledApps(params: Params$Resource$Customers$Reports$Countinstalledapps, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1CountInstalledAppsResponse>): void;
countInstalledApps(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1CountInstalledAppsResponse>): void;
/**
* Generate report of devices that have a specified app installed.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const chromemanagement = google.chromemanagement('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/chrome.management.reports.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 chromemanagement.customers.reports.findInstalledAppDevices({
* // Unique identifier of the app. For Chrome apps and extensions, the 32-character id (e.g. ehoadneljpdggcbbknedodolkkjodefl). For Android apps, the package name (e.g. com.evernote).
* appId: 'placeholder-value',
* // Type of the app.
* appType: 'placeholder-value',
* // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
* customer: 'customers/my-customer',
* // Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date
* filter: 'placeholder-value',
* // Field used to order results. Supported order by fields: * machine * device_id
* orderBy: 'placeholder-value',
* // The ID of the organizational unit.
* orgUnitId: 'placeholder-value',
* // Maximum number of results to return. Maximum and default are 100.
* pageSize: 'placeholder-value',
* // Token to specify the next page in the list.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "devices": [],
* // "nextPageToken": "my_nextPageToken",
* // "totalSize": 0
* // }
* }
*
* 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.
*/
findInstalledAppDevices(params: Params$Resource$Customers$Reports$Findinstalledappdevices, options: StreamMethodOptions): GaxiosPromise<Readable>;
findInstalledAppDevices(params?: Params$Resource$Customers$Reports$Findinstalledappdevices, options?: MethodOptions): GaxiosPromise<Schema$GoogleChromeManagementV1FindInstalledAppDevicesResponse>;
findInstalledAppDevices(params: Params$Resource$Customers$Reports$Findinstalledappdevices, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
findInstalledAppDevices(params: Params$Resource$Customers$Reports$Findinstalledappdevices, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1FindInstalledAppDevicesResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindInstalledAppDevicesResponse>): void;
findInstalledAppDevices(params: Params$Resource$Customers$Reports$Findinstalledappdevices, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindInstalledAppDevicesResponse>): void;
findInstalledAppDevices(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindInstalledAppDevicesResponse>): void;
}
export interface Params$Resource$Customers$Reports$Countchromeversions extends StandardParameters {
/**
* Required. Customer id or "my_customer" to use the customer associated to the account making the request.
*/
customer?: string;
/**
* Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date
*/
filter?: string;
/**
* The ID of the organizational unit.
*/
orgUnitId?: string;
/**
* Maximum number of results to return. Maximum and default are 100.
*/
pageSize?: number;
/**
* Token to specify the next page in the list.
*/
pageToken?: string;
}
export interface Params$Resource$Customers$Reports$Countinstalledapps extends StandardParameters {
/**
* Required. Customer id or "my_customer" to use the customer associated to the account making the request.
*/
customer?: string;
/**
* Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name
*/
filter?: string;
/**
* Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count
*/
orderBy?: string;
/**
* The ID of the organizational unit.
*/
orgUnitId?: string;
/**
* Maximum number of results to return. Maximum and default are 100.
*/
pageSize?: number;
/**
* Token to specify next page in the list.
*/
pageToken?: string;
}
export interface Params$Resource$Customers$Reports$Findinstalledappdevices extends StandardParameters {
/**
* Unique identifier of the app. For Chrome apps and extensions, the 32-character id (e.g. ehoadneljpdggcbbknedodolkkjodefl). For Android apps, the package name (e.g. com.evernote).
*/
appId?: string;
/**
* Type of the app.
*/
appType?: string;
/**
* Required. Customer id or "my_customer" to use the customer associated to the account making the request.
*/
customer?: string;
/**
* Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date
*/
filter?: string;
/**
* Field used to order results. Supported order by fields: * machine * device_id
*/
orderBy?: string;
/**
* The ID of the organizational unit.
*/
orgUnitId?: string;
/**
* Maximum number of results to return. Maximum and default are 100.
*/
pageSize?: number;
/**
* Token to specify the next page in the list.
*/
pageToken?: string;
}
export {};
}
//# sourceMappingURL=v1.d.ts.map