Updating NPM dependencies
This commit is contained in:
Drew Heavner
GitHub
235
node_modules/googleapis/build/src/apis/analyticsreporting/v4.d.ts
generated
vendored
235
node_modules/googleapis/build/src/apis/analyticsreporting/v4.d.ts
generated
vendored
@@ -1,26 +1,15 @@
|
||||
/**
|
||||
* Copyright 2019 Google LLC
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
|
||||
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
|
||||
import { GaxiosPromise } from 'gaxios';
|
||||
/// <reference types="node" />
|
||||
import { OAuth2Client, JWT, Compute, UserRefreshClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
|
||||
import { Readable } from 'stream';
|
||||
export declare namespace analyticsreporting_v4 {
|
||||
export interface Options extends GlobalOptions {
|
||||
version: 'v4';
|
||||
}
|
||||
interface StandardParameters {
|
||||
/**
|
||||
* Auth client or API Key for the request
|
||||
*/
|
||||
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | GoogleAuth;
|
||||
/**
|
||||
* V1 error format.
|
||||
*/
|
||||
@@ -72,14 +61,10 @@ export declare namespace analyticsreporting_v4 {
|
||||
* Accesses Analytics report data.
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* const {google} = require('googleapis');
|
||||
* const analyticsreporting = google.analyticsreporting('v4');
|
||||
*
|
||||
* @namespace analyticsreporting
|
||||
* @type {Function}
|
||||
* @version v4
|
||||
* @variation v4
|
||||
* @param {object=} options Options for Analyticsreporting
|
||||
* ```
|
||||
*/
|
||||
export class Analyticsreporting {
|
||||
context: APIRequestContext;
|
||||
@@ -88,7 +73,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
||||
}
|
||||
/**
|
||||
* An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity's. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity.
|
||||
* An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity's. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity.
|
||||
*/
|
||||
export interface Schema$Activity {
|
||||
/**
|
||||
@@ -108,7 +93,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
campaign?: string | null;
|
||||
/**
|
||||
* The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
|
||||
* The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
|
||||
*/
|
||||
channelGrouping?: string | null;
|
||||
/**
|
||||
@@ -136,7 +121,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
keyword?: string | null;
|
||||
/**
|
||||
* The first page in users' sessions, or the landing page.
|
||||
* The first page in users' sessions, or the landing page.
|
||||
*/
|
||||
landingPagePath?: string | null;
|
||||
/**
|
||||
@@ -170,7 +155,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
type?: string | null;
|
||||
}
|
||||
/**
|
||||
* Defines a cohort group. For example: "cohortGroup": { "cohorts": [{ "name": "cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" } },{ "name": "cohort 2" "type": "FIRST_VISIT_DATE" "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" } }] }
|
||||
* Defines a cohort group. For example: "cohortGroup": { "cohorts": [{ "name": "cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" \} \},{ "name": "cohort 2" "type": "FIRST_VISIT_DATE" "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" \} \}] \}
|
||||
*/
|
||||
export interface Schema$CohortGroup {
|
||||
/**
|
||||
@@ -178,7 +163,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
cohorts?: Schema$Cohort[];
|
||||
/**
|
||||
* Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)
|
||||
* Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)
|
||||
*/
|
||||
lifetimeValue?: boolean | null;
|
||||
}
|
||||
@@ -235,11 +220,11 @@ export declare namespace analyticsreporting_v4 {
|
||||
values?: string[] | null;
|
||||
}
|
||||
/**
|
||||
* [Dimensions](https://support.google.com/analytics/answer/1033861) are attributes of your data. For example, the dimension `ga:city` indicates the city, for example, "Paris" or "New York", from which a session originates.
|
||||
* [Dimensions](https://support.google.com/analytics/answer/1033861) are attributes of your data. For example, the dimension `ga:city` indicates the city, for example, "Paris" or "New York", from which a session originates.
|
||||
*/
|
||||
export interface Schema$Dimension {
|
||||
/**
|
||||
* If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The "first" bucket includes all values less than the first boundary, the "last" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of "0, 1, 3, 4, 7", then we return the following buckets: - bucket #1: values < 0, dimension value "<0" - bucket #2: values in [0,1), dimension value "0" - bucket #3: values in [1,3), dimension value "1-2" - bucket #4: values in [3,4), dimension value "3" - bucket #5: values in [4,7), dimension value "4-6" - bucket #6: values >= 7, dimension value "7+" NOTE: If you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is: "<50", "1001+", "121-1000", "50-120" And the ascending `HISTOGRAM_BUCKET` order is: "<50", "50-120", "121-1000", "1001+" The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` for a histogram-mutated dimension.
|
||||
* If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The "first" bucket includes all values less than the first boundary, the "last" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of "0, 1, 3, 4, 7", then we return the following buckets: - bucket #1: values < 0, dimension value "<0" - bucket #2: values in [0,1), dimension value "0" - bucket #3: values in [1,3), dimension value "1-2" - bucket #4: values in [3,4), dimension value "3" - bucket #5: values in [4,7), dimension value "4-6" - bucket #6: values \>= 7, dimension value "7+" NOTE: If you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is: "<50", "1001+", "121-1000", "50-120" And the ascending `HISTOGRAM_BUCKET` order is: "<50", "50-120", "121-1000", "1001+" The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` for a histogram-mutated dimension.
|
||||
*/
|
||||
histogramBuckets?: string[] | null;
|
||||
/**
|
||||
@@ -328,11 +313,11 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
export interface Schema$EventData {
|
||||
/**
|
||||
* Type of interaction with the object. Eg: 'play'.
|
||||
* Type of interaction with the object. Eg: 'play'.
|
||||
*/
|
||||
eventAction?: string | null;
|
||||
/**
|
||||
* The object on the page that was interacted with. Eg: 'Video'.
|
||||
* The object on the page that was interacted with. Eg: 'Video'.
|
||||
*/
|
||||
eventCategory?: string | null;
|
||||
/**
|
||||
@@ -545,7 +530,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
export interface Schema$Pivot {
|
||||
/**
|
||||
* DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have `ga:browser` as the requested dimension in the pivot region, and you specify key filters to restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers would show up as columns.
|
||||
* DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have `ga:browser` as the requested dimension in the pivot region, and you specify key filters to restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers would show up as columns.
|
||||
*/
|
||||
dimensionFilterClauses?: Schema$DimensionFilterClause[];
|
||||
/**
|
||||
@@ -561,7 +546,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
metrics?: Schema$Metric[];
|
||||
/**
|
||||
* If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response.
|
||||
* If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response.
|
||||
*/
|
||||
startGroup?: number | null;
|
||||
}
|
||||
@@ -667,7 +652,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
rowCount?: number | null;
|
||||
/**
|
||||
* There's one ReportRow for every unique combination of dimensions.
|
||||
* There's one ReportRow for every unique combination of dimensions.
|
||||
*/
|
||||
rows?: Schema$ReportRow[];
|
||||
/**
|
||||
@@ -679,7 +664,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
samplingSpaceSizes?: string[] | null;
|
||||
/**
|
||||
* For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`. Totals are computed before pagination.
|
||||
* For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`. Totals are computed before pagination.
|
||||
*/
|
||||
totals?: Schema$DateRangeValues[];
|
||||
}
|
||||
@@ -720,7 +705,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
includeEmptyRows?: boolean | null;
|
||||
/**
|
||||
* The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.
|
||||
* The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.
|
||||
*/
|
||||
metricFilterClauses?: Schema$MetricFilterClause[];
|
||||
/**
|
||||
@@ -728,11 +713,11 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
metrics?: Schema$Metric[];
|
||||
/**
|
||||
* Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.
|
||||
* Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.
|
||||
*/
|
||||
orderBys?: Schema$OrderBy[];
|
||||
/**
|
||||
* Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value.
|
||||
* Page size is for paging and specifies the maximum number of returned rows. Page size should be \>= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value.
|
||||
*/
|
||||
pageSize?: number | null;
|
||||
/**
|
||||
@@ -744,7 +729,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
pivots?: Schema$Pivot[];
|
||||
/**
|
||||
* The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
|
||||
* The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
|
||||
*/
|
||||
samplingLevel?: string | null;
|
||||
/**
|
||||
@@ -788,11 +773,11 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
appName?: string | null;
|
||||
/**
|
||||
* Mobile manufacturer or branded name. Eg: "Google", "Apple" etc.
|
||||
* Mobile manufacturer or branded name. Eg: "Google", "Apple" etc.
|
||||
*/
|
||||
mobileDeviceBranding?: string | null;
|
||||
/**
|
||||
* Mobile device model. Eg: "Pixel", "iPhone" etc.
|
||||
* Mobile device model. Eg: "Pixel", "iPhone" etc.
|
||||
*/
|
||||
mobileDeviceModel?: string | null;
|
||||
/**
|
||||
@@ -813,7 +798,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
dateRange?: Schema$DateRange;
|
||||
/**
|
||||
* Page size is for paging and specifies the maximum number of returned rows. Page size should be > 0. If the value is 0 or if the field isn't specified, the request returns the default of 1000 rows per page.
|
||||
* Page size is for paging and specifies the maximum number of returned rows. Page size should be \> 0. If the value is 0 or if the field isn't specified, the request returns the default of 1000 rows per page.
|
||||
*/
|
||||
pageSize?: number | null;
|
||||
/**
|
||||
@@ -906,7 +891,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
export interface Schema$SegmentFilter {
|
||||
/**
|
||||
* If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { "segmentFilters": [{ "simpleSegment" :{ "orFiltersForSegment": [{ "segmentFilterClauses":[{ "dimensionFilter": { "dimensionName": "ga:city", "expressions": ["New York"] } }] }] }, "not": "True" }] },
|
||||
* If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { "segmentFilters": [{ "simpleSegment" :{ "orFiltersForSegment": [{ "segmentFilterClauses":[{ "dimensionFilter": { "dimensionName": "ga:city", "expressions": ["New York"] \} \}] \}] \}, "not": "True" \}] \},
|
||||
*/
|
||||
not?: boolean | null;
|
||||
/**
|
||||
@@ -956,7 +941,7 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
operator?: string | null;
|
||||
/**
|
||||
* Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions.
|
||||
* Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions.
|
||||
*/
|
||||
scope?: string | null;
|
||||
}
|
||||
@@ -1038,15 +1023,15 @@ export declare namespace analyticsreporting_v4 {
|
||||
*/
|
||||
activities?: Schema$Activity[];
|
||||
/**
|
||||
* The data source of a hit. By default, hits sent from analytics.js are reported as "web" and hits sent from the mobile SDKs are reported as "app". These values can be overridden in the Measurement Protocol.
|
||||
* The data source of a hit. By default, hits sent from analytics.js are reported as "web" and hits sent from the mobile SDKs are reported as "app". These values can be overridden in the Measurement Protocol.
|
||||
*/
|
||||
dataSource?: string | null;
|
||||
/**
|
||||
* The type of device used: "mobile", "tablet" etc.
|
||||
* The type of device used: "mobile", "tablet" etc.
|
||||
*/
|
||||
deviceCategory?: string | null;
|
||||
/**
|
||||
* Platform on which the activity happened: "android", "ios" etc.
|
||||
* Platform on which the activity happened: "android", "ios" etc.
|
||||
*/
|
||||
platform?: string | null;
|
||||
/**
|
||||
@@ -1062,27 +1047,74 @@ export declare namespace analyticsreporting_v4 {
|
||||
context: APIRequestContext;
|
||||
constructor(context: APIRequestContext);
|
||||
/**
|
||||
* analyticsreporting.reports.batchGet
|
||||
* @desc Returns the Analytics data.
|
||||
* @alias analyticsreporting.reports.batchGet
|
||||
* @memberOf! ()
|
||||
* Returns the Analytics data.
|
||||
* @example
|
||||
* ```js
|
||||
* // Before running the sample:
|
||||
* // - Enable the API at:
|
||||
* // https://console.developers.google.com/apis/api/analyticsreporting.googleapis.com
|
||||
* // - Login into gcloud by running:
|
||||
* // `$ gcloud auth application-default login`
|
||||
* // - Install the npm module by running:
|
||||
* // `$ npm install googleapis`
|
||||
*
|
||||
* @param {object} params Parameters for request
|
||||
* @param {().GetReportsRequest} params.resource Request body data
|
||||
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
||||
* @param {callback} callback The callback that handles the response.
|
||||
* @return {object} Request object
|
||||
* const {google} = require('googleapis');
|
||||
* const analyticsreporting = google.analyticsreporting('v4');
|
||||
*
|
||||
* 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/analytics',
|
||||
* 'https://www.googleapis.com/auth/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 analyticsreporting.reports.batchGet({
|
||||
* // Request body metadata
|
||||
* requestBody: {
|
||||
* // request body parameters
|
||||
* // {
|
||||
* // "reportRequests": [],
|
||||
* // "useResourceQuotas": false
|
||||
* // }
|
||||
* },
|
||||
* });
|
||||
* console.log(res.data);
|
||||
*
|
||||
* // Example response
|
||||
* // {
|
||||
* // "queryCost": 0,
|
||||
* // "reports": [],
|
||||
* // "resourceQuotasRemaining": {}
|
||||
* // }
|
||||
* }
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
batchGet(params: Params$Resource$Reports$Batchget, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
||||
batchGet(params?: Params$Resource$Reports$Batchget, options?: MethodOptions): GaxiosPromise<Schema$GetReportsResponse>;
|
||||
batchGet(params: Params$Resource$Reports$Batchget, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
||||
batchGet(params: Params$Resource$Reports$Batchget, options: MethodOptions | BodyResponseCallback<Schema$GetReportsResponse>, callback: BodyResponseCallback<Schema$GetReportsResponse>): void;
|
||||
batchGet(params: Params$Resource$Reports$Batchget, callback: BodyResponseCallback<Schema$GetReportsResponse>): void;
|
||||
batchGet(callback: BodyResponseCallback<Schema$GetReportsResponse>): void;
|
||||
}
|
||||
export interface Params$Resource$Reports$Batchget extends StandardParameters {
|
||||
/**
|
||||
* Auth client or API Key for the request
|
||||
*/
|
||||
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
|
||||
/**
|
||||
* Request body metadata
|
||||
*/
|
||||
@@ -1092,27 +1124,79 @@ export declare namespace analyticsreporting_v4 {
|
||||
context: APIRequestContext;
|
||||
constructor(context: APIRequestContext);
|
||||
/**
|
||||
* analyticsreporting.userActivity.search
|
||||
* @desc Returns User Activity data.
|
||||
* @alias analyticsreporting.userActivity.search
|
||||
* @memberOf! ()
|
||||
* Returns User Activity data.
|
||||
* @example
|
||||
* ```js
|
||||
* // Before running the sample:
|
||||
* // - Enable the API at:
|
||||
* // https://console.developers.google.com/apis/api/analyticsreporting.googleapis.com
|
||||
* // - Login into gcloud by running:
|
||||
* // `$ gcloud auth application-default login`
|
||||
* // - Install the npm module by running:
|
||||
* // `$ npm install googleapis`
|
||||
*
|
||||
* @param {object} params Parameters for request
|
||||
* @param {().SearchUserActivityRequest} params.resource Request body data
|
||||
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
||||
* @param {callback} callback The callback that handles the response.
|
||||
* @return {object} Request object
|
||||
* const {google} = require('googleapis');
|
||||
* const analyticsreporting = google.analyticsreporting('v4');
|
||||
*
|
||||
* 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/analytics',
|
||||
* 'https://www.googleapis.com/auth/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 analyticsreporting.userActivity.search({
|
||||
* // Request body metadata
|
||||
* requestBody: {
|
||||
* // request body parameters
|
||||
* // {
|
||||
* // "activityTypes": [],
|
||||
* // "dateRange": {},
|
||||
* // "pageSize": 0,
|
||||
* // "pageToken": "my_pageToken",
|
||||
* // "user": {},
|
||||
* // "viewId": "my_viewId"
|
||||
* // }
|
||||
* },
|
||||
* });
|
||||
* console.log(res.data);
|
||||
*
|
||||
* // Example response
|
||||
* // {
|
||||
* // "nextPageToken": "my_nextPageToken",
|
||||
* // "sampleRate": {},
|
||||
* // "sessions": [],
|
||||
* // "totalRows": 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.
|
||||
*/
|
||||
search(params: Params$Resource$Useractivity$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
||||
search(params?: Params$Resource$Useractivity$Search, options?: MethodOptions): GaxiosPromise<Schema$SearchUserActivityResponse>;
|
||||
search(params: Params$Resource$Useractivity$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
||||
search(params: Params$Resource$Useractivity$Search, options: MethodOptions | BodyResponseCallback<Schema$SearchUserActivityResponse>, callback: BodyResponseCallback<Schema$SearchUserActivityResponse>): void;
|
||||
search(params: Params$Resource$Useractivity$Search, callback: BodyResponseCallback<Schema$SearchUserActivityResponse>): void;
|
||||
search(callback: BodyResponseCallback<Schema$SearchUserActivityResponse>): void;
|
||||
}
|
||||
export interface Params$Resource$Useractivity$Search extends StandardParameters {
|
||||
/**
|
||||
* Auth client or API Key for the request
|
||||
*/
|
||||
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
|
||||
/**
|
||||
* Request body metadata
|
||||
*/
|
||||
@@ -1120,3 +1204,4 @@ export declare namespace analyticsreporting_v4 {
|
||||
}
|
||||
export {};
|
||||
}
|
||||
//# sourceMappingURL=v4.d.ts.map
|
||||
Reference in New Issue
Block a user