@googleapis/chromemanagement 27.0.0 → 30.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +87 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +485 -0
- package/build/v1.js +96 -0
- package/build/v1.js.map +1 -1
- package/package.json +3 -3
- package/v1.ts +762 -15
package/build/v1.d.ts
CHANGED
|
@@ -1125,6 +1125,57 @@ export declare namespace chromemanagement_v1 {
|
|
|
1125
1125
|
*/
|
|
1126
1126
|
totalSize?: number | null;
|
|
1127
1127
|
}
|
|
1128
|
+
/**
|
|
1129
|
+
* Response to `FindSaasUsageBrowsers` method.
|
|
1130
|
+
*/
|
|
1131
|
+
export interface Schema$GoogleChromeManagementV1FindSaasUsageBrowsersResponse {
|
|
1132
|
+
/**
|
|
1133
|
+
* A token, which can be sent as `page_token` to retrieve the next page.
|
|
1134
|
+
*/
|
|
1135
|
+
nextPageToken?: string | null;
|
|
1136
|
+
/**
|
|
1137
|
+
* The list of SaaS usage browser reports.
|
|
1138
|
+
*/
|
|
1139
|
+
saasUsageBrowsers?: Schema$GoogleChromeManagementV1SaasUsageBrowser[];
|
|
1140
|
+
/**
|
|
1141
|
+
* Total number of SaaS usage browser reports that match the request.
|
|
1142
|
+
*/
|
|
1143
|
+
totalSize?: string | null;
|
|
1144
|
+
}
|
|
1145
|
+
/**
|
|
1146
|
+
* Response to `FindSaasUsageProfiles` method.
|
|
1147
|
+
*/
|
|
1148
|
+
export interface Schema$GoogleChromeManagementV1FindSaasUsageProfilesResponse {
|
|
1149
|
+
/**
|
|
1150
|
+
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
1151
|
+
*/
|
|
1152
|
+
nextPageToken?: string | null;
|
|
1153
|
+
/**
|
|
1154
|
+
* The list of SaaS usage profile reports.
|
|
1155
|
+
*/
|
|
1156
|
+
profileReports?: Schema$GoogleChromeManagementV1SaasUsageProfileReport[];
|
|
1157
|
+
/**
|
|
1158
|
+
* Total number of SaaS usage profile reports that match the request.
|
|
1159
|
+
*/
|
|
1160
|
+
totalSize?: string | null;
|
|
1161
|
+
}
|
|
1162
|
+
/**
|
|
1163
|
+
* Response to `FindSaasUsage` method.
|
|
1164
|
+
*/
|
|
1165
|
+
export interface Schema$GoogleChromeManagementV1FindSaasUsageReportsResponse {
|
|
1166
|
+
/**
|
|
1167
|
+
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
1168
|
+
*/
|
|
1169
|
+
nextPageToken?: string | null;
|
|
1170
|
+
/**
|
|
1171
|
+
* The list of SaaS usage reports.
|
|
1172
|
+
*/
|
|
1173
|
+
saasReports?: Schema$GoogleChromeManagementV1SaasUsageReport[];
|
|
1174
|
+
/**
|
|
1175
|
+
* Total number of SaaS usage reports that match the request.
|
|
1176
|
+
*/
|
|
1177
|
+
totalSize?: string | null;
|
|
1178
|
+
}
|
|
1128
1179
|
/**
|
|
1129
1180
|
* Information of a graphics adapter (GPU).
|
|
1130
1181
|
*/
|
|
@@ -1725,6 +1776,146 @@ export declare namespace chromemanagement_v1 {
|
|
|
1725
1776
|
*/
|
|
1726
1777
|
uptimeRuntimeDuration?: string | null;
|
|
1727
1778
|
}
|
|
1779
|
+
/**
|
|
1780
|
+
* Details of a SaaS usage browser.
|
|
1781
|
+
*/
|
|
1782
|
+
export interface Schema$GoogleChromeManagementV1SaasUsageBrowser {
|
|
1783
|
+
/**
|
|
1784
|
+
* Output only. The device permanent ID.
|
|
1785
|
+
*/
|
|
1786
|
+
devicePermanentId?: string | null;
|
|
1787
|
+
/**
|
|
1788
|
+
* Output only. The timestamp when the application was first navigated to by this browser.
|
|
1789
|
+
*/
|
|
1790
|
+
firstNavigationTime?: string | null;
|
|
1791
|
+
/**
|
|
1792
|
+
* Output only. The timestamp when the application was last navigated to by this browser.
|
|
1793
|
+
*/
|
|
1794
|
+
lastNavigationTime?: string | null;
|
|
1795
|
+
/**
|
|
1796
|
+
* Output only. The machine name.
|
|
1797
|
+
*/
|
|
1798
|
+
machine?: string | null;
|
|
1799
|
+
/**
|
|
1800
|
+
* Output only. The ID of the organizational unit.
|
|
1801
|
+
*/
|
|
1802
|
+
orgUnitId?: string | null;
|
|
1803
|
+
/**
|
|
1804
|
+
* Output only. The OS platform.
|
|
1805
|
+
*/
|
|
1806
|
+
osPlatform?: string | null;
|
|
1807
|
+
/**
|
|
1808
|
+
* Output only. The OS version.
|
|
1809
|
+
*/
|
|
1810
|
+
osVersion?: string | null;
|
|
1811
|
+
}
|
|
1812
|
+
/**
|
|
1813
|
+
* Represents a single SaaS report entry grouped by profile.
|
|
1814
|
+
*/
|
|
1815
|
+
export interface Schema$GoogleChromeManagementV1SaasUsageProfileReport {
|
|
1816
|
+
/**
|
|
1817
|
+
* Output only. The email of the user.
|
|
1818
|
+
*/
|
|
1819
|
+
email?: string | null;
|
|
1820
|
+
/**
|
|
1821
|
+
* Output only. The timestamp when the application was first navigated to by this profile.
|
|
1822
|
+
*/
|
|
1823
|
+
firstNavigationTime?: string | null;
|
|
1824
|
+
/**
|
|
1825
|
+
* Output only. The timestamp when the application was last navigated to by this profile.
|
|
1826
|
+
*/
|
|
1827
|
+
lastNavigationTime?: string | null;
|
|
1828
|
+
/**
|
|
1829
|
+
* Output only. The ID of the organizational unit.
|
|
1830
|
+
*/
|
|
1831
|
+
orgUnitId?: string | null;
|
|
1832
|
+
/**
|
|
1833
|
+
* Output only. The OS platform.
|
|
1834
|
+
*/
|
|
1835
|
+
osPlatform?: string | null;
|
|
1836
|
+
/**
|
|
1837
|
+
* Output only. The OS version.
|
|
1838
|
+
*/
|
|
1839
|
+
osVersion?: string | null;
|
|
1840
|
+
/**
|
|
1841
|
+
* Output only. The permanent ID of the profile.
|
|
1842
|
+
*/
|
|
1843
|
+
profilePermanentId?: string | null;
|
|
1844
|
+
}
|
|
1845
|
+
/**
|
|
1846
|
+
* Represents a single SaaS report entry.
|
|
1847
|
+
*/
|
|
1848
|
+
export interface Schema$GoogleChromeManagementV1SaasUsageReport {
|
|
1849
|
+
/**
|
|
1850
|
+
* Output only. The name of the application.
|
|
1851
|
+
*/
|
|
1852
|
+
app?: string | null;
|
|
1853
|
+
/**
|
|
1854
|
+
* Output only. The category of the application.
|
|
1855
|
+
*/
|
|
1856
|
+
category?: string | null;
|
|
1857
|
+
/**
|
|
1858
|
+
* Output only. Provides information about content transfer events, if available.
|
|
1859
|
+
*/
|
|
1860
|
+
contentTransferDetails?: Schema$GoogleChromeManagementV1SaasUsageReportContentTransferDetails;
|
|
1861
|
+
/**
|
|
1862
|
+
* Output only. Number of distinct browsers that visited the application.
|
|
1863
|
+
*/
|
|
1864
|
+
distinctBrowsersCount?: string | null;
|
|
1865
|
+
/**
|
|
1866
|
+
* Output only. Number of distinct users who visited the application.
|
|
1867
|
+
*/
|
|
1868
|
+
distinctUsersCount?: string | null;
|
|
1869
|
+
/**
|
|
1870
|
+
* Output only. A list of domains and subdomains associated with the application.
|
|
1871
|
+
*/
|
|
1872
|
+
domains?: string[] | null;
|
|
1873
|
+
/**
|
|
1874
|
+
* Output only. A list of encryption protocols used to access the application.
|
|
1875
|
+
*/
|
|
1876
|
+
encryptionProtocols?: string[] | null;
|
|
1877
|
+
/**
|
|
1878
|
+
* Output only. The timestamp when the application was first navigated to.
|
|
1879
|
+
*/
|
|
1880
|
+
firstNavigationTime?: string | null;
|
|
1881
|
+
/**
|
|
1882
|
+
* Output only. The year the organization was founded.
|
|
1883
|
+
*/
|
|
1884
|
+
foundedYear?: number | null;
|
|
1885
|
+
/**
|
|
1886
|
+
* Output only. The headquarters location of the organization.
|
|
1887
|
+
*/
|
|
1888
|
+
headquarters?: string | null;
|
|
1889
|
+
/**
|
|
1890
|
+
* Output only. The timestamp when the application was last navigated to.
|
|
1891
|
+
*/
|
|
1892
|
+
lastNavigationTime?: string | null;
|
|
1893
|
+
/**
|
|
1894
|
+
* Output only. The organization that develops the application.
|
|
1895
|
+
*/
|
|
1896
|
+
organization?: string | null;
|
|
1897
|
+
/**
|
|
1898
|
+
* Output only. The ID of the organizational unit.
|
|
1899
|
+
*/
|
|
1900
|
+
orgUnitId?: string | null;
|
|
1901
|
+
/**
|
|
1902
|
+
* Output only. The primary domain of the application.
|
|
1903
|
+
*/
|
|
1904
|
+
primaryDomain?: string | null;
|
|
1905
|
+
/**
|
|
1906
|
+
* Output only. Total number of visits to the application.
|
|
1907
|
+
*/
|
|
1908
|
+
visitsCount?: string | null;
|
|
1909
|
+
}
|
|
1910
|
+
/**
|
|
1911
|
+
* Provides information about content transfer events, if available.
|
|
1912
|
+
*/
|
|
1913
|
+
export interface Schema$GoogleChromeManagementV1SaasUsageReportContentTransferDetails {
|
|
1914
|
+
/**
|
|
1915
|
+
* Output only. Total number of content transfers associated with the application.
|
|
1916
|
+
*/
|
|
1917
|
+
contentTransferCount?: string | null;
|
|
1918
|
+
}
|
|
1728
1919
|
/**
|
|
1729
1920
|
* Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceStorageStatus](https://chromeenterprise.google/policies/#ReportDeviceStorageStatus) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_STORAGE_INFO
|
|
1730
1921
|
*/
|
|
@@ -7343,6 +7534,226 @@ export declare namespace chromemanagement_v1 {
|
|
|
7343
7534
|
findInstalledAppProfiles(params: Params$Resource$Customers$Reports$Findinstalledappprofiles, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1FindInstalledAppProfilesResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindInstalledAppProfilesResponse>): void;
|
|
7344
7535
|
findInstalledAppProfiles(params: Params$Resource$Customers$Reports$Findinstalledappprofiles, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindInstalledAppProfilesResponse>): void;
|
|
7345
7536
|
findInstalledAppProfiles(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindInstalledAppProfilesResponse>): void;
|
|
7537
|
+
/**
|
|
7538
|
+
* Find SaaS usage reports of a customer based on the given search and sorting criteria.
|
|
7539
|
+
* @example
|
|
7540
|
+
* ```js
|
|
7541
|
+
* // Before running the sample:
|
|
7542
|
+
* // - Enable the API at:
|
|
7543
|
+
* // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
|
|
7544
|
+
* // - Login into gcloud by running:
|
|
7545
|
+
* // ```sh
|
|
7546
|
+
* // $ gcloud auth application-default login
|
|
7547
|
+
* // ```
|
|
7548
|
+
* // - Install the npm module by running:
|
|
7549
|
+
* // ```sh
|
|
7550
|
+
* // $ npm install googleapis
|
|
7551
|
+
* // ```
|
|
7552
|
+
*
|
|
7553
|
+
* const {google} = require('googleapis');
|
|
7554
|
+
* const chromemanagement = google.chromemanagement('v1');
|
|
7555
|
+
*
|
|
7556
|
+
* async function main() {
|
|
7557
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7558
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7559
|
+
* scopes: [
|
|
7560
|
+
* 'https://www.googleapis.com/auth/chrome.management.reports.readonly',
|
|
7561
|
+
* ],
|
|
7562
|
+
* });
|
|
7563
|
+
*
|
|
7564
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7565
|
+
* const authClient = await auth.getClient();
|
|
7566
|
+
* google.options({auth: authClient});
|
|
7567
|
+
*
|
|
7568
|
+
* // Do the magic
|
|
7569
|
+
* const res = await chromemanagement.customers.reports.findSaasUsage({
|
|
7570
|
+
* // Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer".
|
|
7571
|
+
* customer: 'customers/my-customer',
|
|
7572
|
+
* // Optional. The filter expression to narrow down the SaaS reports to return. Supported operators are: =, !=, <, <=, \>, \>=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * app * org_unit_id * first_navigation_time * last_navigation_time * category * organization * founded_year * headquarters * primary_domain * domains * encryption_protocols * visits_count * distinct_users_count * distinct_browsers_count * content_transfer_count Example: `(first_navigation_time < "2026-01-31T00:00:00Z" AND last_navigation_time \> "2026-01-01T00:00:00Z") AND visits_count \> 100`
|
|
7573
|
+
* filter: 'placeholder-value',
|
|
7574
|
+
* // Optional. The order by expression to sort the SaaS reports. Supported fields: * app * category * organization * founded_year * headquarters * primary_domain * visits_count * distinct_users_count * distinct_browsers_count * content_transfer_count Default order is ascending. To specify descending order for a field, append " desc". Example: `visits_count desc`
|
|
7575
|
+
* orderBy: 'placeholder-value',
|
|
7576
|
+
* // Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 100 reports will be returned. The maximum value is 200; values above 200 will be coerced to 200.
|
|
7577
|
+
* pageSize: 'placeholder-value',
|
|
7578
|
+
* // Optional. A page token, received from a previous `FindSaasUsageReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FindSaasUsageReports` must match the call that provided the page token.
|
|
7579
|
+
* pageToken: 'placeholder-value',
|
|
7580
|
+
* });
|
|
7581
|
+
* console.log(res.data);
|
|
7582
|
+
*
|
|
7583
|
+
* // Example response
|
|
7584
|
+
* // {
|
|
7585
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
7586
|
+
* // "saasReports": [],
|
|
7587
|
+
* // "totalSize": "my_totalSize"
|
|
7588
|
+
* // }
|
|
7589
|
+
* }
|
|
7590
|
+
*
|
|
7591
|
+
* main().catch(e => {
|
|
7592
|
+
* console.error(e);
|
|
7593
|
+
* throw e;
|
|
7594
|
+
* });
|
|
7595
|
+
*
|
|
7596
|
+
* ```
|
|
7597
|
+
*
|
|
7598
|
+
* @param params - Parameters for request
|
|
7599
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7600
|
+
* @param callback - Optional callback that handles the response.
|
|
7601
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7602
|
+
*/
|
|
7603
|
+
findSaasUsage(params: Params$Resource$Customers$Reports$Findsaasusage, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
7604
|
+
findSaasUsage(params?: Params$Resource$Customers$Reports$Findsaasusage, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleChromeManagementV1FindSaasUsageReportsResponse>>;
|
|
7605
|
+
findSaasUsage(params: Params$Resource$Customers$Reports$Findsaasusage, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7606
|
+
findSaasUsage(params: Params$Resource$Customers$Reports$Findsaasusage, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageReportsResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageReportsResponse>): void;
|
|
7607
|
+
findSaasUsage(params: Params$Resource$Customers$Reports$Findsaasusage, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageReportsResponse>): void;
|
|
7608
|
+
findSaasUsage(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageReportsResponse>): void;
|
|
7609
|
+
/**
|
|
7610
|
+
* Find SaaS usage reports of a customer grouped by browsers based on the given search and sorting criteria.
|
|
7611
|
+
* @example
|
|
7612
|
+
* ```js
|
|
7613
|
+
* // Before running the sample:
|
|
7614
|
+
* // - Enable the API at:
|
|
7615
|
+
* // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
|
|
7616
|
+
* // - Login into gcloud by running:
|
|
7617
|
+
* // ```sh
|
|
7618
|
+
* // $ gcloud auth application-default login
|
|
7619
|
+
* // ```
|
|
7620
|
+
* // - Install the npm module by running:
|
|
7621
|
+
* // ```sh
|
|
7622
|
+
* // $ npm install googleapis
|
|
7623
|
+
* // ```
|
|
7624
|
+
*
|
|
7625
|
+
* const {google} = require('googleapis');
|
|
7626
|
+
* const chromemanagement = google.chromemanagement('v1');
|
|
7627
|
+
*
|
|
7628
|
+
* async function main() {
|
|
7629
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7630
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7631
|
+
* scopes: [
|
|
7632
|
+
* 'https://www.googleapis.com/auth/chrome.management.reports.readonly',
|
|
7633
|
+
* ],
|
|
7634
|
+
* });
|
|
7635
|
+
*
|
|
7636
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7637
|
+
* const authClient = await auth.getClient();
|
|
7638
|
+
* google.options({auth: authClient});
|
|
7639
|
+
*
|
|
7640
|
+
* // Do the magic
|
|
7641
|
+
* const res = await chromemanagement.customers.reports.findSaasUsageBrowsers({
|
|
7642
|
+
* // Required. The name of the SaaS application (e.g., `ChatGPT`, `Gemini`).
|
|
7643
|
+
* app: 'placeholder-value',
|
|
7644
|
+
* // Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer".
|
|
7645
|
+
* customer: 'customers/my-customer',
|
|
7646
|
+
* // Optional. The filter expression to narrow down the SaaS browser reports to return. Supported operators are: =, !=, <, <=, \>, \>=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * machine * os_platform * first_navigation_time * last_navigation_time * org_unit_id
|
|
7647
|
+
* filter: 'placeholder-value',
|
|
7648
|
+
* // Optional. The order by expression to sort the SaaS browser reports. Supported fields: * machine * os_platform * first_navigation_time * last_navigation_time Default order is ascending. To specify descending order for a field, append " desc".
|
|
7649
|
+
* orderBy: 'placeholder-value',
|
|
7650
|
+
* // Optional. The maximum number of browsers to return. The service may return fewer than this value. If unspecified, at most 100 browsers will be returned. The maximum value is 200; values above 200 will be coerced to 200.
|
|
7651
|
+
* pageSize: 'placeholder-value',
|
|
7652
|
+
* // Optional. A page token, received from a previous `FindSaasUsageBrowsers` call. Provide this to retrieve the subsequent page.
|
|
7653
|
+
* pageToken: 'placeholder-value',
|
|
7654
|
+
* });
|
|
7655
|
+
* console.log(res.data);
|
|
7656
|
+
*
|
|
7657
|
+
* // Example response
|
|
7658
|
+
* // {
|
|
7659
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
7660
|
+
* // "saasUsageBrowsers": [],
|
|
7661
|
+
* // "totalSize": "my_totalSize"
|
|
7662
|
+
* // }
|
|
7663
|
+
* }
|
|
7664
|
+
*
|
|
7665
|
+
* main().catch(e => {
|
|
7666
|
+
* console.error(e);
|
|
7667
|
+
* throw e;
|
|
7668
|
+
* });
|
|
7669
|
+
*
|
|
7670
|
+
* ```
|
|
7671
|
+
*
|
|
7672
|
+
* @param params - Parameters for request
|
|
7673
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7674
|
+
* @param callback - Optional callback that handles the response.
|
|
7675
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7676
|
+
*/
|
|
7677
|
+
findSaasUsageBrowsers(params: Params$Resource$Customers$Reports$Findsaasusagebrowsers, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
7678
|
+
findSaasUsageBrowsers(params?: Params$Resource$Customers$Reports$Findsaasusagebrowsers, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleChromeManagementV1FindSaasUsageBrowsersResponse>>;
|
|
7679
|
+
findSaasUsageBrowsers(params: Params$Resource$Customers$Reports$Findsaasusagebrowsers, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7680
|
+
findSaasUsageBrowsers(params: Params$Resource$Customers$Reports$Findsaasusagebrowsers, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageBrowsersResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageBrowsersResponse>): void;
|
|
7681
|
+
findSaasUsageBrowsers(params: Params$Resource$Customers$Reports$Findsaasusagebrowsers, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageBrowsersResponse>): void;
|
|
7682
|
+
findSaasUsageBrowsers(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageBrowsersResponse>): void;
|
|
7683
|
+
/**
|
|
7684
|
+
* Find SaaS usage reports of a customer grouped by profiles based on the given search and sorting criteria.
|
|
7685
|
+
* @example
|
|
7686
|
+
* ```js
|
|
7687
|
+
* // Before running the sample:
|
|
7688
|
+
* // - Enable the API at:
|
|
7689
|
+
* // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
|
|
7690
|
+
* // - Login into gcloud by running:
|
|
7691
|
+
* // ```sh
|
|
7692
|
+
* // $ gcloud auth application-default login
|
|
7693
|
+
* // ```
|
|
7694
|
+
* // - Install the npm module by running:
|
|
7695
|
+
* // ```sh
|
|
7696
|
+
* // $ npm install googleapis
|
|
7697
|
+
* // ```
|
|
7698
|
+
*
|
|
7699
|
+
* const {google} = require('googleapis');
|
|
7700
|
+
* const chromemanagement = google.chromemanagement('v1');
|
|
7701
|
+
*
|
|
7702
|
+
* async function main() {
|
|
7703
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7704
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7705
|
+
* scopes: [
|
|
7706
|
+
* 'https://www.googleapis.com/auth/chrome.management.reports.readonly',
|
|
7707
|
+
* ],
|
|
7708
|
+
* });
|
|
7709
|
+
*
|
|
7710
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7711
|
+
* const authClient = await auth.getClient();
|
|
7712
|
+
* google.options({auth: authClient});
|
|
7713
|
+
*
|
|
7714
|
+
* // Do the magic
|
|
7715
|
+
* const res = await chromemanagement.customers.reports.findSaasUsageProfiles({
|
|
7716
|
+
* // Required. The name of the SaaS application (e.g., `ChatGPT`, `Gemini`).
|
|
7717
|
+
* app: 'placeholder-value',
|
|
7718
|
+
* // Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer".
|
|
7719
|
+
* customer: 'customers/my-customer',
|
|
7720
|
+
* // Optional. The filter expression to narrow down the SaaS profile reports to return. Supported operators are: =, !=, <, <=, \>, \>=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * email * org_unit_id * os_platform * first_navigation_time * last_navigation_time
|
|
7721
|
+
* filter: 'placeholder-value',
|
|
7722
|
+
* // Optional. The order by expression to sort the SaaS profile reports. Supported fields: * email * os_platform * first_navigation_time * last_navigation_time Default order is ascending. To specify descending order for a field, append " desc".
|
|
7723
|
+
* orderBy: 'placeholder-value',
|
|
7724
|
+
* // Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 100 reports will be returned. The maximum value is 200; values above 200 will be coerced to 200.
|
|
7725
|
+
* pageSize: 'placeholder-value',
|
|
7726
|
+
* // Optional. A page token, received from a previous `FindSaasUsageProfiles` call. Provide this to retrieve the subsequent page.
|
|
7727
|
+
* pageToken: 'placeholder-value',
|
|
7728
|
+
* });
|
|
7729
|
+
* console.log(res.data);
|
|
7730
|
+
*
|
|
7731
|
+
* // Example response
|
|
7732
|
+
* // {
|
|
7733
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
7734
|
+
* // "profileReports": [],
|
|
7735
|
+
* // "totalSize": "my_totalSize"
|
|
7736
|
+
* // }
|
|
7737
|
+
* }
|
|
7738
|
+
*
|
|
7739
|
+
* main().catch(e => {
|
|
7740
|
+
* console.error(e);
|
|
7741
|
+
* throw e;
|
|
7742
|
+
* });
|
|
7743
|
+
*
|
|
7744
|
+
* ```
|
|
7745
|
+
*
|
|
7746
|
+
* @param params - Parameters for request
|
|
7747
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7748
|
+
* @param callback - Optional callback that handles the response.
|
|
7749
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7750
|
+
*/
|
|
7751
|
+
findSaasUsageProfiles(params: Params$Resource$Customers$Reports$Findsaasusageprofiles, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
7752
|
+
findSaasUsageProfiles(params?: Params$Resource$Customers$Reports$Findsaasusageprofiles, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleChromeManagementV1FindSaasUsageProfilesResponse>>;
|
|
7753
|
+
findSaasUsageProfiles(params: Params$Resource$Customers$Reports$Findsaasusageprofiles, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7754
|
+
findSaasUsageProfiles(params: Params$Resource$Customers$Reports$Findsaasusageprofiles, options: MethodOptions | BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageProfilesResponse>, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageProfilesResponse>): void;
|
|
7755
|
+
findSaasUsageProfiles(params: Params$Resource$Customers$Reports$Findsaasusageprofiles, callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageProfilesResponse>): void;
|
|
7756
|
+
findSaasUsageProfiles(callback: BodyResponseCallback<Schema$GoogleChromeManagementV1FindSaasUsageProfilesResponse>): void;
|
|
7346
7757
|
}
|
|
7347
7758
|
export interface Params$Resource$Customers$Reports$Countactivedevices extends StandardParameters {
|
|
7348
7759
|
/**
|
|
@@ -7688,6 +8099,80 @@ export declare namespace chromemanagement_v1 {
|
|
|
7688
8099
|
*/
|
|
7689
8100
|
pageToken?: string;
|
|
7690
8101
|
}
|
|
8102
|
+
export interface Params$Resource$Customers$Reports$Findsaasusage extends StandardParameters {
|
|
8103
|
+
/**
|
|
8104
|
+
* Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer".
|
|
8105
|
+
*/
|
|
8106
|
+
customer?: string;
|
|
8107
|
+
/**
|
|
8108
|
+
* Optional. The filter expression to narrow down the SaaS reports to return. Supported operators are: =, !=, <, <=, \>, \>=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * app * org_unit_id * first_navigation_time * last_navigation_time * category * organization * founded_year * headquarters * primary_domain * domains * encryption_protocols * visits_count * distinct_users_count * distinct_browsers_count * content_transfer_count Example: `(first_navigation_time < "2026-01-31T00:00:00Z" AND last_navigation_time \> "2026-01-01T00:00:00Z") AND visits_count \> 100`
|
|
8109
|
+
*/
|
|
8110
|
+
filter?: string;
|
|
8111
|
+
/**
|
|
8112
|
+
* Optional. The order by expression to sort the SaaS reports. Supported fields: * app * category * organization * founded_year * headquarters * primary_domain * visits_count * distinct_users_count * distinct_browsers_count * content_transfer_count Default order is ascending. To specify descending order for a field, append " desc". Example: `visits_count desc`
|
|
8113
|
+
*/
|
|
8114
|
+
orderBy?: string;
|
|
8115
|
+
/**
|
|
8116
|
+
* Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 100 reports will be returned. The maximum value is 200; values above 200 will be coerced to 200.
|
|
8117
|
+
*/
|
|
8118
|
+
pageSize?: number;
|
|
8119
|
+
/**
|
|
8120
|
+
* Optional. A page token, received from a previous `FindSaasUsageReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FindSaasUsageReports` must match the call that provided the page token.
|
|
8121
|
+
*/
|
|
8122
|
+
pageToken?: string;
|
|
8123
|
+
}
|
|
8124
|
+
export interface Params$Resource$Customers$Reports$Findsaasusagebrowsers extends StandardParameters {
|
|
8125
|
+
/**
|
|
8126
|
+
* Required. The name of the SaaS application (e.g., `ChatGPT`, `Gemini`).
|
|
8127
|
+
*/
|
|
8128
|
+
app?: string;
|
|
8129
|
+
/**
|
|
8130
|
+
* Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer".
|
|
8131
|
+
*/
|
|
8132
|
+
customer?: string;
|
|
8133
|
+
/**
|
|
8134
|
+
* Optional. The filter expression to narrow down the SaaS browser reports to return. Supported operators are: =, !=, <, <=, \>, \>=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * machine * os_platform * first_navigation_time * last_navigation_time * org_unit_id
|
|
8135
|
+
*/
|
|
8136
|
+
filter?: string;
|
|
8137
|
+
/**
|
|
8138
|
+
* Optional. The order by expression to sort the SaaS browser reports. Supported fields: * machine * os_platform * first_navigation_time * last_navigation_time Default order is ascending. To specify descending order for a field, append " desc".
|
|
8139
|
+
*/
|
|
8140
|
+
orderBy?: string;
|
|
8141
|
+
/**
|
|
8142
|
+
* Optional. The maximum number of browsers to return. The service may return fewer than this value. If unspecified, at most 100 browsers will be returned. The maximum value is 200; values above 200 will be coerced to 200.
|
|
8143
|
+
*/
|
|
8144
|
+
pageSize?: number;
|
|
8145
|
+
/**
|
|
8146
|
+
* Optional. A page token, received from a previous `FindSaasUsageBrowsers` call. Provide this to retrieve the subsequent page.
|
|
8147
|
+
*/
|
|
8148
|
+
pageToken?: string;
|
|
8149
|
+
}
|
|
8150
|
+
export interface Params$Resource$Customers$Reports$Findsaasusageprofiles extends StandardParameters {
|
|
8151
|
+
/**
|
|
8152
|
+
* Required. The name of the SaaS application (e.g., `ChatGPT`, `Gemini`).
|
|
8153
|
+
*/
|
|
8154
|
+
app?: string;
|
|
8155
|
+
/**
|
|
8156
|
+
* Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer".
|
|
8157
|
+
*/
|
|
8158
|
+
customer?: string;
|
|
8159
|
+
/**
|
|
8160
|
+
* Optional. The filter expression to narrow down the SaaS profile reports to return. Supported operators are: =, !=, <, <=, \>, \>=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * email * org_unit_id * os_platform * first_navigation_time * last_navigation_time
|
|
8161
|
+
*/
|
|
8162
|
+
filter?: string;
|
|
8163
|
+
/**
|
|
8164
|
+
* Optional. The order by expression to sort the SaaS profile reports. Supported fields: * email * os_platform * first_navigation_time * last_navigation_time Default order is ascending. To specify descending order for a field, append " desc".
|
|
8165
|
+
*/
|
|
8166
|
+
orderBy?: string;
|
|
8167
|
+
/**
|
|
8168
|
+
* Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 100 reports will be returned. The maximum value is 200; values above 200 will be coerced to 200.
|
|
8169
|
+
*/
|
|
8170
|
+
pageSize?: number;
|
|
8171
|
+
/**
|
|
8172
|
+
* Optional. A page token, received from a previous `FindSaasUsageProfiles` call. Provide this to retrieve the subsequent page.
|
|
8173
|
+
*/
|
|
8174
|
+
pageToken?: string;
|
|
8175
|
+
}
|
|
7691
8176
|
export class Resource$Customers$Telemetry {
|
|
7692
8177
|
context: APIRequestContext;
|
|
7693
8178
|
devices: Resource$Customers$Telemetry$Devices;
|
package/build/v1.js
CHANGED
|
@@ -1673,6 +1673,102 @@ var chromemanagement_v1;
|
|
|
1673
1673
|
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1674
1674
|
}
|
|
1675
1675
|
}
|
|
1676
|
+
findSaasUsage(paramsOrCallback, optionsOrCallback, callback) {
|
|
1677
|
+
let params = (paramsOrCallback ||
|
|
1678
|
+
{});
|
|
1679
|
+
let options = (optionsOrCallback || {});
|
|
1680
|
+
if (typeof paramsOrCallback === 'function') {
|
|
1681
|
+
callback = paramsOrCallback;
|
|
1682
|
+
params = {};
|
|
1683
|
+
options = {};
|
|
1684
|
+
}
|
|
1685
|
+
if (typeof optionsOrCallback === 'function') {
|
|
1686
|
+
callback = optionsOrCallback;
|
|
1687
|
+
options = {};
|
|
1688
|
+
}
|
|
1689
|
+
const rootUrl = options.rootUrl || 'https://chromemanagement.googleapis.com/';
|
|
1690
|
+
const parameters = {
|
|
1691
|
+
options: Object.assign({
|
|
1692
|
+
url: (rootUrl + '/v1/{+customer}/reports:findSaasUsage').replace(/([^:]\/)\/+/g, '$1'),
|
|
1693
|
+
method: 'GET',
|
|
1694
|
+
apiVersion: '',
|
|
1695
|
+
}, options),
|
|
1696
|
+
params,
|
|
1697
|
+
requiredParams: ['customer'],
|
|
1698
|
+
pathParams: ['customer'],
|
|
1699
|
+
context: this.context,
|
|
1700
|
+
};
|
|
1701
|
+
if (callback) {
|
|
1702
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
1703
|
+
}
|
|
1704
|
+
else {
|
|
1705
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1706
|
+
}
|
|
1707
|
+
}
|
|
1708
|
+
findSaasUsageBrowsers(paramsOrCallback, optionsOrCallback, callback) {
|
|
1709
|
+
let params = (paramsOrCallback ||
|
|
1710
|
+
{});
|
|
1711
|
+
let options = (optionsOrCallback || {});
|
|
1712
|
+
if (typeof paramsOrCallback === 'function') {
|
|
1713
|
+
callback = paramsOrCallback;
|
|
1714
|
+
params = {};
|
|
1715
|
+
options = {};
|
|
1716
|
+
}
|
|
1717
|
+
if (typeof optionsOrCallback === 'function') {
|
|
1718
|
+
callback = optionsOrCallback;
|
|
1719
|
+
options = {};
|
|
1720
|
+
}
|
|
1721
|
+
const rootUrl = options.rootUrl || 'https://chromemanagement.googleapis.com/';
|
|
1722
|
+
const parameters = {
|
|
1723
|
+
options: Object.assign({
|
|
1724
|
+
url: (rootUrl + '/v1/{+customer}/reports:findSaasUsageBrowsers').replace(/([^:]\/)\/+/g, '$1'),
|
|
1725
|
+
method: 'GET',
|
|
1726
|
+
apiVersion: '',
|
|
1727
|
+
}, options),
|
|
1728
|
+
params,
|
|
1729
|
+
requiredParams: ['customer'],
|
|
1730
|
+
pathParams: ['customer'],
|
|
1731
|
+
context: this.context,
|
|
1732
|
+
};
|
|
1733
|
+
if (callback) {
|
|
1734
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
1735
|
+
}
|
|
1736
|
+
else {
|
|
1737
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1738
|
+
}
|
|
1739
|
+
}
|
|
1740
|
+
findSaasUsageProfiles(paramsOrCallback, optionsOrCallback, callback) {
|
|
1741
|
+
let params = (paramsOrCallback ||
|
|
1742
|
+
{});
|
|
1743
|
+
let options = (optionsOrCallback || {});
|
|
1744
|
+
if (typeof paramsOrCallback === 'function') {
|
|
1745
|
+
callback = paramsOrCallback;
|
|
1746
|
+
params = {};
|
|
1747
|
+
options = {};
|
|
1748
|
+
}
|
|
1749
|
+
if (typeof optionsOrCallback === 'function') {
|
|
1750
|
+
callback = optionsOrCallback;
|
|
1751
|
+
options = {};
|
|
1752
|
+
}
|
|
1753
|
+
const rootUrl = options.rootUrl || 'https://chromemanagement.googleapis.com/';
|
|
1754
|
+
const parameters = {
|
|
1755
|
+
options: Object.assign({
|
|
1756
|
+
url: (rootUrl + '/v1/{+customer}/reports:findSaasUsageProfiles').replace(/([^:]\/)\/+/g, '$1'),
|
|
1757
|
+
method: 'GET',
|
|
1758
|
+
apiVersion: '',
|
|
1759
|
+
}, options),
|
|
1760
|
+
params,
|
|
1761
|
+
requiredParams: ['customer'],
|
|
1762
|
+
pathParams: ['customer'],
|
|
1763
|
+
context: this.context,
|
|
1764
|
+
};
|
|
1765
|
+
if (callback) {
|
|
1766
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
1767
|
+
}
|
|
1768
|
+
else {
|
|
1769
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1770
|
+
}
|
|
1771
|
+
}
|
|
1676
1772
|
}
|
|
1677
1773
|
chromemanagement_v1.Resource$Customers$Reports = Resource$Customers$Reports;
|
|
1678
1774
|
class Resource$Customers$Telemetry {
|