diff --git a/package.json b/package.json
index c01b2a177fb..1e7e97eba30 100644
--- a/package.json
+++ b/package.json
@@ -8,8 +8,8 @@
},
"license": "Apache-2.0",
"dependencies": {
- "google-auth-library": "^3.0.0",
- "googleapis-common": "^0.7.0"
+ "google-auth-library": "^4.0.0",
+ "googleapis-common": "^2.0.0"
},
"files": [
"build/src",
@@ -53,50 +53,50 @@
"node": ">=8.10.0"
},
"devDependencies": {
- "@compodoc/compodoc": "^1.1.7",
+ "@compodoc/compodoc": "^1.1.9",
"@types/chai": "^4.1.7",
"@types/execa": "^0.9.0",
"@types/minimist": "^1.2.0",
"@types/mkdirp": "^0.5.2",
- "@types/mocha": "^5.2.0",
+ "@types/mocha": "^5.2.6",
"@types/mv": "^2.1.0",
"@types/ncp": "^2.0.1",
- "@types/nock": "^10.0.0",
- "@types/node": "^10.0.8",
- "@types/nunjucks": "^3.0.0",
- "@types/qs": "^6.5.1",
+ "@types/nock": "^10.0.2",
+ "@types/node": "^12.0.1",
+ "@types/nunjucks": "^3.1.1",
+ "@types/qs": "^6.5.3",
"@types/rimraf": "^2.0.2",
"@types/source-map-support": "^0.5.0",
"@types/tmp": "^0.1.0",
"@types/url-template": "^2.0.28",
"assert-rejects": "^1.0.0",
"chai": "^4.2.0",
- "codecov": "^3.0.2",
- "eslint": "^5.6.0",
- "eslint-config-prettier": "^4.0.0",
- "eslint-plugin-node": "^9.0.0",
- "eslint-plugin-prettier": "^3.0.0",
+ "codecov": "^3.4.0",
+ "eslint": "^5.16.0",
+ "eslint-config-prettier": "^4.2.0",
+ "eslint-plugin-node": "^9.0.1",
+ "eslint-plugin-prettier": "^3.1.0",
"execa": "^1.0.0",
"gts": "^1.0.0",
- "hard-rejection": "^2.0.0",
+ "hard-rejection": "^2.1.0",
"intelli-espower-loader": "^1.0.1",
"js-green-licenses": "^0.5.0",
"minimist": "^1.2.0",
"mkdirp": "^0.5.1",
- "mocha": "^6.0.0",
+ "mocha": "^6.1.4",
"mv": "^2.1.1",
"ncp": "^2.0.0",
- "nock": "^10.0.0",
- "nunjucks": "^3.1.2",
- "nyc": "^14.0.0",
- "opn": "^5.3.0",
+ "nock": "^10.0.6",
+ "nunjucks": "^3.2.0",
+ "nyc": "^14.1.1",
+ "open": "^6.3.0",
"p-queue": "^5.0.0",
- "prettier": "^1.14.2",
- "rimraf": "^2.6.2",
+ "prettier": "^1.17.1",
+ "rimraf": "^2.6.3",
"server-destroy": "^1.0.1",
- "source-map-support": "^0.5.5",
+ "source-map-support": "^0.5.12",
"tmp": "^0.1.0",
- "typescript": "~3.4.0",
- "linkinator": "^1.1.2"
+ "typescript": "~3.4.5",
+ "linkinator": "^1.4.2"
}
}
diff --git a/samples/drive/quickstart.js b/samples/drive/quickstart.js
index db42a39a7f6..f3101d6e530 100644
--- a/samples/drive/quickstart.js
+++ b/samples/drive/quickstart.js
@@ -16,7 +16,7 @@
// [START main_body]
const {google} = require('googleapis');
const express = require('express');
-const opn = require('opn');
+const opn = require('open');
const path = require('path');
const fs = require('fs');
diff --git a/samples/oauth2.js b/samples/oauth2.js
index 1262b5f68af..9f66b67332c 100644
--- a/samples/oauth2.js
+++ b/samples/oauth2.js
@@ -17,7 +17,7 @@ const fs = require('fs');
const path = require('path');
const http = require('http');
const url = require('url');
-const opn = require('opn');
+const opn = require('open');
const destroyer = require('server-destroy');
const {google} = require('googleapis');
diff --git a/samples/package.json b/samples/package.json
index 1922e8d5a3a..4ba7fe3c125 100644
--- a/samples/package.json
+++ b/samples/package.json
@@ -10,15 +10,14 @@
"test": "mocha ../build/test/samples"
},
"dependencies": {
- "axios": "^0.18.0",
- "express": "^4.16.3",
+ "express": "^4.16.4",
"googleapis": "^39.2.0",
"nconf": "^0.10.0",
- "opn": "^5.3.0",
+ "open": "^6.3.0",
"server-destroy": "^1.0.1",
- "uuid": "^3.2.1"
+ "uuid": "^3.3.2"
},
"devDependencies": {
- "mocha": "^6.0.0"
+ "mocha": "^6.1.4"
}
}
diff --git a/samples/sampleclient.js b/samples/sampleclient.js
index 86663260ba9..71407ab5e78 100644
--- a/samples/sampleclient.js
+++ b/samples/sampleclient.js
@@ -20,7 +20,7 @@
const {google} = require('googleapis');
const http = require('http');
const url = require('url');
-const opn = require('opn');
+const opn = require('open');
const destroyer = require('server-destroy');
const fs = require('fs');
const path = require('path');
diff --git a/samples/sheets/quickstart.js b/samples/sheets/quickstart.js
index 600e62df153..2b7d4e9c7f0 100644
--- a/samples/sheets/quickstart.js
+++ b/samples/sheets/quickstart.js
@@ -16,7 +16,7 @@
// [START main_body]
const {google} = require('googleapis');
const express = require('express');
-const opn = require('opn');
+const opn = require('open');
const path = require('path');
const fs = require('fs');
diff --git a/src/apis/abusiveexperiencereport/package.json b/src/apis/abusiveexperiencereport/package.json
index 41c9f56dc87..f4ec61bc0db 100644
--- a/src/apis/abusiveexperiencereport/package.json
+++ b/src/apis/abusiveexperiencereport/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,15 +29,15 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
"null-loader": "^1.0.0",
"ts-loader": "^6.0.0",
- "typedoc": "^0.14.0",
- "typescript": "~3.4.0",
- "webpack": "^4.28.4",
- "webpack-cli": "^3.2.1"
+ "typedoc": "^0.14.2",
+ "typescript": "~3.4.5",
+ "webpack": "^4.31.0",
+ "webpack-cli": "^3.3.2"
}
}
diff --git a/src/apis/abusiveexperiencereport/v1.ts b/src/apis/abusiveexperiencereport/v1.ts
index ea119208982..6157ab3a558 100644
--- a/src/apis/abusiveexperiencereport/v1.ts
+++ b/src/apis/abusiveexperiencereport/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace abusiveexperiencereport_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace abusiveexperiencereport_v1 {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace abusiveexperiencereport_v1 {
/**
* Abusive Experience Report API
*
- * Views Abusive Experience Report data, and gets a list of sites that have a
- * significant number of abusive experiences.
+ * Views Abusive Experience Report data, and gets a list of sites that have a significant number of abusive experiences.
*
* @example
* const {google} = require('googleapis');
@@ -114,7 +109,10 @@ export namespace abusiveexperiencereport_v1 {
violatingSites: Resource$Violatingsites;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.sites = new Resource$Sites(this.context);
this.violatingSites = new Resource$Violatingsites(this.context);
@@ -249,14 +247,7 @@ export namespace abusiveexperiencereport_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The required site name. This is the site property whose abusive
- * experiences have been reviewed, and it must be URL-encoded. For example,
- * sites/https%3A%2F%2Fwww.google.com. The server will return an error of
- * BAD_REQUEST if this field is not filled in. Note that if the site
- * property is not yet verified in Search Console, the reportUrl field
- * returned by the API will lead to the verification page, prompting the
- * user to go through that process before they can gain access to the
- * Abusive Experience Report.
+ * The required site name. This is the site property whose abusive experiences have been reviewed, and it must be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The server will return an error of BAD_REQUEST if this field is not filled in. Note that if the site property is not yet verified in Search Console, the reportUrl field returned by the API will lead to the verification page, prompting the user to go through that process before they can gain access to the Abusive Experience Report.
*/
name?: string;
}
diff --git a/src/apis/acceleratedmobilepageurl/package.json b/src/apis/acceleratedmobilepageurl/package.json
index 3eceb67a368..e22018903fc 100644
--- a/src/apis/acceleratedmobilepageurl/package.json
+++ b/src/apis/acceleratedmobilepageurl/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/acceleratedmobilepageurl/v1.ts b/src/apis/acceleratedmobilepageurl/v1.ts
index 3bb259a85d3..a2bc56f5f11 100644
--- a/src/apis/acceleratedmobilepageurl/v1.ts
+++ b/src/apis/acceleratedmobilepageurl/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace acceleratedmobilepageurl_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace acceleratedmobilepageurl_v1 {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace acceleratedmobilepageurl_v1 {
/**
* Accelerated Mobile Pages (AMP) URL API
*
- * Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given
- * list of public URL(s).
+ * Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).
*
* @example
* const {google} = require('googleapis');
@@ -113,7 +108,10 @@ export namespace acceleratedmobilepageurl_v1 {
ampUrls: Resource$Ampurls;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.ampUrls = new Resource$Ampurls(this.context);
}
@@ -128,8 +126,7 @@ export namespace acceleratedmobilepageurl_v1 {
*/
ampUrl?: string;
/**
- * The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to
- * the cached document in the Google AMP Cache.
+ * The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache.
*/
cdnAmpUrl?: string;
/**
@@ -163,9 +160,7 @@ export namespace acceleratedmobilepageurl_v1 {
*/
lookupStrategy?: string;
/**
- * List of URLs to look up for the paired AMP URLs. The URLs are
- * case-sensitive. Up to 50 URLs per lookup (see [Usage
- * Limits](/amp/cache/reference/limits)).
+ * List of URLs to look up for the paired AMP URLs. The URLs are case-sensitive. Up to 50 URLs per lookup (see [Usage Limits](/amp/cache/reference/limits)).
*/
urls?: string[];
}
@@ -174,10 +169,7 @@ export namespace acceleratedmobilepageurl_v1 {
*/
export interface Schema$BatchGetAmpUrlsResponse {
/**
- * For each URL in BatchAmpUrlsRequest, the URL response. The response might
- * not be in the same order as URLs in the batch request. If
- * BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated only
- * once.
+ * For each URL in BatchAmpUrlsRequest, the URL response. The response might not be in the same order as URLs in the batch request. If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated only once.
*/
ampUrls?: Schema$AmpUrl[];
/**
@@ -194,8 +186,7 @@ export namespace acceleratedmobilepageurl_v1 {
/**
* acceleratedmobilepageurl.ampUrls.batchGet
- * @desc Returns AMP URL(s) and equivalent [AMP Cache
- * URL(s)](/amp/cache/overview#amp-cache-url-format).
+ * @desc Returns AMP URL(s) and equivalent [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).
* @alias acceleratedmobilepageurl.ampUrls.batchGet
* @memberOf! ()
*
diff --git a/src/apis/accessapproval/package.json b/src/apis/accessapproval/package.json
index 5d25d04f36b..474d09c6bda 100644
--- a/src/apis/accessapproval/package.json
+++ b/src/apis/accessapproval/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/accessapproval/v1beta1.ts b/src/apis/accessapproval/v1beta1.ts
index 906ec1fad4a..0a10a413e9b 100644
--- a/src/apis/accessapproval/v1beta1.ts
+++ b/src/apis/accessapproval/v1beta1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace accessapproval_v1beta1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace accessapproval_v1beta1 {
*/
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.
+ * 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;
/**
@@ -114,7 +110,10 @@ export namespace accessapproval_v1beta1 {
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.folders = new Resource$Folders(this.context);
this.organizations = new Resource$Organizations(this.context);
@@ -127,18 +126,11 @@ export namespace accessapproval_v1beta1 {
*/
export interface Schema$AccessApprovalSettings {
/**
- * The resource name of the settings. Format is one of: <ol>
- * <li>"projects/{project_id}/accessApprovalSettings"</li>
- * <li>"folders/{folder_id}/accessApprovalSettings"</li>
- * <li>"organizations/{organization_id}/accessApprovalSettings"</li>
- * <ol>
+ * The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol>
*/
name?: string;
/**
- * A list of email addresses to which notifications relating to approval
- * requests should be sent. Notifications relating to a resource will be
- * sent to all emails in the settings of ancestor resources of that
- * resource.
+ * A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource.
*/
notificationEmails?: string[];
}
@@ -147,29 +139,11 @@ export namespace accessapproval_v1beta1 {
*/
export interface Schema$AccessLocations {
/**
- * The "home office" location of the principal. A two-letter
- * country code (ISO 3166-1 alpha-2), such as "US", "DE"
- * or "GB" or a region code. In some limited situations Google
- * systems may refer refer to a region code instead of a country code.
- * Possible Region Codes: <ol> <li>ASI: Asia</li>
- * <li>EUR: Europe</li> <li>OCE: Oceania</li>
- * <li>AFR: Africa</li> <li>NAM: North
- * America</li> <li>SAM: South America</li>
- * <li>ANT: Antarctica</li> <li>ANY: Any
- * location</li> </ol>
+ * The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: <ol> <li>ASI: Asia</li> <li>EUR: Europe</li> <li>OCE: Oceania</li> <li>AFR: Africa</li> <li>NAM: North America</li> <li>SAM: South America</li> <li>ANT: Antarctica</li> <li>ANY: Any location</li> </ol>
*/
principalOfficeCountry?: string;
/**
- * Physical location of the principal at the time of the access. A
- * two-letter country code (ISO 3166-1 alpha-2), such as "US",
- * "DE" or "GB" or a region code. In some limited
- * situations Google systems may refer refer to a region code instead of a
- * country code. Possible Region Codes: <ol> <li>ASI:
- * Asia</li> <li>EUR: Europe</li> <li>OCE:
- * Oceania</li> <li>AFR: Africa</li> <li>NAM:
- * North America</li> <li>SAM: South America</li>
- * <li>ANT: Antarctica</li> <li>ANY: Any
- * location</li> </ol>
+ * Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: <ol> <li>ASI: Asia</li> <li>EUR: Europe</li> <li>OCE: Oceania</li> <li>AFR: Africa</li> <li>NAM: North America</li> <li>SAM: South America</li> <li>ANT: Antarctica</li> <li>ANY: Any location</li> </ol>
*/
principalPhysicalLocationCountry?: string;
}
@@ -196,14 +170,11 @@ export namespace accessapproval_v1beta1 {
*/
dismiss?: Schema$DismissDecision;
/**
- * The resource name of the request. Format is
- * "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
+ * The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
*/
name?: string;
/**
- * The requested expiration for the approval. If the request is approved,
- * access will be granted from the time of approval until the expiration
- * time.
+ * The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.
*/
requestedExpiration?: string;
/**
@@ -215,16 +186,13 @@ export namespace accessapproval_v1beta1 {
*/
requestedReason?: Schema$AccessReason;
/**
- * The resource for which approval is being requested. The format of the
- * resource name is defined at
- * https://cloud.google.com/apis/design/resource_names. The resource name
- * here may either be a "full" resource name (e.g.
- * "//library.googleapis.com/shelves/shelf1/books/book2") or a
- * "relative" resource name (e.g.
- * "shelves/shelf1/books/book2") as described in the resource name
- * specification.
+ * The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
*/
requestedResourceName?: string;
+ /**
+ * Properties related to the resource represented by requested_resource_name.
+ */
+ requestedResourceProperties?: Schema$ResourceProperties;
/**
* The time at which approval was requested.
*/
@@ -274,11 +242,19 @@ export namespace accessapproval_v1beta1 {
*/
approvalRequests?: Schema$ApprovalRequest[];
/**
- * Token to retrieve the next page of results, or empty if there are no
- * more.
+ * Token to retrieve the next page of results, or empty if there are no more.
*/
nextPageToken?: string;
}
+ /**
+ * The properties associated with the resource of the request.
+ */
+ export interface Schema$ResourceProperties {
+ /**
+ * Whether an approval will exclude the descendants of the resource being requested.
+ */
+ excludesDescendants?: boolean;
+ }
export class Resource$Folders {
context: APIRequestContext;
@@ -292,8 +268,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.folders.getAccessApprovalSettings
- * @desc Gets the settings associated with a project, folder, or
- * organization.
+ * @desc Gets the settings associated with a project, folder, or organization.
* @alias accessapproval.folders.getAccessApprovalSettings
* @memberOf! ()
*
@@ -369,8 +344,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.folders.updateAccessApprovalSettings
- * @desc Updates the settings associated with a project, folder, or
- * organization. Completely replaces the existing settings.
+ * @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings.
* @alias accessapproval.folders.updateAccessApprovalSettings
* @memberOf! ()
*
@@ -466,10 +440,7 @@ export namespace accessapproval_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The resource name of the settings. Format is one of:
- * - "projects/{project_id}/accessApprovalSettings"
- * - "folders/{folder_id}/accessApprovalSettings"
- * - "organizations/{organization_id}/accessApprovalSettings"
+ * The resource name of the settings. Format is one of: - "projects/{project_id}/accessApprovalSettings"
- "folders/{folder_id}/accessApprovalSettings"
- "organizations/{organization_id}/accessApprovalSettings"
*/
name?: string;
@@ -487,9 +458,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.folders.approvalRequests.approve
- * @desc Approves a request and returns the updated ApprovalRequest. Returns
- * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if
- * the request exists but is not in a pending state.
+ * @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.folders.approvalRequests.approve
* @memberOf! ()
*
@@ -565,11 +534,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.folders.approvalRequests.dismiss
- * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE:
- * This does not deny access to the resource if another request has been
- * made and approved. It is equivalent in effect to ignoring the request
- * altogether. Returns NOT_FOUND if the request does not exist. Returns
- * FAILED_PRECONDITION if the request exists but is not in a pending state.
+ * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.folders.approvalRequests.dismiss
* @memberOf! ()
*
@@ -645,8 +610,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.folders.approvalRequests.get
- * @desc Gets an approval request. Returns NOT_FOUND if the request does not
- * exist.
+ * @desc Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @alias accessapproval.folders.approvalRequests.get
* @memberOf! ()
*
@@ -718,9 +682,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.folders.approvalRequests.list
- * @desc Lists approval requests associated with a project, folder, or
- * organization. Approval requests can be filtered by state (pending,
- * active, dismissed). The order is reverse chronological.
+ * @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
* @alias accessapproval.folders.approvalRequests.list
* @memberOf! ()
*
@@ -860,12 +822,7 @@ export namespace accessapproval_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * A filter on the type of approval requests to retrieve. Must be one of the
- * following values: - [not set]: Requests that are pending or have
- * active approvals.
- ALL: All requests.
- PENDING: Only
- * pending requests.
- ACTIVE: Only active (i.e. currently
- * approved) requests.
- DISMISSED: Only dismissed (including
- * expired) requests.
+ * A filter on the type of approval requests to retrieve. Must be one of the following values: - [not set]: Requests that are pending or have active approvals.
- ALL: All requests.
- PENDING: Only pending requests.
- ACTIVE: Only active (i.e. currently approved) requests.
- DISMISSED: Only dismissed (including expired) requests.
*/
filter?: string;
/**
@@ -877,8 +834,7 @@ export namespace accessapproval_v1beta1 {
*/
pageToken?: string;
/**
- * The parent resource. This may be "projects/{project_id}",
- * "folders/{folder_id}", or "organizations/{organization_id}".
+ * The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
*/
parent?: string;
}
@@ -895,8 +851,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.organizations.getAccessApprovalSettings
- * @desc Gets the settings associated with a project, folder, or
- * organization.
+ * @desc Gets the settings associated with a project, folder, or organization.
* @alias accessapproval.organizations.getAccessApprovalSettings
* @memberOf! ()
*
@@ -972,8 +927,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.organizations.updateAccessApprovalSettings
- * @desc Updates the settings associated with a project, folder, or
- * organization. Completely replaces the existing settings.
+ * @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings.
* @alias accessapproval.organizations.updateAccessApprovalSettings
* @memberOf! ()
*
@@ -1069,10 +1023,7 @@ export namespace accessapproval_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The resource name of the settings. Format is one of:
- * - "projects/{project_id}/accessApprovalSettings"
- * - "folders/{folder_id}/accessApprovalSettings"
- * - "organizations/{organization_id}/accessApprovalSettings"
+ * The resource name of the settings. Format is one of: - "projects/{project_id}/accessApprovalSettings"
- "folders/{folder_id}/accessApprovalSettings"
- "organizations/{organization_id}/accessApprovalSettings"
*/
name?: string;
@@ -1090,9 +1041,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.organizations.approvalRequests.approve
- * @desc Approves a request and returns the updated ApprovalRequest. Returns
- * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if
- * the request exists but is not in a pending state.
+ * @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.organizations.approvalRequests.approve
* @memberOf! ()
*
@@ -1168,11 +1117,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.organizations.approvalRequests.dismiss
- * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE:
- * This does not deny access to the resource if another request has been
- * made and approved. It is equivalent in effect to ignoring the request
- * altogether. Returns NOT_FOUND if the request does not exist. Returns
- * FAILED_PRECONDITION if the request exists but is not in a pending state.
+ * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.organizations.approvalRequests.dismiss
* @memberOf! ()
*
@@ -1248,8 +1193,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.organizations.approvalRequests.get
- * @desc Gets an approval request. Returns NOT_FOUND if the request does not
- * exist.
+ * @desc Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @alias accessapproval.organizations.approvalRequests.get
* @memberOf! ()
*
@@ -1321,9 +1265,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.organizations.approvalRequests.list
- * @desc Lists approval requests associated with a project, folder, or
- * organization. Approval requests can be filtered by state (pending,
- * active, dismissed). The order is reverse chronological.
+ * @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
* @alias accessapproval.organizations.approvalRequests.list
* @memberOf! ()
*
@@ -1463,12 +1405,7 @@ export namespace accessapproval_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * A filter on the type of approval requests to retrieve. Must be one of the
- * following values: - [not set]: Requests that are pending or have
- * active approvals.
- ALL: All requests.
- PENDING: Only
- * pending requests.
- ACTIVE: Only active (i.e. currently
- * approved) requests.
- DISMISSED: Only dismissed (including
- * expired) requests.
+ * A filter on the type of approval requests to retrieve. Must be one of the following values: - [not set]: Requests that are pending or have active approvals.
- ALL: All requests.
- PENDING: Only pending requests.
- ACTIVE: Only active (i.e. currently approved) requests.
- DISMISSED: Only dismissed (including expired) requests.
*/
filter?: string;
/**
@@ -1480,8 +1417,7 @@ export namespace accessapproval_v1beta1 {
*/
pageToken?: string;
/**
- * The parent resource. This may be "projects/{project_id}",
- * "folders/{folder_id}", or "organizations/{organization_id}".
+ * The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
*/
parent?: string;
}
@@ -1498,8 +1434,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.projects.getAccessApprovalSettings
- * @desc Gets the settings associated with a project, folder, or
- * organization.
+ * @desc Gets the settings associated with a project, folder, or organization.
* @alias accessapproval.projects.getAccessApprovalSettings
* @memberOf! ()
*
@@ -1575,8 +1510,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.projects.updateAccessApprovalSettings
- * @desc Updates the settings associated with a project, folder, or
- * organization. Completely replaces the existing settings.
+ * @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings.
* @alias accessapproval.projects.updateAccessApprovalSettings
* @memberOf! ()
*
@@ -1672,10 +1606,7 @@ export namespace accessapproval_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The resource name of the settings. Format is one of:
- * - "projects/{project_id}/accessApprovalSettings"
- * - "folders/{folder_id}/accessApprovalSettings"
- * - "organizations/{organization_id}/accessApprovalSettings"
+ * The resource name of the settings. Format is one of: - "projects/{project_id}/accessApprovalSettings"
- "folders/{folder_id}/accessApprovalSettings"
- "organizations/{organization_id}/accessApprovalSettings"
*/
name?: string;
@@ -1693,9 +1624,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.projects.approvalRequests.approve
- * @desc Approves a request and returns the updated ApprovalRequest. Returns
- * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if
- * the request exists but is not in a pending state.
+ * @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.projects.approvalRequests.approve
* @memberOf! ()
*
@@ -1771,11 +1700,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.projects.approvalRequests.dismiss
- * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE:
- * This does not deny access to the resource if another request has been
- * made and approved. It is equivalent in effect to ignoring the request
- * altogether. Returns NOT_FOUND if the request does not exist. Returns
- * FAILED_PRECONDITION if the request exists but is not in a pending state.
+ * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @alias accessapproval.projects.approvalRequests.dismiss
* @memberOf! ()
*
@@ -1851,8 +1776,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.projects.approvalRequests.get
- * @desc Gets an approval request. Returns NOT_FOUND if the request does not
- * exist.
+ * @desc Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @alias accessapproval.projects.approvalRequests.get
* @memberOf! ()
*
@@ -1924,9 +1848,7 @@ export namespace accessapproval_v1beta1 {
/**
* accessapproval.projects.approvalRequests.list
- * @desc Lists approval requests associated with a project, folder, or
- * organization. Approval requests can be filtered by state (pending,
- * active, dismissed). The order is reverse chronological.
+ * @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
* @alias accessapproval.projects.approvalRequests.list
* @memberOf! ()
*
@@ -2066,12 +1988,7 @@ export namespace accessapproval_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * A filter on the type of approval requests to retrieve. Must be one of the
- * following values: - [not set]: Requests that are pending or have
- * active approvals.
- ALL: All requests.
- PENDING: Only
- * pending requests.
- ACTIVE: Only active (i.e. currently
- * approved) requests.
- DISMISSED: Only dismissed (including
- * expired) requests.
+ * A filter on the type of approval requests to retrieve. Must be one of the following values: - [not set]: Requests that are pending or have active approvals.
- ALL: All requests.
- PENDING: Only pending requests.
- ACTIVE: Only active (i.e. currently approved) requests.
- DISMISSED: Only dismissed (including expired) requests.
*/
filter?: string;
/**
@@ -2083,8 +2000,7 @@ export namespace accessapproval_v1beta1 {
*/
pageToken?: string;
/**
- * The parent resource. This may be "projects/{project_id}",
- * "folders/{folder_id}", or "organizations/{organization_id}".
+ * The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
*/
parent?: string;
}
diff --git a/src/apis/accesscontextmanager/package.json b/src/apis/accesscontextmanager/package.json
index 97827af0bb2..548a74bacbc 100644
--- a/src/apis/accesscontextmanager/package.json
+++ b/src/apis/accesscontextmanager/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts
index 6ea7b2580cd..4d75e71d0a8 100644
--- a/src/apis/accesscontextmanager/v1.ts
+++ b/src/apis/accesscontextmanager/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace accesscontextmanager_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace accesscontextmanager_v1 {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace accesscontextmanager_v1 {
/**
* Access Context Manager API
*
- * An API for setting attribute based access control to requests to GCP
- * services.
+ * An API for setting attribute based access control to requests to GCP services.
*
* @example
* const {google} = require('googleapis');
@@ -114,7 +109,10 @@ export namespace accesscontextmanager_v1 {
operations: Resource$Operations;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.accessPolicies = new Resource$Accesspolicies(this.context);
this.operations = new Resource$Operations(this.context);
@@ -122,9 +120,7 @@ export namespace accesscontextmanager_v1 {
}
/**
- * An `AccessLevel` is a label that can be applied to requests to GCP
- * services, along with a list of requirements necessary for the label to be
- * applied.
+ * An `AccessLevel` is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied.
*/
export interface Schema$AccessLevel {
/**
@@ -140,9 +136,7 @@ export namespace accesscontextmanager_v1 {
*/
description?: string;
/**
- * Required. Resource name for the Access Level. The `short_name` component
- * must begin with a letter and only include alphanumeric and '_'.
- * Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`
+ * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`
*/
name?: string;
/**
@@ -155,11 +149,7 @@ export namespace accesscontextmanager_v1 {
updateTime?: string;
}
/**
- * `AccessPolicy` is a container for `AccessLevels` (which define the
- * necessary attributes to use GCP services) and `ServicePerimeters` (which
- * define regions of services able to freely pass data within a perimeter). An
- * access policy is globally visible within an organization, and the
- * restrictions it specifies apply to all projects within an organization.
+ * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.
*/
export interface Schema$AccessPolicy {
/**
@@ -167,14 +157,11 @@ export namespace accesscontextmanager_v1 {
*/
createTime?: string;
/**
- * Output only. Resource name of the `AccessPolicy`. Format:
- * `accessPolicies/{policy_id}`
+ * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`
*/
name?: string;
/**
- * Required. The parent of this `AccessPolicy` in the Cloud Resource
- * Hierarchy. Currently immutable once created. Format:
- * `organizations/{organization_id}`
+ * Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`
*/
parent?: string;
/**
@@ -191,11 +178,7 @@ export namespace accesscontextmanager_v1 {
*/
export interface Schema$BasicLevel {
/**
- * How the `conditions` list should be combined to determine if a request is
- * granted this `AccessLevel`. If AND is used, each `Condition` in
- * `conditions` must be satisfied for the `AccessLevel` to be applied. If OR
- * is used, at least one `Condition` in `conditions` must be satisfied for
- * the `AccessLevel` to be applied. Default behavior is AND.
+ * How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND.
*/
combiningFunction?: string;
/**
@@ -208,72 +191,40 @@ export namespace accesscontextmanager_v1 {
*/
export interface Schema$CancelOperationRequest {}
/**
- * A condition necessary for an `AccessLevel` to be granted. The Condition is
- * an AND over its fields. So a Condition is true if: 1) the request IP is
- * from one of the listed subnetworks AND 2) the originating device complies
- * with the listed device policy AND 3) all listed access levels are granted
- * AND 4) the request was sent at a time allowed by the DateTimeRestriction.
+ * A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.
*/
export interface Schema$Condition {
/**
- * Device specific restrictions, all restrictions must hold for the
- * Condition to be true. If not specified, all devices are allowed.
+ * Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.
*/
devicePolicy?: Schema$DevicePolicy;
/**
- * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that
- * for a CIDR IP address block, the specified IP address portion must be
- * properly truncated (i.e. all the host bits must be zero) or the input is
- * considered malformed. For example, "192.0.2.0/24" is accepted
- * but "192.0.2.1/24" is not. Similarly, for IPv6,
- * "2001:db8::/32" is accepted whereas "2001:db8::1/32"
- * is not. The originating IP of a request must be in one of the listed
- * subnets in order for this Condition to be true. If empty, all IP
- * addresses are allowed.
+ * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.
*/
ipSubnetworks?: string[];
/**
- * The request must be made by one of the provided user or service accounts.
- * Groups are not supported. Syntax: `user:{emailid}`
- * `serviceAccount:{emailid}` If not specified, a request may come from any
- * user.
+ * The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user.
*/
members?: string[];
/**
- * Whether to negate the Condition. If true, the Condition becomes a NAND
- * over its non-empty fields, each field must be false for the Condition
- * overall to be satisfied. Defaults to false.
+ * Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.
*/
negate?: boolean;
/**
- * The request must originate from one of the provided countries/regions.
- * Must be valid ISO 3166-1 alpha-2 codes.
+ * The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.
*/
regions?: string[];
/**
- * A list of other access levels defined in the same `Policy`, referenced by
- * resource name. Referencing an `AccessLevel` which does not exist is an
- * error. All access levels listed must be granted for the Condition to be
- * true. Example:
- * "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`
+ * A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`
*/
requiredAccessLevels?: string[];
}
/**
- * `DevicePolicy` specifies device specific restrictions necessary to acquire
- * a given access level. A `DevicePolicy` specifies requirements for requests
- * from devices to be granted access levels, it does not do any enforcement on
- * the device. `DevicePolicy` acts as an AND over all specified fields, and
- * each repeated field is an OR over its elements. Any unset fields are
- * ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type
- * : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will
- * be true for requests originating from encrypted Linux desktops and
- * encrypted Windows desktops.
+ * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops.
*/
export interface Schema$DevicePolicy {
/**
- * Allowed device management levels, an empty list allows all management
- * levels.
+ * Allowed device management levels, an empty list allows all management levels.
*/
allowedDeviceManagementLevels?: string[];
/**
@@ -293,17 +244,12 @@ export namespace accesscontextmanager_v1 {
*/
requireCorpOwned?: boolean;
/**
- * Whether or not screenlock is required for the DevicePolicy to be true.
- * Defaults to `false`.
+ * Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.
*/
requireScreenlock?: boolean;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
@@ -315,8 +261,7 @@ export namespace accesscontextmanager_v1 {
*/
accessLevels?: Schema$AccessLevel[];
/**
- * The pagination token to retrieve the next page of results. If the value
- * is empty, no further results remain.
+ * The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
*/
nextPageToken?: string;
}
@@ -329,8 +274,7 @@ export namespace accesscontextmanager_v1 {
*/
accessPolicies?: Schema$AccessPolicy[];
/**
- * The pagination token to retrieve the next page of results. If the value
- * is empty, no further results remain.
+ * The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
*/
nextPageToken?: string;
}
@@ -352,8 +296,7 @@ export namespace accesscontextmanager_v1 {
*/
export interface Schema$ListServicePerimetersResponse {
/**
- * The pagination token to retrieve the next page of results. If the value
- * is empty, no further results remain.
+ * The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
*/
nextPageToken?: string;
/**
@@ -362,14 +305,11 @@ export namespace accesscontextmanager_v1 {
servicePerimeters?: Schema$ServicePerimeter[];
}
/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
+ * This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
- * If the value is `false`, it means the operation is still in progress. If
- * `true`, the operation is completed, and either `error` or `response` is
- * available.
+ * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean;
/**
@@ -377,26 +317,15 @@ export namespace accesscontextmanager_v1 {
*/
error?: Schema$Status;
/**
- * Service-specific metadata associated with the operation. It typically
- * contains progress information and common metadata such as create time.
- * Some services might not provide such metadata. Any method that returns a
- * long-running operation should document the metadata type, if any.
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any};
/**
- * The server-assigned name, which is only unique within the same service
- * that originally returns it. If you use the default HTTP mapping, the
- * `name` should have the format of `operations/some/unique/name`.
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
*/
name?: string;
/**
- * The normal response of the operation in case of success. If the original
- * method returns no data on success, such as `Delete`, the response is
- * `google.protobuf.Empty`. If the original method is standard
- * `Get`/`Create`/`Update`, the response should be the resource. For other
- * methods, the response should have the type `XxxResponse`, where `Xxx` is
- * the original method name. For example, if the original method name is
- * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {[key: string]: any};
}
@@ -405,9 +334,7 @@ export namespace accesscontextmanager_v1 {
*/
export interface Schema$OsConstraint {
/**
- * The minimum allowed OS version. If not set, any version of this OS
- * satisfies the constraint. Format: `"major.minor.patch"`.
- * Examples: `"10.5.301"`, `"9.2.1"`.
+ * The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`.
*/
minimumVersion?: string;
/**
@@ -415,24 +342,12 @@ export namespace accesscontextmanager_v1 {
*/
osType?: string;
/**
- * Only allows requests from devices with a verified Chrome OS.
- * Verifications includes requirements that the device is
- * enterprise-managed, conformant to Dasher domain policies, and the caller
- * has permission to call the API targeted by the request.
+ * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request.
*/
requireVerifiedChromeOs?: boolean;
}
/**
- * `ServicePerimeter` describes a set of GCP resources which can freely import
- * and export data amongst themselves, but not export outside of the
- * `ServicePerimeter`. If a request with a source within this
- * `ServicePerimeter` has a target outside of the `ServicePerimeter`, the
- * request will be blocked. Otherwise the request is allowed. There are two
- * types of Service Perimeter - Regular and Bridge. Regular Service Perimeters
- * cannot overlap, a single GCP project can only belong to a single regular
- * Service Perimeter. Service Perimeter Bridges can contain only GCP projects
- * as members, a single GCP project may belong to multiple Service Perimeter
- * Bridges.
+ * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges.
*/
export interface Schema$ServicePerimeter {
/**
@@ -440,29 +355,19 @@ export namespace accesscontextmanager_v1 {
*/
createTime?: string;
/**
- * Description of the `ServicePerimeter` and its use. Does not affect
- * behavior.
+ * Description of the `ServicePerimeter` and its use. Does not affect behavior.
*/
description?: string;
/**
- * Required. Resource name for the ServicePerimeter. The `short_name`
- * component must begin with a letter and only include alphanumeric and
- * '_'. Format:
- * `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
*/
name?: string;
/**
- * Perimeter type indicator. A single project is allowed to be a member of
- * single regular perimeter, but multiple service perimeter bridges. A
- * project cannot be a included in a perimeter bridge without being included
- * in regular perimeter. For perimeter bridges, the restricted service list
- * as well as access level lists must be empty.
+ * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.
*/
perimeterType?: string;
/**
- * Current ServicePerimeter configuration. Specifies sets of resources,
- * restricted services and access levels that determine perimeter content
- * and boundaries.
+ * Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.
*/
status?: Schema$ServicePerimeterConfig;
/**
@@ -475,69 +380,24 @@ export namespace accesscontextmanager_v1 {
updateTime?: string;
}
/**
- * `ServicePerimeterConfig` specifies a set of GCP resources that describe
- * specific Service Perimeter configuration.
+ * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration.
*/
export interface Schema$ServicePerimeterConfig {
/**
- * A list of `AccessLevel` resource names that allow resources within the
- * `ServicePerimeter` to be accessed from the internet. `AccessLevels`
- * listed must be in the same policy as this `ServicePerimeter`. Referencing
- * a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names
- * are listed, resources within the perimeter can only be accessed via GCP
- * calls with request origins within the perimeter. Example:
- * `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service
- * Perimeter Bridge, must be empty.
+ * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty.
*/
accessLevels?: string[];
/**
- * A list of GCP resources that are inside of the service perimeter.
- * Currently only projects are allowed. Format: `projects/{project_number}`
+ * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}`
*/
resources?: string[];
/**
- * GCP services that are subject to the Service Perimeter restrictions. For
- * example, if `storage.googleapis.com` is specified, access to the storage
- * buckets inside the perimeter must meet the perimeter's access
- * restrictions.
+ * GCP services that are subject to the Service Perimeter restrictions. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.
*/
restrictedServices?: string[];
}
/**
- * The `Status` type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by [gRPC](https://github.com/grpc). The error model is designed to be:
- * - Simple to use and understand for most users - Flexible enough to meet
- * unexpected needs # Overview The `Status` message contains three pieces of
- * data: error code, error message, and error details. The error code should
- * be an enum value of google.rpc.Code, but it may accept additional error
- * codes if needed. The error message should be a developer-facing English
- * message that helps developers *understand* and *resolve* the error. If a
- * localized user-facing error message is needed, put the localized message in
- * the error details or localize it in the client. The optional error details
- * may contain arbitrary information about the error. There is a predefined
- * set of error detail types in the package `google.rpc` that can be used for
- * common error conditions. # Language mapping The `Status` message is the
- * logical representation of the error model, but it is not necessarily the
- * actual wire format. When the `Status` message is exposed in different
- * client libraries and different wire protocols, it can be mapped
- * differently. For example, it will likely be mapped to some exceptions in
- * Java, but more likely mapped to some error codes in C. # Other uses The
- * error model and the `Status` message can be used in a variety of
- * environments, either with or without APIs, to provide a consistent
- * developer experience across different environments. Example uses of this
- * error model include: - Partial errors. If a service needs to return
- * partial errors to the client, it may embed the `Status` in the normal
- * response to indicate the partial errors. - Workflow errors. A typical
- * workflow has multiple steps. Each step may have a `Status` message for
- * error reporting. - Batch operations. If a client uses batch request and
- * batch response, the `Status` message should be used directly inside
- * batch response, one for each error sub-response. - Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the `Status` message. - Logging. If some API errors are stored in
- * logs, the message `Status` could be used directly after any stripping
- * needed for security/privacy reasons.
+ * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -545,14 +405,11 @@ export namespace accesscontextmanager_v1 {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set
- * of message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
@@ -573,11 +430,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.create
- * @desc Create an `AccessPolicy`. Fails if this organization already has a
- * `AccessPolicy`. The longrunning Operation will have a successful status
- * once the `AccessPolicy` has propagated to long-lasting storage. Syntactic
- * and basic semantic errors will be returned in `metadata` as a BadRequest
- * proto.
+ * @desc Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.
* @alias accesscontextmanager.accessPolicies.create
* @memberOf! ()
*
@@ -649,9 +502,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.delete
- * @desc Delete an AccessPolicy by resource name. The longrunning Operation
- * will have a successful status once the AccessPolicy has been removed from
- * long-lasting storage.
+ * @desc Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.
* @alias accesscontextmanager.accessPolicies.delete
* @memberOf! ()
*
@@ -876,10 +727,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.patch
- * @desc Update an AccessPolicy. The longrunning Operation from this RPC
- * will have a successful status once the changes to the AccessPolicy have
- * propagated to long-lasting storage. Syntactic and basic semantic errors
- * will be returned in `metadata` as a BadRequest proto.
+ * @desc Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.
* @alias accesscontextmanager.accessPolicies.patch
* @memberOf! ()
*
@@ -972,8 +820,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the access policy to delete. Format
- * `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy to delete. Format `accessPolicies/{policy_id}`
*/
name?: string;
}
@@ -985,8 +832,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the access policy to get. Format
- * `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy to get. Format `accessPolicies/{policy_id}`
*/
name?: string;
}
@@ -1002,13 +848,11 @@ export namespace accesscontextmanager_v1 {
*/
pageSize?: number;
/**
- * Next page token for the next batch of AccessPolicy instances. Defaults to
- * the first page of results.
+ * Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results.
*/
pageToken?: string;
/**
- * Required. Resource name for the container to list AccessPolicy instances
- * from. Format: `organizations/{org_id}`
+ * Required. Resource name for the container to list AccessPolicy instances from. Format: `organizations/{org_id}`
*/
parent?: string;
}
@@ -1020,8 +864,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Output only. Resource name of the `AccessPolicy`. Format:
- * `accessPolicies/{policy_id}`
+ * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`
*/
name?: string;
/**
@@ -1043,10 +886,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.accessLevels.create
- * @desc Create an Access Level. The longrunning operation from this RPC
- * will have a successful status once the Access Level has propagated to
- * long-lasting storage. Access Levels containing errors will result in an
- * error response for the first error encountered.
+ * @desc Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.accessLevels.create
* @memberOf! ()
*
@@ -1122,9 +962,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.accessLevels.delete
- * @desc Delete an Access Level by resource name. The longrunning operation
- * from this RPC will have a successful status once the Access Level has
- * been removed from long-lasting storage.
+ * @desc Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.
* @alias accesscontextmanager.accessPolicies.accessLevels.delete
* @memberOf! ()
*
@@ -1349,10 +1187,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.accessLevels.patch
- * @desc Update an Access Level. The longrunning operation from this RPC
- * will have a successful status once the changes to the Access Level have
- * propagated to long-lasting storage. Access Levels containing errors will
- * result in an error response for the first error encountered.
+ * @desc Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.accessLevels.patch
* @memberOf! ()
*
@@ -1433,8 +1268,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the access policy which owns this Access
- * Level. Format: `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy which owns this Access Level. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
@@ -1451,8 +1285,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the Access Level. Format:
- * `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
+ * Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
*/
name?: string;
}
@@ -1464,17 +1297,11 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to return `BasicLevels` in the Cloud Common Expression Language
- * rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels
- * are returned as `BasicLevels` or `CustomLevels` based on how they were
- * created. If set to CEL, all Access Levels are returned as `CustomLevels`.
- * In the CEL case, `BasicLevels` are translated to equivalent
- * `CustomLevels`.
+ * Whether to return `BasicLevels` in the Cloud Common Expression Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels are returned as `BasicLevels` or `CustomLevels` based on how they were created. If set to CEL, all Access Levels are returned as `CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent `CustomLevels`.
*/
accessLevelFormat?: string;
/**
- * Required. Resource name for the Access Level. Format:
- * `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
+ * Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
*/
name?: string;
}
@@ -1486,9 +1313,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to return `BasicLevels` in the Cloud Common Expression language,
- * as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning
- * `AccessLevels` in the format they were defined.
+ * Whether to return `BasicLevels` in the Cloud Common Expression language, as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning `AccessLevels` in the format they were defined.
*/
accessLevelFormat?: string;
/**
@@ -1496,13 +1321,11 @@ export namespace accesscontextmanager_v1 {
*/
pageSize?: number;
/**
- * Next page token for the next batch of Access Level instances. Defaults to
- * the first page of results.
+ * Next page token for the next batch of Access Level instances. Defaults to the first page of results.
*/
pageToken?: string;
/**
- * Required. Resource name for the access policy to list Access Levels from.
- * Format: `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy to list Access Levels from. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
}
@@ -1514,9 +1337,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the Access Level. The `short_name` component
- * must begin with a letter and only include alphanumeric and '_'. Format:
- * `accessPolicies/{policy_id}/accessLevels/{short_name}`
+ * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`
*/
name?: string;
/**
@@ -1538,10 +1359,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.servicePerimeters.create
- * @desc Create an Service Perimeter. The longrunning operation from this
- * RPC will have a successful status once the Service Perimeter has
- * propagated to long-lasting storage. Service Perimeters containing errors
- * will result in an error response for the first error encountered.
+ * @desc Create an Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.create
* @memberOf! ()
*
@@ -1617,9 +1435,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.servicePerimeters.delete
- * @desc Delete an Service Perimeter by resource name. The longrunning
- * operation from this RPC will have a successful status once the Service
- * Perimeter has been removed from long-lasting storage.
+ * @desc Delete an Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.delete
* @memberOf! ()
*
@@ -1849,11 +1665,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.accessPolicies.servicePerimeters.patch
- * @desc Update an Service Perimeter. The longrunning operation from this
- * RPC will have a successful status once the changes to the Service
- * Perimeter have propagated to long-lasting storage. Service Perimeter
- * containing errors will result in an error response for the first error
- * encountered.
+ * @desc Update an Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.patch
* @memberOf! ()
*
@@ -1934,8 +1746,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the access policy which owns this Service
- * Perimeter. Format: `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy which owns this Service Perimeter. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
@@ -1952,8 +1763,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the Service Perimeter. Format:
- * `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}`
+ * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}`
*/
name?: string;
}
@@ -1965,8 +1775,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the Service Perimeter. Format:
- * `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}`
+ * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}`
*/
name?: string;
}
@@ -1982,13 +1791,11 @@ export namespace accesscontextmanager_v1 {
*/
pageSize?: number;
/**
- * Next page token for the next batch of Service Perimeter instances.
- * Defaults to the first page of results.
+ * Next page token for the next batch of Service Perimeter instances. Defaults to the first page of results.
*/
pageToken?: string;
/**
- * Required. Resource name for the access policy to list Service Perimeters
- * from. Format: `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy to list Service Perimeters from. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
}
@@ -2000,9 +1807,7 @@ export namespace accesscontextmanager_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the ServicePerimeter. The `short_name`
- * component must begin with a letter and only include alphanumeric and '_'.
- * Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
*/
name?: string;
/**
@@ -2024,15 +1829,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.operations.cancel
- * @desc Starts asynchronous cancellation on a long-running operation. The
- * server makes a best effort to cancel the operation, but success is not
- * guaranteed. If the server doesn't support this method, it returns
- * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
- * or other methods to check whether the cancellation succeeded or whether
- * the operation completed despite cancellation. On successful cancellation,
- * the operation is not deleted; instead, it becomes an operation with an
- * Operation.error value with a google.rpc.Status.code of 1, corresponding
- * to `Code.CANCELLED`.
+ * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* @alias accesscontextmanager.operations.cancel
* @memberOf! ()
*
@@ -2103,10 +1900,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.operations.delete
- * @desc Deletes a long-running operation. This method indicates that the
- * client is no longer interested in the operation result. It does not
- * cancel the operation. If the server doesn't support this method, it
- * returns `google.rpc.Code.UNIMPLEMENTED`.
+ * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
* @alias accesscontextmanager.operations.delete
* @memberOf! ()
*
@@ -2176,9 +1970,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.operations.get
- * @desc Gets the latest state of a long-running operation. Clients can use
- * this method to poll the operation result at intervals as recommended by
- * the API service.
+ * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias accesscontextmanager.operations.get
* @memberOf! ()
*
@@ -2249,15 +2041,7 @@ export namespace accesscontextmanager_v1 {
/**
* accesscontextmanager.operations.list
- * @desc Lists operations that match the specified filter in the request. If
- * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE:
- * the `name` binding allows API services to override the binding to use
- * different resource name schemes, such as `users/x/operations`. To
- * override the binding, API services can add a binding such as
- * `"/v1/{name=users/x}/operations"` to their service configuration. For
- * backwards compatibility, the default name includes the operations
- * collection id, however overriding users must ensure the name binding is
- * the parent resource, without the operations collection id.
+ * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @alias accesscontextmanager.operations.list
* @memberOf! ()
*
diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts
index 495f898d74d..73b3cb041dd 100644
--- a/src/apis/accesscontextmanager/v1beta.ts
+++ b/src/apis/accesscontextmanager/v1beta.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace accesscontextmanager_v1beta {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace accesscontextmanager_v1beta {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace accesscontextmanager_v1beta {
/**
* Access Context Manager API
*
- * An API for setting attribute based access control to requests to GCP
- * services.
+ * An API for setting attribute based access control to requests to GCP services.
*
* @example
* const {google} = require('googleapis');
@@ -114,7 +109,10 @@ export namespace accesscontextmanager_v1beta {
operations: Resource$Operations;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.accessPolicies = new Resource$Accesspolicies(this.context);
this.operations = new Resource$Operations(this.context);
@@ -122,9 +120,7 @@ export namespace accesscontextmanager_v1beta {
}
/**
- * An `AccessLevel` is a label that can be applied to requests to GCP
- * services, along with a list of requirements necessary for the label to be
- * applied.
+ * An `AccessLevel` is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied.
*/
export interface Schema$AccessLevel {
/**
@@ -140,9 +136,7 @@ export namespace accesscontextmanager_v1beta {
*/
description?: string;
/**
- * Required. Resource name for the Access Level. The `short_name` component
- * must begin with a letter and only include alphanumeric and '_'.
- * Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`
+ * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`
*/
name?: string;
/**
@@ -155,11 +149,7 @@ export namespace accesscontextmanager_v1beta {
updateTime?: string;
}
/**
- * `AccessPolicy` is a container for `AccessLevels` (which define the
- * necessary attributes to use GCP services) and `ServicePerimeters` (which
- * define regions of services able to freely pass data within a perimeter). An
- * access policy is globally visible within an organization, and the
- * restrictions it specifies apply to all projects within an organization.
+ * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.
*/
export interface Schema$AccessPolicy {
/**
@@ -167,14 +157,11 @@ export namespace accesscontextmanager_v1beta {
*/
createTime?: string;
/**
- * Output only. Resource name of the `AccessPolicy`. Format:
- * `accessPolicies/{policy_id}`
+ * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`
*/
name?: string;
/**
- * Required. The parent of this `AccessPolicy` in the Cloud Resource
- * Hierarchy. Currently immutable once created. Format:
- * `organizations/{organization_id}`
+ * Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`
*/
parent?: string;
/**
@@ -191,11 +178,7 @@ export namespace accesscontextmanager_v1beta {
*/
export interface Schema$BasicLevel {
/**
- * How the `conditions` list should be combined to determine if a request is
- * granted this `AccessLevel`. If AND is used, each `Condition` in
- * `conditions` must be satisfied for the `AccessLevel` to be applied. If OR
- * is used, at least one `Condition` in `conditions` must be satisfied for
- * the `AccessLevel` to be applied. Default behavior is AND.
+ * How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND.
*/
combiningFunction?: string;
/**
@@ -204,72 +187,40 @@ export namespace accesscontextmanager_v1beta {
conditions?: Schema$Condition[];
}
/**
- * A condition necessary for an `AccessLevel` to be granted. The Condition is
- * an AND over its fields. So a Condition is true if: 1) the request IP is
- * from one of the listed subnetworks AND 2) the originating device complies
- * with the listed device policy AND 3) all listed access levels are granted
- * AND 4) the request was sent at a time allowed by the DateTimeRestriction.
+ * A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.
*/
export interface Schema$Condition {
/**
- * Device specific restrictions, all restrictions must hold for the
- * Condition to be true. If not specified, all devices are allowed.
+ * Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.
*/
devicePolicy?: Schema$DevicePolicy;
/**
- * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that
- * for a CIDR IP address block, the specified IP address portion must be
- * properly truncated (i.e. all the host bits must be zero) or the input is
- * considered malformed. For example, "192.0.2.0/24" is accepted
- * but "192.0.2.1/24" is not. Similarly, for IPv6,
- * "2001:db8::/32" is accepted whereas "2001:db8::1/32"
- * is not. The originating IP of a request must be in one of the listed
- * subnets in order for this Condition to be true. If empty, all IP
- * addresses are allowed.
+ * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.
*/
ipSubnetworks?: string[];
/**
- * The request must be made by one of the provided user or service accounts.
- * Groups are not supported. Syntax: `user:{emailid}`
- * `serviceAccount:{emailid}` If not specified, a request may come from any
- * user.
+ * The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user.
*/
members?: string[];
/**
- * Whether to negate the Condition. If true, the Condition becomes a NAND
- * over its non-empty fields, each field must be false for the Condition
- * overall to be satisfied. Defaults to false.
+ * Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.
*/
negate?: boolean;
/**
- * The request must originate from one of the provided countries/regions.
- * Must be valid ISO 3166-1 alpha-2 codes.
+ * The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.
*/
regions?: string[];
/**
- * A list of other access levels defined in the same `Policy`, referenced by
- * resource name. Referencing an `AccessLevel` which does not exist is an
- * error. All access levels listed must be granted for the Condition to be
- * true. Example:
- * "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`
+ * A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`
*/
requiredAccessLevels?: string[];
}
/**
- * `DevicePolicy` specifies device specific restrictions necessary to acquire
- * a given access level. A `DevicePolicy` specifies requirements for requests
- * from devices to be granted access levels, it does not do any enforcement on
- * the device. `DevicePolicy` acts as an AND over all specified fields, and
- * each repeated field is an OR over its elements. Any unset fields are
- * ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type
- * : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will
- * be true for requests originating from encrypted Linux desktops and
- * encrypted Windows desktops.
+ * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops.
*/
export interface Schema$DevicePolicy {
/**
- * Allowed device management levels, an empty list allows all management
- * levels.
+ * Allowed device management levels, an empty list allows all management levels.
*/
allowedDeviceManagementLevels?: string[];
/**
@@ -289,8 +240,7 @@ export namespace accesscontextmanager_v1beta {
*/
requireCorpOwned?: boolean;
/**
- * Whether or not screenlock is required for the DevicePolicy to be true.
- * Defaults to `false`.
+ * Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.
*/
requireScreenlock?: boolean;
}
@@ -303,8 +253,7 @@ export namespace accesscontextmanager_v1beta {
*/
accessLevels?: Schema$AccessLevel[];
/**
- * The pagination token to retrieve the next page of results. If the value
- * is empty, no further results remain.
+ * The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
*/
nextPageToken?: string;
}
@@ -317,8 +266,7 @@ export namespace accesscontextmanager_v1beta {
*/
accessPolicies?: Schema$AccessPolicy[];
/**
- * The pagination token to retrieve the next page of results. If the value
- * is empty, no further results remain.
+ * The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
*/
nextPageToken?: string;
}
@@ -327,8 +275,7 @@ export namespace accesscontextmanager_v1beta {
*/
export interface Schema$ListServicePerimetersResponse {
/**
- * The pagination token to retrieve the next page of results. If the value
- * is empty, no further results remain.
+ * The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
*/
nextPageToken?: string;
/**
@@ -337,14 +284,11 @@ export namespace accesscontextmanager_v1beta {
servicePerimeters?: Schema$ServicePerimeter[];
}
/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
+ * This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
- * If the value is `false`, it means the operation is still in progress. If
- * `true`, the operation is completed, and either `error` or `response` is
- * available.
+ * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean;
/**
@@ -352,26 +296,15 @@ export namespace accesscontextmanager_v1beta {
*/
error?: Schema$Status;
/**
- * Service-specific metadata associated with the operation. It typically
- * contains progress information and common metadata such as create time.
- * Some services might not provide such metadata. Any method that returns a
- * long-running operation should document the metadata type, if any.
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any};
/**
- * The server-assigned name, which is only unique within the same service
- * that originally returns it. If you use the default HTTP mapping, the
- * `name` should have the format of `operations/some/unique/name`.
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
*/
name?: string;
/**
- * The normal response of the operation in case of success. If the original
- * method returns no data on success, such as `Delete`, the response is
- * `google.protobuf.Empty`. If the original method is standard
- * `Get`/`Create`/`Update`, the response should be the resource. For other
- * methods, the response should have the type `XxxResponse`, where `Xxx` is
- * the original method name. For example, if the original method name is
- * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {[key: string]: any};
}
@@ -380,9 +313,7 @@ export namespace accesscontextmanager_v1beta {
*/
export interface Schema$OsConstraint {
/**
- * The minimum allowed OS version. If not set, any version of this OS
- * satisfies the constraint. Format: `"major.minor.patch"`.
- * Examples: `"10.5.301"`, `"9.2.1"`.
+ * The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`.
*/
minimumVersion?: string;
/**
@@ -390,24 +321,12 @@ export namespace accesscontextmanager_v1beta {
*/
osType?: string;
/**
- * Only allows requests from devices with a verified Chrome OS.
- * Verifications includes requirements that the device is
- * enterprise-managed, conformant to Dasher domain policies, and the caller
- * has permission to call the API targeted by the request.
+ * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request.
*/
requireVerifiedChromeOs?: boolean;
}
/**
- * `ServicePerimeter` describes a set of GCP resources which can freely import
- * and export data amongst themselves, but not export outside of the
- * `ServicePerimeter`. If a request with a source within this
- * `ServicePerimeter` has a target outside of the `ServicePerimeter`, the
- * request will be blocked. Otherwise the request is allowed. There are two
- * types of Service Perimeter - Regular and Bridge. Regular Service Perimeters
- * cannot overlap, a single GCP project can only belong to a single regular
- * Service Perimeter. Service Perimeter Bridges can contain only GCP projects
- * as members, a single GCP project may belong to multiple Service Perimeter
- * Bridges.
+ * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges.
*/
export interface Schema$ServicePerimeter {
/**
@@ -415,29 +334,19 @@ export namespace accesscontextmanager_v1beta {
*/
createTime?: string;
/**
- * Description of the `ServicePerimeter` and its use. Does not affect
- * behavior.
+ * Description of the `ServicePerimeter` and its use. Does not affect behavior.
*/
description?: string;
/**
- * Required. Resource name for the ServicePerimeter. The `short_name`
- * component must begin with a letter and only include alphanumeric and
- * '_'. Format:
- * `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
*/
name?: string;
/**
- * Perimeter type indicator. A single project is allowed to be a member of
- * single regular perimeter, but multiple service perimeter bridges. A
- * project cannot be a included in a perimeter bridge without being included
- * in regular perimeter. For perimeter bridges, restricted/unrestricted
- * service lists as well as access lists must be empty.
+ * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty.
*/
perimeterType?: string;
/**
- * Current ServicePerimeter configuration. Specifies sets of resources,
- * restricted/unrestricted services and access levels that determine
- * perimeter content and boundaries.
+ * Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries.
*/
status?: Schema$ServicePerimeterConfig;
/**
@@ -450,76 +359,28 @@ export namespace accesscontextmanager_v1beta {
updateTime?: string;
}
/**
- * `ServicePerimeterConfig` specifies a set of GCP resources that describe
- * specific Service Perimeter configuration.
+ * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration.
*/
export interface Schema$ServicePerimeterConfig {
/**
- * A list of `AccessLevel` resource names that allow resources within the
- * `ServicePerimeter` to be accessed from the internet. `AccessLevels`
- * listed must be in the same policy as this `ServicePerimeter`. Referencing
- * a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names
- * are listed, resources within the perimeter can only be accessed via GCP
- * calls with request origins within the perimeter. Example:
- * `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service
- * Perimeter Bridge, must be empty.
+ * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty.
*/
accessLevels?: string[];
/**
- * A list of GCP resources that are inside of the service perimeter.
- * Currently only projects are allowed. Format: `projects/{project_number}`
+ * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}`
*/
resources?: string[];
/**
- * GCP services that are subject to the Service Perimeter restrictions. Must
- * contain a list of services. For example, if `storage.googleapis.com` is
- * specified, access to the storage buckets inside the perimeter must meet
- * the perimeter's access restrictions.
+ * GCP services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.
*/
restrictedServices?: string[];
/**
- * GCP services that are not subject to the Service Perimeter restrictions.
- * Deprecated. Must be set to a single wildcard "*". The wildcard
- * means that unless explicitly specified by "restricted_services"
- * list, any service is treated as unrestricted.
+ * GCP services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.
*/
unrestrictedServices?: string[];
}
/**
- * The `Status` type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by [gRPC](https://github.com/grpc). The error model is designed to be:
- * - Simple to use and understand for most users - Flexible enough to meet
- * unexpected needs # Overview The `Status` message contains three pieces of
- * data: error code, error message, and error details. The error code should
- * be an enum value of google.rpc.Code, but it may accept additional error
- * codes if needed. The error message should be a developer-facing English
- * message that helps developers *understand* and *resolve* the error. If a
- * localized user-facing error message is needed, put the localized message in
- * the error details or localize it in the client. The optional error details
- * may contain arbitrary information about the error. There is a predefined
- * set of error detail types in the package `google.rpc` that can be used for
- * common error conditions. # Language mapping The `Status` message is the
- * logical representation of the error model, but it is not necessarily the
- * actual wire format. When the `Status` message is exposed in different
- * client libraries and different wire protocols, it can be mapped
- * differently. For example, it will likely be mapped to some exceptions in
- * Java, but more likely mapped to some error codes in C. # Other uses The
- * error model and the `Status` message can be used in a variety of
- * environments, either with or without APIs, to provide a consistent
- * developer experience across different environments. Example uses of this
- * error model include: - Partial errors. If a service needs to return
- * partial errors to the client, it may embed the `Status` in the normal
- * response to indicate the partial errors. - Workflow errors. A typical
- * workflow has multiple steps. Each step may have a `Status` message for
- * error reporting. - Batch operations. If a client uses batch request and
- * batch response, the `Status` message should be used directly inside
- * batch response, one for each error sub-response. - Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the `Status` message. - Logging. If some API errors are stored in
- * logs, the message `Status` could be used directly after any stripping
- * needed for security/privacy reasons.
+ * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -527,14 +388,11 @@ export namespace accesscontextmanager_v1beta {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set
- * of message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
@@ -555,11 +413,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.create
- * @desc Create an `AccessPolicy`. Fails if this organization already has a
- * `AccessPolicy`. The longrunning Operation will have a successful status
- * once the `AccessPolicy` has propagated to long-lasting storage. Syntactic
- * and basic semantic errors will be returned in `metadata` as a BadRequest
- * proto.
+ * @desc Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.
* @alias accesscontextmanager.accessPolicies.create
* @memberOf! ()
*
@@ -634,9 +488,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.delete
- * @desc Delete an AccessPolicy by resource name. The longrunning Operation
- * will have a successful status once the AccessPolicy has been removed from
- * long-lasting storage.
+ * @desc Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.
* @alias accesscontextmanager.accessPolicies.delete
* @memberOf! ()
*
@@ -864,10 +716,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.patch
- * @desc Update an AccessPolicy. The longrunning Operation from this RPC
- * will have a successful status once the changes to the AccessPolicy have
- * propagated to long-lasting storage. Syntactic and basic semantic errors
- * will be returned in `metadata` as a BadRequest proto.
+ * @desc Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.
* @alias accesscontextmanager.accessPolicies.patch
* @memberOf! ()
*
@@ -960,8 +809,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the access policy to delete. Format
- * `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy to delete. Format `accessPolicies/{policy_id}`
*/
name?: string;
}
@@ -973,8 +821,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the access policy to get. Format
- * `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy to get. Format `accessPolicies/{policy_id}`
*/
name?: string;
}
@@ -990,13 +837,11 @@ export namespace accesscontextmanager_v1beta {
*/
pageSize?: number;
/**
- * Next page token for the next batch of AccessPolicy instances. Defaults to
- * the first page of results.
+ * Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results.
*/
pageToken?: string;
/**
- * Required. Resource name for the container to list AccessPolicy instances
- * from. Format: `organizations/{org_id}`
+ * Required. Resource name for the container to list AccessPolicy instances from. Format: `organizations/{org_id}`
*/
parent?: string;
}
@@ -1008,8 +853,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Output only. Resource name of the `AccessPolicy`. Format:
- * `accessPolicies/{policy_id}`
+ * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`
*/
name?: string;
/**
@@ -1031,10 +875,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.accessLevels.create
- * @desc Create an Access Level. The longrunning operation from this RPC
- * will have a successful status once the Access Level has propagated to
- * long-lasting storage. Access Levels containing errors will result in an
- * error response for the first error encountered.
+ * @desc Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.accessLevels.create
* @memberOf! ()
*
@@ -1110,9 +951,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.accessLevels.delete
- * @desc Delete an Access Level by resource name. The longrunning operation
- * from this RPC will have a successful status once the Access Level has
- * been removed from long-lasting storage.
+ * @desc Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.
* @alias accesscontextmanager.accessPolicies.accessLevels.delete
* @memberOf! ()
*
@@ -1337,10 +1176,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.accessLevels.patch
- * @desc Update an Access Level. The longrunning operation from this RPC
- * will have a successful status once the changes to the Access Level have
- * propagated to long-lasting storage. Access Levels containing errors will
- * result in an error response for the first error encountered.
+ * @desc Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.accessLevels.patch
* @memberOf! ()
*
@@ -1421,8 +1257,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the access policy which owns this Access
- * Level. Format: `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy which owns this Access Level. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
@@ -1439,8 +1274,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the Access Level. Format:
- * `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
+ * Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
*/
name?: string;
}
@@ -1452,17 +1286,11 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to return `BasicLevels` in the Cloud Common Expression Language
- * rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels
- * are returned as `BasicLevels` or `CustomLevels` based on how they were
- * created. If set to CEL, all Access Levels are returned as `CustomLevels`.
- * In the CEL case, `BasicLevels` are translated to equivalent
- * `CustomLevels`.
+ * Whether to return `BasicLevels` in the Cloud Common Expression Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels are returned as `BasicLevels` or `CustomLevels` based on how they were created. If set to CEL, all Access Levels are returned as `CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent `CustomLevels`.
*/
accessLevelFormat?: string;
/**
- * Required. Resource name for the Access Level. Format:
- * `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
+ * Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
*/
name?: string;
}
@@ -1474,9 +1302,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to return `BasicLevels` in the Cloud Common Expression language,
- * as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning
- * `AccessLevels` in the format they were defined.
+ * Whether to return `BasicLevels` in the Cloud Common Expression language, as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning `AccessLevels` in the format they were defined.
*/
accessLevelFormat?: string;
/**
@@ -1484,13 +1310,11 @@ export namespace accesscontextmanager_v1beta {
*/
pageSize?: number;
/**
- * Next page token for the next batch of Access Level instances. Defaults to
- * the first page of results.
+ * Next page token for the next batch of Access Level instances. Defaults to the first page of results.
*/
pageToken?: string;
/**
- * Required. Resource name for the access policy to list Access Levels from.
- * Format: `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy to list Access Levels from. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
}
@@ -1502,9 +1326,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the Access Level. The `short_name` component
- * must begin with a letter and only include alphanumeric and '_'. Format:
- * `accessPolicies/{policy_id}/accessLevels/{short_name}`
+ * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`
*/
name?: string;
/**
@@ -1526,10 +1348,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.servicePerimeters.create
- * @desc Create an Service Perimeter. The longrunning operation from this
- * RPC will have a successful status once the Service Perimeter has
- * propagated to long-lasting storage. Service Perimeters containing errors
- * will result in an error response for the first error encountered.
+ * @desc Create an Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.create
* @memberOf! ()
*
@@ -1605,9 +1424,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.servicePerimeters.delete
- * @desc Delete an Service Perimeter by resource name. The longrunning
- * operation from this RPC will have a successful status once the Service
- * Perimeter has been removed from long-lasting storage.
+ * @desc Delete an Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.delete
* @memberOf! ()
*
@@ -1837,11 +1654,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.accessPolicies.servicePerimeters.patch
- * @desc Update an Service Perimeter. The longrunning operation from this
- * RPC will have a successful status once the changes to the Service
- * Perimeter have propagated to long-lasting storage. Service Perimeter
- * containing errors will result in an error response for the first error
- * encountered.
+ * @desc Update an Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.patch
* @memberOf! ()
*
@@ -1922,8 +1735,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the access policy which owns this Service
- * Perimeter. Format: `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy which owns this Service Perimeter. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
@@ -1940,8 +1752,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the Service Perimeter. Format:
- * `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}`
+ * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}`
*/
name?: string;
}
@@ -1953,8 +1764,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the Service Perimeter. Format:
- * `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}`
+ * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}`
*/
name?: string;
}
@@ -1970,13 +1780,11 @@ export namespace accesscontextmanager_v1beta {
*/
pageSize?: number;
/**
- * Next page token for the next batch of Service Perimeter instances.
- * Defaults to the first page of results.
+ * Next page token for the next batch of Service Perimeter instances. Defaults to the first page of results.
*/
pageToken?: string;
/**
- * Required. Resource name for the access policy to list Service Perimeters
- * from. Format: `accessPolicies/{policy_id}`
+ * Required. Resource name for the access policy to list Service Perimeters from. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
}
@@ -1988,9 +1796,7 @@ export namespace accesscontextmanager_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name for the ServicePerimeter. The `short_name`
- * component must begin with a letter and only include alphanumeric and '_'.
- * Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
*/
name?: string;
/**
@@ -2012,9 +1818,7 @@ export namespace accesscontextmanager_v1beta {
/**
* accesscontextmanager.operations.get
- * @desc Gets the latest state of a long-running operation. Clients can use
- * this method to poll the operation result at intervals as recommended by
- * the API service.
+ * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias accesscontextmanager.operations.get
* @memberOf! ()
*
diff --git a/src/apis/adexchangebuyer/package.json b/src/apis/adexchangebuyer/package.json
index fa1b556fc66..18509ea6ea9 100644
--- a/src/apis/adexchangebuyer/package.json
+++ b/src/apis/adexchangebuyer/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/adexchangebuyer/v1.2.ts b/src/apis/adexchangebuyer/v1.2.ts
index 11679300010..fe9fa6653a1 100644
--- a/src/apis/adexchangebuyer/v1.2.ts
+++ b/src/apis/adexchangebuyer/v1.2.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace adexchangebuyer_v1_2 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace adexchangebuyer_v1_2 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -78,9 +75,7 @@ export namespace adexchangebuyer_v1_2 {
/**
* Ad Exchange Buyer API
*
- * Accesses your bidding-account information, submits creatives for
- * validation, finds available direct deals, and retrieves performance
- * reports.
+ * Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.
*
* @example
* const {google} = require('googleapis');
@@ -98,7 +93,10 @@ export namespace adexchangebuyer_v1_2 {
creatives: Resource$Creatives;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.accounts = new Resource$Accounts(this.context);
this.creatives = new Resource$Creatives(this.context);
@@ -118,8 +116,7 @@ export namespace adexchangebuyer_v1_2 {
url?: string;
}>;
/**
- * The nid parameter value used in cookie match requests. Please contact
- * your technical account manager if you need to change this.
+ * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
*/
cookieMatchingNid?: string;
/**
@@ -135,25 +132,20 @@ export namespace adexchangebuyer_v1_2 {
*/
kind?: string;
/**
- * The maximum number of active creatives that an account can have, where a
- * creative is active if it was inserted or bid with in the last 30 days.
- * Please contact your technical account manager if you need to change this.
+ * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
*/
maximumActiveCreatives?: number;
/**
- * The sum of all bidderLocation.maximumQps values cannot exceed this.
- * Please contact your technical account manager if you need to change this.
+ * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
*/
maximumTotalQps?: number;
/**
- * The number of creatives that this account inserted or bid with in the
- * last 30 days.
+ * The number of creatives that this account inserted or bid with in the last 30 days.
*/
numberActiveCreatives?: number;
}
/**
- * An account feed lists Ad Exchange buyer accounts that the user has access
- * to. Each entry in the feed corresponds to a single buyer account.
+ * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
*/
export interface Schema$AccountsList {
/**
@@ -174,8 +166,7 @@ export namespace adexchangebuyer_v1_2 {
*/
accountId?: number;
/**
- * Detected advertiser id, if any. Read-only. This field should not be set
- * in requests.
+ * Detected advertiser id, if any. Read-only. This field should not be set in requests.
*/
advertiserId?: string[];
/**
@@ -187,9 +178,7 @@ export namespace adexchangebuyer_v1_2 {
*/
agencyId?: string;
/**
- * The last upload timestamp of this creative if it was uploaded via API.
- * Read-only. The value of this field is generated, and will be ignored for
- * uploads. (formatted RFC 3339 timestamp).
+ * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
*/
apiUploadTimestamp?: string;
/**
@@ -205,21 +194,15 @@ export namespace adexchangebuyer_v1_2 {
*/
clickThroughUrl?: string[];
/**
- * Shows any corrections that were applied to this creative. Read-only. This
- * field should not be set in requests.
+ * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
*/
corrections?: Array<{details?: string[]; reason?: string}>;
/**
- * The reasons for disapproval, if any. Note that not all disapproval
- * reasons may be categorized, so it is possible for the creative to have a
- * status of DISAPPROVED with an empty list for disapproval_reasons. In this
- * case, please reach out to your TAM to help debug the issue. Read-only.
- * This field should not be set in requests.
+ * The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
*/
disapprovalReasons?: Array<{details?: string[]; reason?: string}>;
/**
- * The filtering reasons for the creative. Read-only. This field should not
- * be set in requests.
+ * The filtering reasons for the creative. Read-only. This field should not be set in requests.
*/
filteringReasons?: {
date?: string;
@@ -230,8 +213,7 @@ export namespace adexchangebuyer_v1_2 {
*/
height?: number;
/**
- * The HTML snippet that displays the ad when inserted in the web page. If
- * set, videoURL should not be set.
+ * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
*/
HTMLSnippet?: string;
/**
@@ -243,23 +225,19 @@ export namespace adexchangebuyer_v1_2 {
*/
kind?: string;
/**
- * Detected product categories, if any. Read-only. This field should not be
- * set in requests.
+ * Detected product categories, if any. Read-only. This field should not be set in requests.
*/
productCategories?: number[];
/**
- * All restricted categories for the ads that may be shown from this
- * snippet.
+ * All restricted categories for the ads that may be shown from this snippet.
*/
restrictedCategories?: number[];
/**
- * Detected sensitive categories, if any. Read-only. This field should not
- * be set in requests.
+ * Detected sensitive categories, if any. Read-only. This field should not be set in requests.
*/
sensitiveCategories?: number[];
/**
- * Creative serving status. Read-only. This field should not be set in
- * requests.
+ * Creative serving status. Read-only. This field should not be set in requests.
*/
status?: string;
/**
@@ -267,8 +245,7 @@ export namespace adexchangebuyer_v1_2 {
*/
vendorType?: number[];
/**
- * The version for this creative. Read-only. This field should not be set in
- * requests.
+ * The version for this creative. Read-only. This field should not be set in requests.
*/
version?: number;
/**
@@ -281,9 +258,7 @@ export namespace adexchangebuyer_v1_2 {
width?: number;
}
/**
- * The creatives feed lists the active creatives for the Ad Exchange buyer
- * accounts that the user has access to. Each entry in the feed corresponds to
- * a single creative.
+ * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
*/
export interface Schema$CreativesList {
/**
@@ -295,9 +270,7 @@ export namespace adexchangebuyer_v1_2 {
*/
kind?: string;
/**
- * Continuation token used to page through creatives. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -654,8 +627,7 @@ export namespace adexchangebuyer_v1_2 {
/**
* adexchangebuyer.creatives.get
- * @desc Gets the status for a single creative. A creative will be available
- * 30-40 minutes after submission.
+ * @desc Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
* @alias adexchangebuyer.creatives.get
* @memberOf! ()
*
@@ -798,8 +770,7 @@ export namespace adexchangebuyer_v1_2 {
/**
* adexchangebuyer.creatives.list
- * @desc Retrieves a list of the authenticated user's active creatives. A
- * creative will be available 30-40 minutes after submission.
+ * @desc Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
* @alias adexchangebuyer.creatives.list
* @memberOf! ()
*
@@ -906,14 +877,11 @@ export namespace adexchangebuyer_v1_2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Maximum number of entries returned on one result page. If not set, the
- * default is 100. Optional.
+ * Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad clients. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response. Optional.
+ * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
*/
pageToken?: string;
/**
diff --git a/src/apis/adexchangebuyer/v1.3.ts b/src/apis/adexchangebuyer/v1.3.ts
index a3aa2a664db..08e9d4845ea 100644
--- a/src/apis/adexchangebuyer/v1.3.ts
+++ b/src/apis/adexchangebuyer/v1.3.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace adexchangebuyer_v1_3 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace adexchangebuyer_v1_3 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -78,9 +75,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* Ad Exchange Buyer API
*
- * Accesses your bidding-account information, submits creatives for
- * validation, finds available direct deals, and retrieves performance
- * reports.
+ * Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.
*
* @example
* const {google} = require('googleapis');
@@ -103,7 +98,10 @@ export namespace adexchangebuyer_v1_3 {
pretargetingConfig: Resource$Pretargetingconfig;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.accounts = new Resource$Accounts(this.context);
this.billingInfo = new Resource$Billinginfo(this.context);
@@ -128,8 +126,7 @@ export namespace adexchangebuyer_v1_3 {
url?: string;
}>;
/**
- * The nid parameter value used in cookie match requests. Please contact
- * your technical account manager if you need to change this.
+ * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
*/
cookieMatchingNid?: string;
/**
@@ -145,25 +142,20 @@ export namespace adexchangebuyer_v1_3 {
*/
kind?: string;
/**
- * The maximum number of active creatives that an account can have, where a
- * creative is active if it was inserted or bid with in the last 30 days.
- * Please contact your technical account manager if you need to change this.
+ * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
*/
maximumActiveCreatives?: number;
/**
- * The sum of all bidderLocation.maximumQps values cannot exceed this.
- * Please contact your technical account manager if you need to change this.
+ * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
*/
maximumTotalQps?: number;
/**
- * The number of creatives that this account inserted or bid with in the
- * last 30 days.
+ * The number of creatives that this account inserted or bid with in the last 30 days.
*/
numberActiveCreatives?: number;
}
/**
- * An account feed lists Ad Exchange buyer accounts that the user has access
- * to. Each entry in the feed corresponds to a single buyer account.
+ * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
*/
export interface Schema$AccountsList {
/**
@@ -188,9 +180,7 @@ export namespace adexchangebuyer_v1_3 {
*/
accountName?: string;
/**
- * A list of adgroup IDs associated with this particular account. These IDs
- * may show up as part of a realtime bidding BidRequest, which indicates a
- * bid request for this account.
+ * A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.
*/
billingId?: string[];
/**
@@ -199,8 +189,7 @@ export namespace adexchangebuyer_v1_3 {
kind?: string;
}
/**
- * A billing info feed lists Billing Info the Ad Exchange buyer account has
- * access to. Each entry in the feed corresponds to a single billing info.
+ * A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.
*/
export interface Schema$BillingInfoList {
/**
@@ -221,13 +210,11 @@ export namespace adexchangebuyer_v1_3 {
*/
accountId?: string;
/**
- * The billing id to determine which adgroup to provide budget information
- * for. This is required for get and update requests.
+ * The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
*/
billingId?: string;
/**
- * The daily budget amount in unit amount of the account currency to apply
- * for the billingId provided. This is required for update requests.
+ * The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
*/
budgetAmount?: string;
/**
@@ -252,8 +239,7 @@ export namespace adexchangebuyer_v1_3 {
*/
accountId?: number;
/**
- * Detected advertiser id, if any. Read-only. This field should not be set
- * in requests.
+ * Detected advertiser id, if any. Read-only. This field should not be set in requests.
*/
advertiserId?: string[];
/**
@@ -265,9 +251,7 @@ export namespace adexchangebuyer_v1_3 {
*/
agencyId?: string;
/**
- * The last upload timestamp of this creative if it was uploaded via API.
- * Read-only. The value of this field is generated, and will be ignored for
- * uploads. (formatted RFC 3339 timestamp).
+ * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
*/
apiUploadTimestamp?: string;
/**
@@ -283,21 +267,15 @@ export namespace adexchangebuyer_v1_3 {
*/
clickThroughUrl?: string[];
/**
- * Shows any corrections that were applied to this creative. Read-only. This
- * field should not be set in requests.
+ * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
*/
corrections?: Array<{details?: string[]; reason?: string}>;
/**
- * The reasons for disapproval, if any. Note that not all disapproval
- * reasons may be categorized, so it is possible for the creative to have a
- * status of DISAPPROVED with an empty list for disapproval_reasons. In this
- * case, please reach out to your TAM to help debug the issue. Read-only.
- * This field should not be set in requests.
+ * The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
*/
disapprovalReasons?: Array<{details?: string[]; reason?: string}>;
/**
- * The filtering reasons for the creative. Read-only. This field should not
- * be set in requests.
+ * The filtering reasons for the creative. Read-only. This field should not be set in requests.
*/
filteringReasons?: {
date?: string;
@@ -308,8 +286,7 @@ export namespace adexchangebuyer_v1_3 {
*/
height?: number;
/**
- * The HTML snippet that displays the ad when inserted in the web page. If
- * set, videoURL should not be set.
+ * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
*/
HTMLSnippet?: string;
/**
@@ -338,23 +315,19 @@ export namespace adexchangebuyer_v1_3 {
store?: string;
};
/**
- * Detected product categories, if any. Read-only. This field should not be
- * set in requests.
+ * Detected product categories, if any. Read-only. This field should not be set in requests.
*/
productCategories?: number[];
/**
- * All restricted categories for the ads that may be shown from this
- * snippet.
+ * All restricted categories for the ads that may be shown from this snippet.
*/
restrictedCategories?: number[];
/**
- * Detected sensitive categories, if any. Read-only. This field should not
- * be set in requests.
+ * Detected sensitive categories, if any. Read-only. This field should not be set in requests.
*/
sensitiveCategories?: number[];
/**
- * Creative serving status. Read-only. This field should not be set in
- * requests.
+ * Creative serving status. Read-only. This field should not be set in requests.
*/
status?: string;
/**
@@ -362,13 +335,11 @@ export namespace adexchangebuyer_v1_3 {
*/
vendorType?: number[];
/**
- * The version for this creative. Read-only. This field should not be set in
- * requests.
+ * The version for this creative. Read-only. This field should not be set in requests.
*/
version?: number;
/**
- * The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should
- * not be set.
+ * The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set.
*/
videoURL?: string;
/**
@@ -377,9 +348,7 @@ export namespace adexchangebuyer_v1_3 {
width?: number;
}
/**
- * The creatives feed lists the active creatives for the Ad Exchange buyer
- * accounts that the user has access to. Each entry in the feed corresponds to
- * a single creative.
+ * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
*/
export interface Schema$CreativesList {
/**
@@ -391,9 +360,7 @@ export namespace adexchangebuyer_v1_3 {
*/
kind?: string;
/**
- * Continuation token used to page through creatives. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -414,13 +381,11 @@ export namespace adexchangebuyer_v1_3 {
*/
allowsAlcohol?: boolean;
/**
- * The account id that this deal was negotiated for. It is either the buyer
- * or the client that this deal was negotiated on behalf of.
+ * The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of.
*/
buyerAccountId?: string;
/**
- * The currency code that applies to the fixed_cpm value. If not set then
- * assumed to be USD.
+ * The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
*/
currencyCode?: string;
/**
@@ -428,16 +393,11 @@ export namespace adexchangebuyer_v1_3 {
*/
dealTier?: string;
/**
- * End time for when this deal stops being active. If not set then this deal
- * is valid until manually disabled by the publisher. In seconds since the
- * epoch.
+ * End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
*/
endTime?: string;
/**
- * The fixed price for this direct deal. In cpm micros of currency according
- * to currency_code. If set, then this deal is eligible for the fixed price
- * tier of buying (highest priority, pay exactly the configured fixed
- * price).
+ * The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
*/
fixedCpm?: string;
/**
@@ -453,15 +413,11 @@ export namespace adexchangebuyer_v1_3 {
*/
name?: string;
/**
- * The minimum price for this direct deal. In cpm micros of currency
- * according to currency_code. If set, then this deal is eligible for the
- * private exchange tier of buying (below fixed price priority, run as a
- * second price auction).
+ * The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
*/
privateExchangeMinCpm?: string;
/**
- * If true, the publisher has opted to have their blocks ignored when a
- * creative is bid with for this deal.
+ * If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal.
*/
publisherBlocksOverriden?: boolean;
/**
@@ -469,15 +425,12 @@ export namespace adexchangebuyer_v1_3 {
*/
sellerNetwork?: string;
/**
- * Start time for when this deal becomes active. If not set then this deal
- * is active immediately upon creation. In seconds since the epoch.
+ * Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
*/
startTime?: string;
}
/**
- * A direct deals feed lists Direct Deals the Ad Exchange buyer account has
- * access to. This includes direct deals set up for the buyer account as well
- * as its merged stream seats.
+ * A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
*/
export interface Schema$DirectDealsList {
/**
@@ -502,8 +455,7 @@ export namespace adexchangebuyer_v1_3 {
*/
bidRequestRate?: number;
/**
- * Rate of various prefiltering statuses per match. Please refer to the
- * callout-status-codes.txt file for different statuses.
+ * Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.
*/
calloutStatusRate?: any[];
/**
@@ -511,13 +463,11 @@ export namespace adexchangebuyer_v1_3 {
*/
cookieMatcherStatusRate?: any[];
/**
- * Rate of ads with a given status. Please refer to the
- * creative-status-codes.txt file for different statuses.
+ * Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.
*/
creativeStatusRate?: any[];
/**
- * The number of bid responses that were filtered due to a policy violation
- * or other errors.
+ * The number of bid responses that were filtered due to a policy violation or other errors.
*/
filteredBidRate?: number;
/**
@@ -533,18 +483,15 @@ export namespace adexchangebuyer_v1_3 {
*/
kind?: string;
/**
- * The 50th percentile round trip latency(ms) as perceived from Google
- * servers for the duration period covered by the report.
+ * The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
*/
latency50thPercentile?: number;
/**
- * The 85th percentile round trip latency(ms) as perceived from Google
- * servers for the duration period covered by the report.
+ * The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
*/
latency85thPercentile?: number;
/**
- * The 95th percentile round trip latency(ms) as perceived from Google
- * servers for the duration period covered by the report.
+ * The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
*/
latency95thPercentile?: number;
/**
@@ -576,8 +523,7 @@ export namespace adexchangebuyer_v1_3 {
*/
region?: string;
/**
- * The number of properly formed bid responses received by our servers
- * within the deadline.
+ * The number of properly formed bid responses received by our servers within the deadline.
*/
successfulRequestRate?: number;
/**
@@ -585,8 +531,7 @@ export namespace adexchangebuyer_v1_3 {
*/
timestamp?: string;
/**
- * The number of bid responses that were unsuccessful due to timeouts,
- * incorrect formatting, etc.
+ * The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.
*/
unsuccessfulRequestRate?: number;
}
@@ -605,13 +550,11 @@ export namespace adexchangebuyer_v1_3 {
}
export interface Schema$PretargetingConfig {
/**
- * The id for billing purposes, provided for reference. Leave this field
- * blank for insert requests; the id will be generated automatically.
+ * The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
*/
billingId?: string;
/**
- * The config id; generated automatically. Leave this field blank for insert
- * requests.
+ * The config id; generated automatically. Leave this field blank for insert requests.
*/
configId?: string;
/**
@@ -619,18 +562,15 @@ export namespace adexchangebuyer_v1_3 {
*/
configName?: string;
/**
- * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or
- * PRETARGETING_CREATIVE_TYPE_VIDEO.
+ * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
*/
creativeType?: string[];
/**
- * Requests which allow one of these (width, height) pairs will match. All
- * pairs must be supported ad dimensions.
+ * Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
*/
dimensions?: Array<{height?: string; width?: string}>;
/**
- * Requests with any of these content labels will not match. Values are from
- * content-labels.txt in the downloadable files section.
+ * Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
*/
excludedContentLabels?: string[];
/**
@@ -646,8 +586,7 @@ export namespace adexchangebuyer_v1_3 {
*/
excludedUserLists?: string[];
/**
- * Requests containing any of these vertical ids will not match. Values are
- * from the publisher-verticals.txt file in the downloadable files section.
+ * Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
*/
excludedVerticals?: string[];
/**
@@ -659,8 +598,7 @@ export namespace adexchangebuyer_v1_3 {
*/
isActive?: boolean;
/**
- * The kind of the resource, i.e.
- * "adexchangebuyer#pretargetingConfig".
+ * The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
*/
kind?: string;
/**
@@ -668,18 +606,15 @@ export namespace adexchangebuyer_v1_3 {
*/
languages?: string[];
/**
- * Requests containing any of these mobile carrier ids will match. Values
- * are from mobile-carriers.csv in the downloadable files section.
+ * Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
*/
mobileCarriers?: string[];
/**
- * Requests containing any of these mobile device ids will match. Values are
- * from mobile-devices.csv in the downloadable files section.
+ * Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
*/
mobileDevices?: string[];
/**
- * Requests containing any of these mobile operating system version ids will
- * match. Values are from mobile-os.csv in the downloadable files section.
+ * Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
*/
mobileOperatingSystemVersions?: string[];
/**
@@ -687,16 +622,11 @@ export namespace adexchangebuyer_v1_3 {
*/
placements?: Array<{token?: string; type?: string}>;
/**
- * Requests matching any of these platforms will match. Possible values are
- * PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and
- * PRETARGETING_PLATFORM_TABLET.
+ * Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
*/
platforms?: string[];
/**
- * Creative attributes should be declared here if all creatives
- * corresponding to this pretargeting configuration have that creative
- * attribute. Values are from pretargetable-creative-attributes.txt in the
- * downloadable files section.
+ * Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
*/
supportedCreativeAttributes?: string[];
/**
@@ -704,8 +634,7 @@ export namespace adexchangebuyer_v1_3 {
*/
userLists?: string[];
/**
- * Requests that allow any of these vendor ids will match. Values are from
- * vendors.txt in the downloadable files section.
+ * Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
*/
vendorTypes?: string[];
/**
@@ -1076,8 +1005,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.billingInfo.get
- * @desc Returns the billing information for one account specified by
- * account ID.
+ * @desc Returns the billing information for one account specified by account ID.
* @alias adexchangebuyer.billingInfo.get
* @memberOf! ()
*
@@ -1149,8 +1077,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.billingInfo.list
- * @desc Retrieves a list of billing information for all accounts of the
- * authenticated user.
+ * @desc Retrieves a list of billing information for all accounts of the authenticated user.
* @alias adexchangebuyer.billingInfo.list
* @memberOf! ()
*
@@ -1247,8 +1174,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.budget.get
- * @desc Returns the budget information for the adgroup specified by the
- * accountId and billingId.
+ * @desc Returns the budget information for the adgroup specified by the accountId and billingId.
* @alias adexchangebuyer.budget.get
* @memberOf! ()
*
@@ -1320,9 +1246,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.budget.patch
- * @desc Updates the budget amount for the budget of the adgroup specified
- * by the accountId and billingId, with the budget amount in the request.
- * This method supports patch semantics.
+ * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.
* @alias adexchangebuyer.budget.patch
* @memberOf! ()
*
@@ -1395,8 +1319,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.budget.update
- * @desc Updates the budget amount for the budget of the adgroup specified
- * by the accountId and billingId, with the budget amount in the request.
+ * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.
* @alias adexchangebuyer.budget.update
* @memberOf! ()
*
@@ -1532,8 +1455,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.creatives.get
- * @desc Gets the status for a single creative. A creative will be available
- * 30-40 minutes after submission.
+ * @desc Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
* @alias adexchangebuyer.creatives.get
* @memberOf! ()
*
@@ -1676,8 +1598,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.creatives.list
- * @desc Retrieves a list of the authenticated user's active creatives. A
- * creative will be available 30-40 minutes after submission.
+ * @desc Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
* @alias adexchangebuyer.creatives.list
* @memberOf! ()
*
@@ -1790,19 +1711,15 @@ export namespace adexchangebuyer_v1_3 {
*/
accountId?: number[];
/**
- * When specified, only creatives for the given buyer creative ids are
- * returned.
+ * When specified, only creatives for the given buyer creative ids are returned.
*/
buyerCreativeId?: string[];
/**
- * Maximum number of entries returned on one result page. If not set, the
- * default is 100. Optional.
+ * Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad clients. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response. Optional.
+ * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
*/
pageToken?: string;
/**
@@ -2084,14 +2001,11 @@ export namespace adexchangebuyer_v1_3 {
*/
endDateTime?: string;
/**
- * Maximum number of entries returned on one result page. If not set, the
- * default is 100. Optional.
+ * Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
*/
maxResults?: number;
/**
- * A continuation token, used to page through performance reports. To
- * retrieve the next page, set this parameter to the value of
- * "nextPageToken" from the previous response. Optional.
+ * A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
*/
pageToken?: string;
/**
@@ -2330,8 +2244,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.pretargetingConfig.list
- * @desc Retrieves a list of the authenticated user's pretargeting
- * configurations.
+ * @desc Retrieves a list of the authenticated user's pretargeting configurations.
* @alias adexchangebuyer.pretargetingConfig.list
* @memberOf! ()
*
@@ -2406,8 +2319,7 @@ export namespace adexchangebuyer_v1_3 {
/**
* adexchangebuyer.pretargetingConfig.patch
- * @desc Updates an existing pretargeting config. This method supports patch
- * semantics.
+ * @desc Updates an existing pretargeting config. This method supports patch semantics.
* @alias adexchangebuyer.pretargetingConfig.patch
* @memberOf! ()
*
diff --git a/src/apis/adexchangebuyer/v1.4.ts b/src/apis/adexchangebuyer/v1.4.ts
index cd09950cd9a..056b4938c5b 100644
--- a/src/apis/adexchangebuyer/v1.4.ts
+++ b/src/apis/adexchangebuyer/v1.4.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace adexchangebuyer_v1_4 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace adexchangebuyer_v1_4 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -78,9 +75,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* Ad Exchange Buyer API
*
- * Accesses your bidding-account information, submits creatives for
- * validation, finds available direct deals, and retrieves performance
- * reports.
+ * Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.
*
* @example
* const {google} = require('googleapis');
@@ -108,7 +103,10 @@ export namespace adexchangebuyer_v1_4 {
pubprofiles: Resource$Pubprofiles;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.accounts = new Resource$Accounts(this.context);
this.billingInfo = new Resource$Billinginfo(this.context);
@@ -132,11 +130,7 @@ export namespace adexchangebuyer_v1_4 {
*/
export interface Schema$Account {
/**
- * When this is false, bid requests that include a deal ID for a private
- * auction or preferred deal are always sent to your bidder. When true, all
- * active pretargeting configs will be applied to private auctions and
- * preferred deals. Programmatic Guaranteed deals (when enabled) are always
- * sent to your bidder.
+ * When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder.
*/
applyPretargetingToNonGuaranteedDeals?: boolean;
/**
@@ -149,8 +143,7 @@ export namespace adexchangebuyer_v1_4 {
url?: string;
}>;
/**
- * The nid parameter value used in cookie match requests. Please contact
- * your technical account manager if you need to change this.
+ * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
*/
cookieMatchingNid?: string;
/**
@@ -166,25 +159,20 @@ export namespace adexchangebuyer_v1_4 {
*/
kind?: string;
/**
- * The maximum number of active creatives that an account can have, where a
- * creative is active if it was inserted or bid with in the last 30 days.
- * Please contact your technical account manager if you need to change this.
+ * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
*/
maximumActiveCreatives?: number;
/**
- * The sum of all bidderLocation.maximumQps values cannot exceed this.
- * Please contact your technical account manager if you need to change this.
+ * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
*/
maximumTotalQps?: number;
/**
- * The number of creatives that this account inserted or bid with in the
- * last 30 days.
+ * The number of creatives that this account inserted or bid with in the last 30 days.
*/
numberActiveCreatives?: number;
}
/**
- * An account feed lists Ad Exchange buyer accounts that the user has access
- * to. Each entry in the feed corresponds to a single buyer account.
+ * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
*/
export interface Schema$AccountsList {
/**
@@ -242,9 +230,7 @@ export namespace adexchangebuyer_v1_4 {
*/
accountName?: string;
/**
- * A list of adgroup IDs associated with this particular account. These IDs
- * may show up as part of a realtime bidding BidRequest, which indicates a
- * bid request for this account.
+ * A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.
*/
billingId?: string[];
/**
@@ -253,8 +239,7 @@ export namespace adexchangebuyer_v1_4 {
kind?: string;
}
/**
- * A billing info feed lists Billing Info the Ad Exchange buyer account has
- * access to. Each entry in the feed corresponds to a single billing info.
+ * A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.
*/
export interface Schema$BillingInfoList {
/**
@@ -275,13 +260,11 @@ export namespace adexchangebuyer_v1_4 {
*/
accountId?: string;
/**
- * The billing id to determine which adgroup to provide budget information
- * for. This is required for get and update requests.
+ * The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
*/
billingId?: string;
/**
- * The daily budget amount in unit amount of the account currency to apply
- * for the billingId provided. This is required for update requests.
+ * The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
*/
budgetAmount?: string;
/**
@@ -338,18 +321,15 @@ export namespace adexchangebuyer_v1_4 {
*/
accountId?: number;
/**
- * The link to the Ad Preferences page. This is only supported for native
- * ads.
+ * The link to the Ad Preferences page. This is only supported for native ads.
*/
adChoicesDestinationUrl?: string;
/**
- * Detected advertiser id, if any. Read-only. This field should not be set
- * in requests.
+ * Detected advertiser id, if any. Read-only. This field should not be set in requests.
*/
advertiserId?: string[];
/**
- * The name of the company being advertised in the creative. The value
- * provided must exist in the advertisers.txt file.
+ * The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file.
*/
advertiserName?: string;
/**
@@ -357,15 +337,11 @@ export namespace adexchangebuyer_v1_4 {
*/
agencyId?: string;
/**
- * The last upload timestamp of this creative if it was uploaded via API.
- * Read-only. The value of this field is generated, and will be ignored for
- * uploads. (formatted RFC 3339 timestamp).
+ * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
*/
apiUploadTimestamp?: string;
/**
- * List of buyer selectable attributes for the ads that may be shown from
- * this snippet. Each attribute is represented by an integer as defined in
- * buyer-declarable-creative-attributes.txt.
+ * List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt.
*/
attribute?: number[];
/**
@@ -377,8 +353,7 @@ export namespace adexchangebuyer_v1_4 {
*/
clickThroughUrl?: string[];
/**
- * Shows any corrections that were applied to this creative. Read-only. This
- * field should not be set in requests.
+ * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
*/
corrections?: Array<{
contexts?: Array<{
@@ -391,33 +366,19 @@ export namespace adexchangebuyer_v1_4 {
reason?: string;
}>;
/**
- * Creative status identity type that the creative item applies to. Ad
- * Exchange real-time bidding is migrating to the sizeless creative
- * verification. Originally, Ad Exchange assigned creative verification
- * status to a unique combination of a buyer creative ID and creative
- * dimensions. Post-migration, a single verification status will be assigned
- * at the buyer creative ID level. This field allows to distinguish whether
- * a given creative status applies to a unique combination of a buyer
- * creative ID and creative dimensions, or to a buyer creative ID as a
- * whole.
+ * Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.
*/
creativeStatusIdentityType?: string;
/**
- * Top-level deals status. Read-only. This field should not be set in
- * requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL)
- * in servingRestrictions will also exist. Note that this may be nuanced
- * with other contextual restrictions, in which case it may be preferable to
- * read from servingRestrictions directly.
+ * Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
*/
dealsStatus?: string;
/**
- * Detected domains for this creative. Read-only. This field should not be
- * set in requests.
+ * Detected domains for this creative. Read-only. This field should not be set in requests.
*/
detectedDomains?: string[];
/**
- * The filtering reasons for the creative. Read-only. This field should not
- * be set in requests.
+ * The filtering reasons for the creative. Read-only. This field should not be set in requests.
*/
filteringReasons?: {
date?: string;
@@ -428,8 +389,7 @@ export namespace adexchangebuyer_v1_4 {
*/
height?: number;
/**
- * The HTML snippet that displays the ad when inserted in the web page. If
- * set, videoURL, videoVastXML, and nativeAd should not be set.
+ * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.
*/
HTMLSnippet?: string;
/**
@@ -441,13 +401,11 @@ export namespace adexchangebuyer_v1_4 {
*/
kind?: string;
/**
- * Detected languages for this creative. Read-only. This field should not be
- * set in requests.
+ * Detected languages for this creative. Read-only. This field should not be set in requests.
*/
languages?: string[];
/**
- * If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside
- * of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
+ * If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
*/
nativeAd?: {
advertiser?: string;
@@ -466,37 +424,23 @@ export namespace adexchangebuyer_v1_4 {
videoURL?: string;
};
/**
- * Top-level open auction status. Read-only. This field should not be set in
- * requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL)
- * in servingRestrictions will also exist. Note that this may be nuanced
- * with other contextual restrictions, in which case it may be preferable to
- * read from ServingRestrictions directly.
+ * Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
*/
openAuctionStatus?: string;
/**
- * Detected product categories, if any. Each category is represented by an
- * integer as defined in ad-product-categories.txt. Read-only. This field
- * should not be set in requests.
+ * Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.
*/
productCategories?: number[];
/**
- * All restricted categories for the ads that may be shown from this
- * snippet. Each category is represented by an integer as defined in the
- * ad-restricted-categories.txt.
+ * All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.
*/
restrictedCategories?: number[];
/**
- * Detected sensitive categories, if any. Each category is represented by an
- * integer as defined in ad-sensitive-categories.txt. Read-only. This field
- * should not be set in requests.
+ * Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.
*/
sensitiveCategories?: number[];
/**
- * The granular status of this ad in specific contexts. A context here
- * relates to where something ultimately serves (for example, a physical
- * location, a platform, an HTTPS vs HTTP request, or the type of auction).
- * Read-only. This field should not be set in requests. See the examples in
- * the Creatives guide for more details.
+ * The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details.
*/
servingRestrictions?: Array<{
contexts?: Array<{
@@ -509,25 +453,19 @@ export namespace adexchangebuyer_v1_4 {
reason?: string;
}>;
/**
- * List of vendor types for the ads that may be shown from this snippet.
- * Each vendor type is represented by an integer as defined in vendors.txt.
+ * List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.
*/
vendorType?: number[];
/**
- * The version for this creative. Read-only. This field should not be set in
- * requests.
+ * The version for this creative. Read-only. This field should not be set in requests.
*/
version?: number;
/**
- * The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and
- * nativeAd should not be set. Note, this is different from
- * resource.native_ad.video_url above.
+ * The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.
*/
videoURL?: string;
/**
- * The contents of a VAST document for a video ad. This document should
- * conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL,
- * and nativeAd and should not be set.
+ * The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set.
*/
videoVastXML?: string;
/**
@@ -553,9 +491,7 @@ export namespace adexchangebuyer_v1_4 {
kind?: string;
}
/**
- * The creatives feed lists the active creatives for the Ad Exchange buyer
- * accounts that the user has access to. Each entry in the feed corresponds to
- * a single creative.
+ * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
*/
export interface Schema$CreativesList {
/**
@@ -567,29 +503,22 @@ export namespace adexchangebuyer_v1_4 {
*/
kind?: string;
/**
- * Continuation token used to page through creatives. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
export interface Schema$DealServingMetadata {
/**
- * True if alcohol ads are allowed for this deal (read-only). This field is
- * only populated when querying for finalized orders using the method
- * GetFinalizedOrderDeals
+ * True if alcohol ads are allowed for this deal (read-only). This field is only populated when querying for finalized orders using the method GetFinalizedOrderDeals
*/
alcoholAdsAllowed?: boolean;
/**
- * Tracks which parties (if any) have paused a deal. (readonly, except via
- * PauseResumeOrderDeals action)
+ * Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
*/
dealPauseStatus?: Schema$DealServingMetadataDealPauseStatus;
}
/**
- * Tracks which parties (if any) have paused a deal. The deal is considered
- * paused if has_buyer_paused || has_seller_paused. Each of the
- * has_buyer_paused or the has_seller_paused bits can be set independently.
+ * Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently.
*/
export interface Schema$DealServingMetadataDealPauseStatus {
buyerPauseReason?: string;
@@ -607,9 +536,7 @@ export namespace adexchangebuyer_v1_4 {
*/
brandingType?: string;
/**
- * Indicates that this ExternalDealId exists under at least two different
- * AdxInventoryDeals. Currently, the only case that the same ExternalDealId
- * will exist is programmatic cross sell case.
+ * Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
*/
crossListedExternalDealIdType?: string;
/**
@@ -617,13 +544,11 @@ export namespace adexchangebuyer_v1_4 {
*/
description?: string;
/**
- * Non-binding estimate of the estimated gross spend for this deal Can be
- * set by buyer or seller.
+ * Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
*/
estimatedGrossSpend?: Schema$Price;
/**
- * Non-binding estimate of the impressions served per day Can be set by
- * buyer or seller.
+ * Non-binding estimate of the impressions served per day Can be set by buyer or seller.
*/
estimatedImpressionsPerDay?: string;
/**
@@ -643,15 +568,13 @@ export namespace adexchangebuyer_v1_4 {
*/
rubiconNonGuaranteedTerms?: Schema$DealTermsRubiconNonGuaranteedTerms;
/**
- * For deals with Cost Per Day billing, defines the timezone used to mark
- * the boundaries of a day (buyer-readonly)
+ * For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
*/
sellerTimeZone?: string;
}
export interface Schema$DealTermsGuaranteedFixedPriceTerms {
/**
- * External billing info for this Deal. This field is relevant when external
- * billing info such as price has a different currency code than DFP/AdX.
+ * External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
*/
billingInfo?: Schema$DealTermsGuaranteedFixedPriceTermsBillingInfo;
/**
@@ -659,51 +582,39 @@ export namespace adexchangebuyer_v1_4 {
*/
fixedPrices?: Schema$PricePerBuyer[];
/**
- * Guaranteed impressions as a percentage. This is the percentage of
- * guaranteed looks that the buyer is guaranteeing to buy.
+ * Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
*/
guaranteedImpressions?: string;
/**
- * Count of guaranteed looks. Required for deal, optional for product. For
- * CPD deals, buyer changes to guaranteed_looks will be ignored.
+ * Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
*/
guaranteedLooks?: string;
/**
- * Count of minimum daily looks for a CPD deal. For CPD deals, buyer should
- * negotiate on this field instead of guaranteed_looks.
+ * Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
*/
minimumDailyLooks?: string;
}
export interface Schema$DealTermsGuaranteedFixedPriceTermsBillingInfo {
/**
- * The timestamp (in ms since epoch) when the original reservation price for
- * the deal was first converted to DFP currency. This is used to convert the
- * contracted price into buyer's currency without discrepancy.
+ * The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy.
*/
currencyConversionTimeMs?: string;
/**
- * The DFP line item id associated with this deal. For features like CPD,
- * buyers can retrieve the DFP line item for billing reconciliation.
+ * The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
*/
dfpLineItemId?: string;
/**
- * The original contracted quantity (# impressions) for this deal. To ensure
- * delivery, sometimes the publisher will book the deal with a impression
- * buffer, such that guaranteed_looks is greater than the contracted
- * quantity. However clients are billed using the original contracted
- * quantity.
+ * The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
*/
originalContractedQuantity?: string;
/**
- * The original reservation price for the deal, if the currency code is
- * different from the one used in negotiation.
+ * The original reservation price for the deal, if the currency code is different from the one used in negotiation.
*/
price?: Schema$Price;
}
export interface Schema$DealTermsNonGuaranteedAuctionTerms {
/**
- * True if open auction buyers are allowed to compete with invited buyers in
- * this private auction (buyer-readonly).
+ * True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
*/
autoOptimizePrivateAuction?: boolean;
/**
@@ -762,9 +673,7 @@ export namespace adexchangebuyer_v1_4 {
timeUnitType?: string;
}
/**
- * This message carries publisher provided breakdown. E.g. {dimension_type:
- * 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}},
- * {dimension_value: {id: 2, name: 'UK'}}]}
+ * This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}
*/
export interface Schema$Dimension {
dimensionType?: string;
@@ -779,37 +688,21 @@ export namespace adexchangebuyer_v1_4 {
*/
id?: number;
/**
- * Name of the dimension mainly for debugging purposes, except for the case
- * of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.
+ * Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.
*/
name?: string;
/**
- * Percent of total impressions for a dimension type. e.g. {dimension_type:
- * 'GENDER', [{dimension_value: {id: 1, name: 'MALE',
- * percentage: 60}}]} Gender MALE is 60% of all impressions which have
- * gender.
+ * Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender.
*/
percentage?: number;
}
export interface Schema$EditAllOrderDealsRequest {
/**
- * List of deals to edit. Service may perform 3 different operations based
- * on comparison of deals in this list vs deals already persisted in
- * database: 1. Add new deal to proposal If a deal in this list does not
- * exist in the proposal, the service will create a new deal and add it to
- * the proposal. Validation will follow AddOrderDealsRequest. 2. Update
- * existing deal in the proposal If a deal in this list already exist in the
- * proposal, the service will update that existing deal to this new deal in
- * the request. Validation will follow UpdateOrderDealsRequest. 3. Delete
- * deals from the proposal (just need the id) If a existing deal in the
- * proposal is not present in this list, the service will delete that deal
- * from the proposal. Validation will follow DeleteOrderDealsRequest.
+ * List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest.
*/
deals?: Schema$MarketplaceDeal[];
/**
- * If specified, also updates the proposal in the batch transaction. This is
- * useful when the proposal and the deals need to be updated in one
- * transaction.
+ * If specified, also updates the proposal in the batch transaction. This is useful when the proposal and the deals need to be updated in one transaction.
*/
proposal?: Schema$Proposal;
/**
@@ -845,10 +738,7 @@ export namespace adexchangebuyer_v1_4 {
}
export interface Schema$GetOrderNotesResponse {
/**
- * The list of matching notes. The notes for a proposal are ordered from
- * oldest to newest. If the notes span multiple proposals, they will be
- * grouped by proposal, with the notes for the most recently modified
- * proposal appearing first.
+ * The list of matching notes. The notes for a proposal are ordered from oldest to newest. If the notes span multiple proposals, they will be grouped by proposal, with the notes for the most recently modified proposal appearing first.
*/
notes?: Schema$MarketplaceNote[];
}
@@ -865,8 +755,7 @@ export namespace adexchangebuyer_v1_4 {
profiles?: Schema$PublisherProfileApiProto[];
}
/**
- * A proposal can contain multiple deals. A deal contains the terms and
- * targeting information that is used for serving.
+ * A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
*/
export interface Schema$MarketplaceDeal {
/**
@@ -890,30 +779,23 @@ export namespace adexchangebuyer_v1_4 {
*/
dealId?: string;
/**
- * Metadata about the serving status of this deal (readonly, writes via
- * custom actions)
+ * Metadata about the serving status of this deal (readonly, writes via custom actions)
*/
dealServingMetadata?: Schema$DealServingMetadata;
/**
- * The set of fields around delivery control that are interesting for a
- * buyer to see but are non-negotiable. These are set by the publisher. This
- * message is assigned an id of 100 since some day we would want to model
- * this as a protobuf extension.
+ * The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
*/
deliveryControl?: Schema$DeliveryControl;
/**
- * The external deal id assigned to this deal once the deal is finalized.
- * This is the deal-id that shows up in serving/reporting etc. (readonly)
+ * The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
*/
externalDealId?: string;
/**
- * Proposed flight end time of the deal (ms since epoch) This will generally
- * be stored in a granularity of a second. (updatable)
+ * Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
*/
flightEndTimeMs?: string;
/**
- * Proposed flight start time of the deal (ms since epoch) This will
- * generally be stored in a granularity of a second. (updatable)
+ * Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
*/
flightStartTimeMs?: string;
/**
@@ -921,18 +803,15 @@ export namespace adexchangebuyer_v1_4 {
*/
inventoryDescription?: string;
/**
- * Indicates whether the current deal is a RFP template. RFP template is
- * created by buyer and not based on seller created products.
+ * Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
*/
isRfpTemplate?: boolean;
/**
- * True, if the buyside inventory setup is complete for this deal.
- * (readonly, except via OrderSetupCompleted action)
+ * True, if the buyside inventory setup is complete for this deal. (readonly, except via OrderSetupCompleted action)
*/
isSetupComplete?: boolean;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "adexchangebuyer#marketplaceDeal".
+ * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
*/
kind?: string;
/**
@@ -944,19 +823,15 @@ export namespace adexchangebuyer_v1_4 {
*/
name?: string;
/**
- * The product-id from which this deal was created. (readonly, except on
- * create)
+ * The product-id from which this deal was created. (readonly, except on create)
*/
productId?: string;
/**
- * The revision number of the product that the deal was created from
- * (readonly, except on create)
+ * The revision number of the product that the deal was created from (readonly, except on create)
*/
productRevisionNumber?: string;
/**
- * Specifies the creative source for programmatic deals, PUBLISHER means
- * creative is provided by seller and ADVERTISR means creative is provided
- * by buyer. (buyer-readonly)
+ * Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
*/
programmaticCreativeSource?: string;
proposalId?: string;
@@ -965,13 +840,11 @@ export namespace adexchangebuyer_v1_4 {
*/
sellerContacts?: Schema$ContactInformation[];
/**
- * The shared targeting visible to buyers and sellers. Each shared targeting
- * entity is AND'd together. (updatable)
+ * The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
*/
sharedTargetings?: Schema$SharedTargeting[];
/**
- * The syndication product associated with the deal. (readonly, except on
- * create)
+ * The syndication product associated with the deal. (readonly, except on create)
*/
syndicationProduct?: string;
/**
@@ -982,13 +855,11 @@ export namespace adexchangebuyer_v1_4 {
}
export interface Schema$MarketplaceDealParty {
/**
- * The buyer/seller associated with the deal. One of buyer/seller is
- * specified for a deal-party.
+ * The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
*/
buyer?: Schema$Buyer;
/**
- * The buyer/seller associated with the deal. One of buyer/seller is
- * specified for a deal party.
+ * The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
*/
seller?: Schema$Seller;
}
@@ -1011,8 +882,7 @@ export namespace adexchangebuyer_v1_4 {
label?: string;
}
/**
- * A proposal is associated with a bunch of notes which may optionally be
- * associated with a deal and/or revision number.
+ * A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
*/
export interface Schema$MarketplaceNote {
/**
@@ -1020,13 +890,11 @@ export namespace adexchangebuyer_v1_4 {
*/
creatorRole?: string;
/**
- * Notes can optionally be associated with a deal. (readonly, except on
- * create)
+ * Notes can optionally be associated with a deal. (readonly, except on create)
*/
dealId?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "adexchangebuyer#marketplaceNote".
+ * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
*/
kind?: string;
/**
@@ -1042,8 +910,7 @@ export namespace adexchangebuyer_v1_4 {
*/
proposalId?: string;
/**
- * If the note is associated with a proposal revision number, then store
- * that here. (readonly, except on create)
+ * If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
*/
proposalRevisionNumber?: string;
/**
@@ -1064,8 +931,7 @@ export namespace adexchangebuyer_v1_4 {
*/
bidRequestRate?: number;
/**
- * Rate of various prefiltering statuses per match. Please refer to the
- * callout-status-codes.txt file for different statuses.
+ * Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.
*/
calloutStatusRate?: any[];
/**
@@ -1073,13 +939,11 @@ export namespace adexchangebuyer_v1_4 {
*/
cookieMatcherStatusRate?: any[];
/**
- * Rate of ads with a given status. Please refer to the
- * creative-status-codes.txt file for different statuses.
+ * Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.
*/
creativeStatusRate?: any[];
/**
- * The number of bid responses that were filtered due to a policy violation
- * or other errors.
+ * The number of bid responses that were filtered due to a policy violation or other errors.
*/
filteredBidRate?: number;
/**
@@ -1095,18 +959,15 @@ export namespace adexchangebuyer_v1_4 {
*/
kind?: string;
/**
- * The 50th percentile round trip latency(ms) as perceived from Google
- * servers for the duration period covered by the report.
+ * The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
*/
latency50thPercentile?: number;
/**
- * The 85th percentile round trip latency(ms) as perceived from Google
- * servers for the duration period covered by the report.
+ * The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
*/
latency85thPercentile?: number;
/**
- * The 95th percentile round trip latency(ms) as perceived from Google
- * servers for the duration period covered by the report.
+ * The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
*/
latency95thPercentile?: number;
/**
@@ -1138,8 +999,7 @@ export namespace adexchangebuyer_v1_4 {
*/
region?: string;
/**
- * The number of properly formed bid responses received by our servers
- * within the deadline.
+ * The number of properly formed bid responses received by our servers within the deadline.
*/
successfulRequestRate?: number;
/**
@@ -1147,8 +1007,7 @@ export namespace adexchangebuyer_v1_4 {
*/
timestamp?: string;
/**
- * The number of bid responses that were unsuccessful due to timeouts,
- * incorrect formatting, etc.
+ * The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.
*/
unsuccessfulRequestRate?: number;
}
@@ -1167,13 +1026,11 @@ export namespace adexchangebuyer_v1_4 {
}
export interface Schema$PretargetingConfig {
/**
- * The id for billing purposes, provided for reference. Leave this field
- * blank for insert requests; the id will be generated automatically.
+ * The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
*/
billingId?: string;
/**
- * The config id; generated automatically. Leave this field blank for insert
- * requests.
+ * The config id; generated automatically. Leave this field blank for insert requests.
*/
configId?: string;
/**
@@ -1181,18 +1038,15 @@ export namespace adexchangebuyer_v1_4 {
*/
configName?: string;
/**
- * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or
- * PRETARGETING_CREATIVE_TYPE_VIDEO.
+ * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
*/
creativeType?: string[];
/**
- * Requests which allow one of these (width, height) pairs will match. All
- * pairs must be supported ad dimensions.
+ * Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
*/
dimensions?: Array<{height?: string; width?: string}>;
/**
- * Requests with any of these content labels will not match. Values are from
- * content-labels.txt in the downloadable files section.
+ * Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
*/
excludedContentLabels?: string[];
/**
@@ -1208,8 +1062,7 @@ export namespace adexchangebuyer_v1_4 {
*/
excludedUserLists?: string[];
/**
- * Requests containing any of these vertical ids will not match. Values are
- * from the publisher-verticals.txt file in the downloadable files section.
+ * Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
*/
excludedVerticals?: string[];
/**
@@ -1221,8 +1074,7 @@ export namespace adexchangebuyer_v1_4 {
*/
isActive?: boolean;
/**
- * The kind of the resource, i.e.
- * "adexchangebuyer#pretargetingConfig".
+ * The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
*/
kind?: string;
/**
@@ -1230,25 +1082,19 @@ export namespace adexchangebuyer_v1_4 {
*/
languages?: string[];
/**
- * Requests where the predicted viewability is below the specified decile
- * will not match. E.g. if the buyer sets this value to 5, requests from
- * slots where the predicted viewability is below 50% will not match. If the
- * predicted viewability is unknown this field will be ignored.
+ * Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored.
*/
minimumViewabilityDecile?: number;
/**
- * Requests containing any of these mobile carrier ids will match. Values
- * are from mobile-carriers.csv in the downloadable files section.
+ * Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
*/
mobileCarriers?: string[];
/**
- * Requests containing any of these mobile device ids will match. Values are
- * from mobile-devices.csv in the downloadable files section.
+ * Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
*/
mobileDevices?: string[];
/**
- * Requests containing any of these mobile operating system version ids will
- * match. Values are from mobile-os.csv in the downloadable files section.
+ * Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
*/
mobileOperatingSystemVersions?: string[];
/**
@@ -1256,24 +1102,15 @@ export namespace adexchangebuyer_v1_4 {
*/
placements?: Array<{token?: string; type?: string}>;
/**
- * Requests matching any of these platforms will match. Possible values are
- * PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and
- * PRETARGETING_PLATFORM_TABLET.
+ * Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
*/
platforms?: string[];
/**
- * Creative attributes should be declared here if all creatives
- * corresponding to this pretargeting configuration have that creative
- * attribute. Values are from pretargetable-creative-attributes.txt in the
- * downloadable files section.
+ * Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
*/
supportedCreativeAttributes?: string[];
/**
- * Requests containing the specified type of user data will match. Possible
- * values are HOSTED_MATCH_DATA, which means the request is
- * cookie-targetable and has a match in the buyer's hosted match table,
- * and COOKIE_OR_IDFA, which means the request has either a targetable
- * cookie or an iOS IDFA.
+ * Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA.
*/
userIdentifierDataRequired?: string[];
/**
@@ -1281,8 +1118,7 @@ export namespace adexchangebuyer_v1_4 {
*/
userLists?: string[];
/**
- * Requests that allow any of these vendor ids will match. Values are from
- * vendors.txt in the downloadable files section.
+ * Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
*/
vendorTypes?: string[];
/**
@@ -1290,8 +1126,7 @@ export namespace adexchangebuyer_v1_4 {
*/
verticals?: string[];
/**
- * Video requests satisfying any of these player size constraints will
- * match.
+ * Video requests satisfying any of these player size constraints will match.
*/
videoPlayerSizes?: Array<{
aspectRatio?: string;
@@ -1328,11 +1163,7 @@ export namespace adexchangebuyer_v1_4 {
pricingType?: string;
}
/**
- * Used to specify pricing rules for buyers. Each PricePerBuyer in a product
- * can become [0,1] deals. To check if there is a PricePerBuyer for a
- * particular buyer we look for the most specific matching rule - we first
- * look for a rule matching the buyer and otherwise look for a matching rule
- * where no buyer is set.
+ * Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.
*/
export interface Schema$PricePerBuyer {
/**
@@ -1344,9 +1175,7 @@ export namespace adexchangebuyer_v1_4 {
*/
billedBuyer?: Schema$Buyer;
/**
- * The buyer who will pay this price. If unset, all buyers can pay this
- * price (if the advertisers match, and there's no more specific rule
- * matching the buyer).
+ * The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
*/
buyer?: Schema$Buyer;
/**
@@ -1359,23 +1188,15 @@ export namespace adexchangebuyer_v1_4 {
referencePayload?: string;
}
/**
- * A product is segment of inventory that a seller wishes to sell. It is
- * associated with certain terms and targeting information which helps buyer
- * know more about the inventory. Each field in a product can have one of the
- * following setting: (readonly) - It is an error to try and set this field.
- * (buyer-readonly) - Only the seller can set this field. (seller-readonly) -
- * Only the buyer can set this field. (updatable) - The field is updatable at
- * all times by either buyer or the seller.
+ * A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting: (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
*/
export interface Schema$Product {
/**
- * The billed buyer corresponding to the buyer that created the offer.
- * (readonly, except on create)
+ * The billed buyer corresponding to the buyer that created the offer. (readonly, except on create)
*/
billedBuyer?: Schema$Buyer;
/**
- * The buyer that created the offer if this is a buyer initiated offer
- * (readonly, except on create)
+ * The buyer that created the offer if this is a buyer initiated offer (readonly, except on create)
*/
buyer?: Schema$Buyer;
/**
@@ -1383,8 +1204,7 @@ export namespace adexchangebuyer_v1_4 {
*/
creationTimeMs?: string;
/**
- * Optional contact information for the creator of this product.
- * (buyer-readonly)
+ * Optional contact information for the creator of this product. (buyer-readonly)
*/
creatorContacts?: Schema$ContactInformation[];
/**
@@ -1392,10 +1212,7 @@ export namespace adexchangebuyer_v1_4 {
*/
creatorRole?: string;
/**
- * The set of fields around delivery control that are interesting for a
- * buyer to see but are non-negotiable. These are set by the publisher. This
- * message is assigned an id of 100 since some day we would want to model
- * this as a protobuf extension.
+ * The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
*/
deliveryControl?: Schema$DeliveryControl;
/**
@@ -1403,15 +1220,11 @@ export namespace adexchangebuyer_v1_4 {
*/
flightEndTimeMs?: string;
/**
- * Inventory availability dates. (times are in ms since epoch) The
- * granularity is generally in the order of seconds. (buyer-readonly)
+ * Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
*/
flightStartTimeMs?: string;
/**
- * If the creator has already signed off on the product, then the buyer can
- * finalize the deal by accepting the product as is. When copying to a
- * proposal, if any of the terms are changed, then auto_finalize is
- * automatically set to false.
+ * If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
*/
hasCreatorSignedOff?: boolean;
/**
@@ -1419,8 +1232,7 @@ export namespace adexchangebuyer_v1_4 {
*/
inventorySource?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "adexchangebuyer#product".
+ * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product".
*/
kind?: string;
/**
@@ -1436,10 +1248,7 @@ export namespace adexchangebuyer_v1_4 {
*/
legacyOfferId?: string;
/**
- * Marketplace publisher profile Id. This Id differs from the regular
- * publisher_profile_id in that 1. This is a new id, the old Id will be
- * deprecated in 2017. 2. This id uniquely identifies a publisher profile by
- * itself.
+ * Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself.
*/
marketplacePublisherProfileId?: string;
/**
@@ -1455,10 +1264,7 @@ export namespace adexchangebuyer_v1_4 {
*/
productId?: string;
/**
- * Id of the publisher profile for a given seller. A (seller.account_id,
- * publisher_profile_id) pair uniquely identifies a publisher profile.
- * Buyers can call the PublisherProfiles::List endpoint to get a list of
- * publisher profiles for a given seller.
+ * Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller.
*/
publisherProfileId?: string;
/**
@@ -1470,14 +1276,11 @@ export namespace adexchangebuyer_v1_4 {
*/
revisionNumber?: string;
/**
- * Information about the seller that created this product (readonly, except
- * on create)
+ * Information about the seller that created this product (readonly, except on create)
*/
seller?: Schema$Seller;
/**
- * Targeting that is shared between the buyer and the seller. Each targeting
- * criteria has a specified key and for each key there is a list of
- * inclusion value or exclusion values. (buyer-readonly)
+ * Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
*/
sharedTargetings?: Schema$SharedTargeting[];
/**
@@ -1485,8 +1288,7 @@ export namespace adexchangebuyer_v1_4 {
*/
state?: string;
/**
- * The syndication product associated with the deal. (readonly, except on
- * create)
+ * The syndication product associated with the deal. (readonly, except on create)
*/
syndicationProduct?: string;
/**
@@ -1494,19 +1296,12 @@ export namespace adexchangebuyer_v1_4 {
*/
terms?: Schema$DealTerms;
/**
- * The web property code for the seller. This field is meant to be copied
- * over as is when creating deals.
+ * The web property code for the seller. This field is meant to be copied over as is when creating deals.
*/
webPropertyCode?: string;
}
/**
- * Represents a proposal in the marketplace. A proposal is the unit of
- * negotiation between a seller and a buyer and contains deals which are
- * served. Each field in a proposal can have one of the following setting:
- * (readonly) - It is an error to try and set this field. (buyer-readonly) -
- * Only the seller can set this field. (seller-readonly) - Only the buyer can
- * set this field. (updatable) - The field is updatable at all times by either
- * buyer or the seller.
+ * Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting: (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
*/
export interface Schema$Proposal {
/**
@@ -1530,15 +1325,11 @@ export namespace adexchangebuyer_v1_4 {
*/
dbmAdvertiserIds?: string[];
/**
- * When an proposal is in an accepted state, indicates whether the buyer has
- * signed off. Once both sides have signed off on a deal, the proposal can
- * be finalized by the seller. (seller-readonly)
+ * When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
*/
hasBuyerSignedOff?: boolean;
/**
- * When an proposal is in an accepted state, indicates whether the buyer has
- * signed off Once both sides have signed off on a deal, the proposal can be
- * finalized by the seller. (buyer-readonly)
+ * When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
*/
hasSellerSignedOff?: boolean;
/**
@@ -1550,14 +1341,11 @@ export namespace adexchangebuyer_v1_4 {
*/
isRenegotiating?: boolean;
/**
- * True, if the buyside inventory setup is complete for this proposal.
- * (readonly, except via OrderSetupCompleted action) Deprecated in favor of
- * deal level setup complete flag.
+ * True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag.
*/
isSetupComplete?: boolean;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "adexchangebuyer#proposal".
+ * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
*/
kind?: string;
/**
@@ -1565,8 +1353,7 @@ export namespace adexchangebuyer_v1_4 {
*/
labels?: Schema$MarketplaceLabel[];
/**
- * The role of the last user that either updated the proposal or left a
- * comment. (readonly)
+ * The role of the last user that either updated the proposal or left a comment. (readonly)
*/
lastUpdaterOrCommentorRole?: string;
/**
@@ -1582,8 +1369,7 @@ export namespace adexchangebuyer_v1_4 {
*/
originatorRole?: string;
/**
- * Optional private auction id if this proposal is a private auction
- * proposal.
+ * Optional private auction id if this proposal is a private auction proposal.
*/
privateAuctionId?: string;
/**
@@ -1633,8 +1419,7 @@ export namespace adexchangebuyer_v1_4 {
*/
googlePlusLink?: string;
/**
- * True, if this is the parent profile, which represents all domains owned
- * by the publisher.
+ * True, if this is the parent profile, which represents all domains owned by the publisher.
*/
isParent?: boolean;
/**
@@ -1642,8 +1427,7 @@ export namespace adexchangebuyer_v1_4 {
*/
isPublished?: boolean;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "adexchangebuyer#publisherProfileApiProto".
+ * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#publisherProfileApiProto".
*/
kind?: string;
/**
@@ -1660,8 +1444,7 @@ export namespace adexchangebuyer_v1_4 {
*/
overview?: string;
/**
- * The pair of (seller.account_id, profile_id) uniquely identifies a
- * publisher profile for a given publisher.
+ * The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher.
*/
profileId?: number;
/**
@@ -1669,8 +1452,7 @@ export namespace adexchangebuyer_v1_4 {
*/
programmaticContact?: string;
/**
- * The list of domains represented in this publisher profile. Empty if this
- * is a parent profile.
+ * The list of domains represented in this publisher profile. Empty if this is a parent profile.
*/
publisherDomains?: string[];
/**
@@ -1721,8 +1503,7 @@ export namespace adexchangebuyer_v1_4 {
}
export interface Schema$Seller {
/**
- * The unique id for the seller. The seller fills in this field. The seller
- * account id is then available to buyer in the product.
+ * The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
*/
accountId?: string;
/**
@@ -1732,13 +1513,11 @@ export namespace adexchangebuyer_v1_4 {
}
export interface Schema$SharedTargeting {
/**
- * The list of values to exclude from targeting. Each value is AND'd
- * together.
+ * The list of values to exclude from targeting. Each value is AND'd together.
*/
exclusions?: Schema$TargetingValue[];
/**
- * The list of value to include as part of the targeting. Each value is
- * OR'd together.
+ * The list of value to include as part of the targeting. Each value is OR'd together.
*/
inclusions?: Schema$TargetingValue[];
/**
@@ -1752,8 +1531,7 @@ export namespace adexchangebuyer_v1_4 {
*/
creativeSizeValue?: Schema$TargetingValueCreativeSize;
/**
- * The daypart targeting to include / exclude. Filled in when the key is
- * GOOG_DAYPART_TARGETING.
+ * The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
*/
dayPartTargetingValue?: Schema$TargetingValueDayPartTargeting;
demogAgeCriteriaValue?: Schema$TargetingValueDemogAgeCriteria;
@@ -1788,8 +1566,7 @@ export namespace adexchangebuyer_v1_4 {
*/
nativeTemplate?: string;
/**
- * For regular or video creative size type, specifies the size of the
- * creative.
+ * For regular or video creative size type, specifies the size of the creative.
*/
size?: Schema$TargetingValueSize;
/**
@@ -2205,8 +1982,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.billingInfo.get
- * @desc Returns the billing information for one account specified by
- * account ID.
+ * @desc Returns the billing information for one account specified by account ID.
* @alias adexchangebuyer.billingInfo.get
* @memberOf! ()
*
@@ -2278,8 +2054,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.billingInfo.list
- * @desc Retrieves a list of billing information for all accounts of the
- * authenticated user.
+ * @desc Retrieves a list of billing information for all accounts of the authenticated user.
* @alias adexchangebuyer.billingInfo.list
* @memberOf! ()
*
@@ -2376,8 +2151,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.budget.get
- * @desc Returns the budget information for the adgroup specified by the
- * accountId and billingId.
+ * @desc Returns the budget information for the adgroup specified by the accountId and billingId.
* @alias adexchangebuyer.budget.get
* @memberOf! ()
*
@@ -2449,9 +2223,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.budget.patch
- * @desc Updates the budget amount for the budget of the adgroup specified
- * by the accountId and billingId, with the budget amount in the request.
- * This method supports patch semantics.
+ * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.
* @alias adexchangebuyer.budget.patch
* @memberOf! ()
*
@@ -2524,8 +2296,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.budget.update
- * @desc Updates the budget amount for the budget of the adgroup specified
- * by the accountId and billingId, with the budget amount in the request.
+ * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.
* @alias adexchangebuyer.budget.update
* @memberOf! ()
*
@@ -2735,8 +2506,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.creatives.get
- * @desc Gets the status for a single creative. A creative will be available
- * 30-40 minutes after submission.
+ * @desc Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
* @alias adexchangebuyer.creatives.get
* @memberOf! ()
*
@@ -2879,8 +2649,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.creatives.list
- * @desc Retrieves a list of the authenticated user's active creatives. A
- * creative will be available 30-40 minutes after submission.
+ * @desc Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
* @alias adexchangebuyer.creatives.list
* @memberOf! ()
*
@@ -3163,29 +2932,23 @@ export namespace adexchangebuyer_v1_4 {
*/
accountId?: number[];
/**
- * When specified, only creatives for the given buyer creative ids are
- * returned.
+ * When specified, only creatives for the given buyer creative ids are returned.
*/
buyerCreativeId?: string[];
/**
- * When specified, only creatives having the given deals status are
- * returned.
+ * When specified, only creatives having the given deals status are returned.
*/
dealsStatusFilter?: string;
/**
- * Maximum number of entries returned on one result page. If not set, the
- * default is 100. Optional.
+ * Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
*/
maxResults?: number;
/**
- * When specified, only creatives having the given open auction status are
- * returned.
+ * When specified, only creatives having the given open auction status are returned.
*/
openAuctionStatusFilter?: string;
/**
- * A continuation token, used to page through ad clients. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response. Optional.
+ * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
*/
pageToken?: string;
}
@@ -3593,8 +3356,7 @@ export namespace adexchangebuyer_v1_4 {
*/
pqlQuery?: string;
/**
- * The proposalId to get deals for. To search across all proposals specify
- * order_id = '-' as part of the URL.
+ * The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.
*/
proposalId?: string;
}
@@ -3801,14 +3563,11 @@ export namespace adexchangebuyer_v1_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Query string to retrieve specific notes. To search the text contents of
- * notes, please use syntax like "WHERE note.note = "foo" or "WHERE
- * note.note LIKE "%bar%"
+ * Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%"
*/
pqlQuery?: string;
/**
- * The proposalId to get notes for. To search across all proposals specify
- * order_id = '-' as part of the URL.
+ * The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.
*/
proposalId?: string;
}
@@ -4014,14 +3773,11 @@ export namespace adexchangebuyer_v1_4 {
*/
endDateTime?: string;
/**
- * Maximum number of entries returned on one result page. If not set, the
- * default is 100. Optional.
+ * Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
*/
maxResults?: number;
/**
- * A continuation token, used to page through performance reports. To
- * retrieve the next page, set this parameter to the value of
- * "nextPageToken" from the previous response. Optional.
+ * A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
*/
pageToken?: string;
/**
@@ -4260,8 +4016,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.pretargetingConfig.list
- * @desc Retrieves a list of the authenticated user's pretargeting
- * configurations.
+ * @desc Retrieves a list of the authenticated user's pretargeting configurations.
* @alias adexchangebuyer.pretargetingConfig.list
* @memberOf! ()
*
@@ -4336,8 +4091,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.pretargetingConfig.patch
- * @desc Updates an existing pretargeting config. This method supports patch
- * semantics.
+ * @desc Updates an existing pretargeting config. This method supports patch semantics.
* @alias adexchangebuyer.pretargetingConfig.patch
* @memberOf! ()
*
@@ -5065,8 +4819,7 @@ export namespace adexchangebuyer_v1_4 {
/**
* adexchangebuyer.proposals.setupcomplete
- * @desc Update the given proposal to indicate that setup has been
- * completed.
+ * @desc Update the given proposal to indicate that setup has been completed.
* @alias adexchangebuyer.proposals.setupcomplete
* @memberOf! ()
*
@@ -5244,15 +4997,11 @@ export namespace adexchangebuyer_v1_4 {
*/
proposalId?: string;
/**
- * The last known revision number to update. If the head revision in the
- * marketplace database has since changed, an error will be thrown. The
- * caller should then fetch the latest proposal at head revision and retry
- * the update at that revision.
+ * The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.
*/
revisionNumber?: string;
/**
- * The proposed action to take on the proposal. This field is required and
- * it must be set when updating a proposal.
+ * The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
*/
updateAction?: string;
@@ -5295,15 +5044,11 @@ export namespace adexchangebuyer_v1_4 {
*/
proposalId?: string;
/**
- * The last known revision number to update. If the head revision in the
- * marketplace database has since changed, an error will be thrown. The
- * caller should then fetch the latest proposal at head revision and retry
- * the update at that revision.
+ * The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.
*/
revisionNumber?: string;
/**
- * The proposed action to take on the proposal. This field is required and
- * it must be set when updating a proposal.
+ * The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
*/
updateAction?: string;
diff --git a/src/apis/adexchangebuyer2/package.json b/src/apis/adexchangebuyer2/package.json
index 1b5c8efb10a..4260fda5099 100644
--- a/src/apis/adexchangebuyer2/package.json
+++ b/src/apis/adexchangebuyer2/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts
index 5ae31aafec7..d730f368208 100644
--- a/src/apis/adexchangebuyer2/v2beta1.ts
+++ b/src/apis/adexchangebuyer2/v2beta1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
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.
+ * 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;
/**
@@ -95,9 +91,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* Ad Exchange Buyer API II
*
- * Accesses the latest features for managing Authorized Buyers accounts,
- * Real-Time Bidding configurations and auction metrics, and Marketplace
- * programmatic deals.
+ * Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.
*
* @example
* const {google} = require('googleapis');
@@ -115,7 +109,10 @@ export namespace adexchangebuyer2_v2beta1 {
bidders: Resource$Bidders;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.accounts = new Resource$Accounts(this.context);
this.bidders = new Resource$Bidders(this.context);
@@ -123,21 +120,15 @@ export namespace adexchangebuyer2_v2beta1 {
}
/**
- * An absolute date range, specified by its start date and end date. The
- * supported range of dates begins 30 days before today and ends today.
- * Validity checked upon filter set creation. If a filter set with an absolute
- * date range is run at a later date more than 30 days after start_date, it
- * will fail.
+ * An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail.
*/
export interface Schema$AbsoluteDateRange {
/**
- * The end date of the range (inclusive). Must be within the 30 days leading
- * up to current date, and must be equal to or after start_date.
+ * The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date.
*/
endDate?: Schema$Date;
/**
- * The start date of the range (inclusive). Must be within the 30 days
- * leading up to current date, and must be equal to or before end_date.
+ * The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date.
*/
startDate?: Schema$Date;
}
@@ -173,8 +164,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$AdSize {
/**
- * The height of the ad slot in pixels. This field will be present only when
- * size type is `PIXEL`.
+ * The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
*/
height?: string;
/**
@@ -182,13 +172,12 @@ export namespace adexchangebuyer2_v2beta1 {
*/
sizeType?: string;
/**
- * The width of the ad slot in pixels. This field will be present only when
- * size type is `PIXEL`.
+ * The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
*/
width?: string;
}
/**
- * @OutputOnly The app type the restriction applies to for mobile device.
+ * Output only. The app type the restriction applies to for mobile device.
*/
export interface Schema$AppContext {
/**
@@ -197,7 +186,7 @@ export namespace adexchangebuyer2_v2beta1 {
appTypes?: string[];
}
/**
- * @OutputOnly The auction type the restriction applies to.
+ * Output only. The auction type the restriction applies to.
*/
export interface Schema$AuctionContext {
/**
@@ -206,9 +195,7 @@ export namespace adexchangebuyer2_v2beta1 {
auctionTypes?: string[];
}
/**
- * The set of metrics that are measured in numbers of bids, representing how
- * many bids with the specified dimension values were considered eligible at
- * each stage of the bidding funnel;
+ * The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel;
*/
export interface Schema$BidMetricsRow {
/**
@@ -228,8 +215,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
impressionsWon?: Schema$MetricValue;
/**
- * The number of bids for which the corresponding impression was measurable
- * for viewability (as defined by Active View).
+ * The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View).
*/
measurableImpressions?: Schema$MetricValue;
/**
@@ -237,20 +223,16 @@ export namespace adexchangebuyer2_v2beta1 {
*/
rowDimensions?: Schema$RowDimensions;
/**
- * The number of bids for which the corresponding impression was viewable
- * (as defined by Active View).
+ * The number of bids for which the corresponding impression was viewable (as defined by Active View).
*/
viewableImpressions?: Schema$MetricValue;
}
/**
- * The number of impressions with the specified dimension values that were
- * considered to have no applicable bids, as described by the specified
- * status.
+ * The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status.
*/
export interface Schema$BidResponseWithoutBidsStatusRow {
/**
- * The number of impressions for which there was a bid response with the
- * specified status.
+ * The number of impressions for which there was a bid response with the specified status.
*/
impressionCount?: Schema$MetricValue;
/**
@@ -258,14 +240,12 @@ export namespace adexchangebuyer2_v2beta1 {
*/
rowDimensions?: Schema$RowDimensions;
/**
- * The status specifying why the bid responses were considered to have no
- * applicable bids.
+ * The status specifying why the bid responses were considered to have no applicable bids.
*/
status?: string;
}
/**
- * Represents a buyer of inventory. Each buyer is identified by a unique
- * Authorized Buyers account ID.
+ * Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID.
*/
export interface Schema$Buyer {
/**
@@ -274,19 +254,15 @@ export namespace adexchangebuyer2_v2beta1 {
accountId?: string;
}
/**
- * The number of impressions with the specified dimension values where the
- * corresponding bid request or bid response was not successful, as described
- * by the specified callout status.
+ * The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status.
*/
export interface Schema$CalloutStatusRow {
/**
- * The ID of the callout status. See
- * [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes).
+ * The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes).
*/
calloutStatusId?: number;
/**
- * The number of impressions for which there was a bid request or bid
- * response with the specified callout status.
+ * The number of impressions for which there was a bid request or bid response with the specified callout status.
*/
impressionCount?: Schema$MetricValue;
/**
@@ -299,44 +275,23 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$CancelNegotiationRequest {}
/**
- * A client resource represents a client buyer—an agency, a brand,
- * or an advertiser customer of the sponsor buyer. Users associated with the
- * client buyer have restricted access to the Marketplace and certain other
- * sections of the Authorized Buyers UI based on the role granted to the
- * client buyer. All fields are required unless otherwise specified.
+ * A client resource represents a client buyer—an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the client buyer. All fields are required unless otherwise specified.
*/
export interface Schema$Client {
/**
- * The globally-unique numerical ID of the client. The value of this field
- * is ignored in create and update operations.
+ * The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.
*/
clientAccountId?: string;
/**
- * Name used to represent this client to publishers. You may have multiple
- * clients that map to the same entity, but for each client the combination
- * of `clientName` and entity must be unique. You can specify this field as
- * empty.
+ * Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty.
*/
clientName?: string;
/**
- * Numerical identifier of the client entity. The entity can be an
- * advertiser, a brand, or an agency. This identifier is unique among all
- * the entities with the same type. A list of all known advertisers with
- * their identifiers is available in the
- * [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
- * file. A list of all known brands with their identifiers is available in
- * the
- * [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
- * file. A list of all known agencies with their identifiers is available
- * in the
- * [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
- * file.
+ * Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file.
*/
entityId?: string;
/**
- * The name of the entity. This field is automatically fetched based on the
- * type and ID. The value of this field is ignored in create and update
- * operations.
+ * The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.
*/
entityName?: string;
/**
@@ -344,19 +299,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
entityType?: string;
/**
- * Optional arbitrary unique identifier of this client buyer from the
- * standpoint of its Ad Exchange sponsor buyer. This field can be used to
- * associate a client buyer with the identifier in the namespace of its
- * sponsor buyer, lookup client buyers by that identifier and verify whether
- * an Ad Exchange counterpart of a given client buyer already exists. If
- * present, must be unique among all the client buyers for its Ad Exchange
- * sponsor buyer.
+ * Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.
*/
partnerClientId?: string;
/**
- * The role which is assigned to the client buyer. Each role implies a set
- * of permissions granted to the client. Must be one of
- * `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
+ * The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
*/
role?: string;
/**
@@ -369,23 +316,15 @@ export namespace adexchangebuyer2_v2beta1 {
visibleToSeller?: boolean;
}
/**
- * A client user is created under a client buyer and has restricted access to
- * the Marketplace and certain other sections of the Authorized Buyers UI
- * based on the role granted to the associated client buyer. The only way a
- * new client user can be created is via accepting an email invitation (see
- * the accounts.clients.invitations.create method). All fields are required
- * unless otherwise specified.
+ * A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified.
*/
export interface Schema$ClientUser {
/**
- * Numerical account ID of the client buyer with which the user is
- * associated; the buyer must be a client of the current sponsor buyer. The
- * value of this field is ignored in an update operation.
+ * Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation.
*/
clientAccountId?: string;
/**
- * User's email address. The value of this field is ignored in an update
- * operation.
+ * User's email address. The value of this field is ignored in an update operation.
*/
email?: string;
/**
@@ -393,35 +332,29 @@ export namespace adexchangebuyer2_v2beta1 {
*/
status?: string;
/**
- * The unique numerical ID of the client user that has accepted an
- * invitation. The value of this field is ignored in an update operation.
+ * The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation.
*/
userId?: string;
}
/**
- * An invitation for a new client user to get access to the Authorized Buyers
- * UI. All fields are required unless otherwise specified.
+ * An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.
*/
export interface Schema$ClientUserInvitation {
/**
- * Numerical account ID of the client buyer that the invited user is
- * associated with. The value of this field is ignored in create operations.
+ * Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.
*/
clientAccountId?: string;
/**
- * The email address to which the invitation is sent. Email addresses should
- * be unique among all client users under each sponsor buyer.
+ * The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.
*/
email?: string;
/**
- * The unique numerical ID of the invitation that is sent to the user. The
- * value of this field is ignored in create operations.
+ * The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.
*/
invitationId?: string;
}
/**
- * Request message for indicating that the proposal's setup step is
- * complete.
+ * Request message for indicating that the proposal's setup step is complete.
*/
export interface Schema$CompleteSetupRequest {}
/**
@@ -438,7 +371,7 @@ export namespace adexchangebuyer2_v2beta1 {
name?: string;
}
/**
- * @OutputOnly Shows any corrections that were applied to this creative.
+ * Output only. Shows any corrections that were applied to this creative.
*/
export interface Schema$Correction {
/**
@@ -459,8 +392,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$Creative {
/**
- * The account that this creative belongs to. Can be used to filter the
- * response of the creatives.list method.
+ * The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
*/
accountId?: string;
/**
@@ -476,12 +408,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
agencyId?: string;
/**
- * @OutputOnly The last update timestamp of the creative via API.
+ * Output only. The last update timestamp of the creative via API.
*/
apiUpdateTime?: string;
/**
- * All attributes for the ads that may be shown from this creative. Can be
- * used to filter the response of the creatives.list method.
+ * All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
*/
attributes?: string[];
/**
@@ -489,21 +420,15 @@ export namespace adexchangebuyer2_v2beta1 {
*/
clickThroughUrls?: string[];
/**
- * @OutputOnly Shows any corrections that were applied to this creative.
+ * Output only. Shows any corrections that were applied to this creative.
*/
corrections?: Schema$Correction[];
/**
- * The buyer-defined creative ID of this creative. Can be used to filter the
- * response of the creatives.list method.
+ * The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
*/
creativeId?: string;
/**
- * @OutputOnly The top-level deals status of this creative. If disapproved,
- * an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
- * serving_restrictions will also exist. Note that this may be nuanced with
- * other contextual restrictions, in which case, it may be preferable to
- * read from serving_restrictions directly. Can be used to filter the
- * response of the creatives.list method.
+ * Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
*/
dealsStatus?: string;
/**
@@ -511,37 +436,25 @@ export namespace adexchangebuyer2_v2beta1 {
*/
declaredClickThroughUrls?: string[];
/**
- * @OutputOnly Detected advertiser IDs, if any.
+ * Output only. Detected advertiser IDs, if any.
*/
detectedAdvertiserIds?: string[];
/**
- * @OutputOnly The detected domains for this creative.
+ * Output only. The detected domains for this creative.
*/
detectedDomains?: string[];
/**
- * @OutputOnly The detected languages for this creative. The order is
- * arbitrary. The codes are 2 or 5 characters and are documented at
- * https://developers.google.com/adwords/api/docs/appendix/languagecodes.
+ * Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
*/
detectedLanguages?: string[];
/**
- * @OutputOnly Detected product categories, if any. See the
- * ad-product-categories.txt file in the technical documentation for a list
- * of IDs.
+ * Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
*/
detectedProductCategories?: number[];
/**
- * @OutputOnly Detected sensitive categories, if any. See the
- * ad-sensitive-categories.txt file in the technical documentation for a
- * list of IDs. You should use these IDs along with the
- * excluded-sensitive-category field in the bid request to filter your bids.
+ * Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
*/
detectedSensitiveCategories?: number[];
- /**
- * @OutputOnly The filtering stats for this creative. Deprecated; please use
- * bidders.accounts.filterSets.filteredBids.creatives.list method instead.
- */
- filteringStats?: Schema$FilteringStats;
/**
* An HTML creative.
*/
@@ -555,34 +468,23 @@ export namespace adexchangebuyer2_v2beta1 {
*/
native?: Schema$NativeContent;
/**
- * @OutputOnly The top-level open auction status of this creative. If
- * disapproved, an entry for 'auctionType = OPEN_AUCTION' (or
- * 'ALL') in serving_restrictions will also exist. Note that this
- * may be nuanced with other contextual restrictions, in which case, it may
- * be preferable to read from serving_restrictions directly. Can be used to
- * filter the response of the creatives.list method.
+ * Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
*/
openAuctionStatus?: string;
/**
- * All restricted categories for the ads that may be shown from this
- * creative.
+ * All restricted categories for the ads that may be shown from this creative.
*/
restrictedCategories?: string[];
/**
- * @OutputOnly The granular status of this ad in specific contexts. A
- * context here relates to where something ultimately serves (for example, a
- * physical location, a platform, an HTTPS vs HTTP request, or the type of
- * auction).
+ * Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
*/
servingRestrictions?: Schema$ServingRestriction[];
/**
- * All vendor IDs for the ads that may be shown from this creative. See
- * https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for
- * possible values.
+ * All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
*/
vendorIds?: number[];
/**
- * @OutputOnly The version of this creative.
+ * Output only. The version of this creative.
*/
version?: number;
/**
@@ -608,9 +510,7 @@ export namespace adexchangebuyer2_v2beta1 {
dealsId?: string;
}
/**
- * Represents creative restrictions associated to Programmatic Guaranteed/
- * Preferred Deal in Ad Manager. This doesn't apply to Private Auction and
- * AdX Preferred Deals.
+ * Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals.
*/
export interface Schema$CreativeRestrictions {
/**
@@ -628,15 +528,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$CreativeSize {
/**
- * What formats are allowed by the publisher. If this repeated field is
- * empty then all formats are allowed. For example, if this field contains
- * AllowedFormatType.AUDIO then the publisher only allows an audio ad
- * (without any video).
+ * What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video).
*/
allowedFormats?: string[];
/**
- * For video creatives specifies the sizes of companion ads (if present).
- * Companion sizes may be filled in only when creative_size_type = VIDEO
+ * For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO
*/
companionSizes?: Schema$Size[];
/**
@@ -644,24 +540,20 @@ export namespace adexchangebuyer2_v2beta1 {
*/
creativeSizeType?: string;
/**
- * The native template for this creative. It will have a value only if
- * creative_size_type = CreativeSizeType.NATIVE. @OutputOnly
+ * Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE.
*/
nativeTemplate?: string;
/**
- * For regular or video creative size type, specifies the size of the
- * creative
+ * For regular or video creative size type, specifies the size of the creative
*/
size?: Schema$Size;
/**
- * The type of skippable ad for this creative. It will have a value only if
- * creative_size_type = CreativeSizeType.VIDEO.
+ * The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO.
*/
skippableAdType?: string;
}
/**
- * Represents information for a creative that is associated with a
- * Programmatic Guaranteed/Preferred Deal in Ad Manager.
+ * Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager.
*/
export interface Schema$CreativeSpecification {
/**
@@ -674,9 +566,7 @@ export namespace adexchangebuyer2_v2beta1 {
creativeSize?: Schema$AdSize;
}
/**
- * The number of bids with the specified dimension values that did not win the
- * auction (either were filtered pre-auction or lost the auction), as
- * described by the specified creative status.
+ * The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status.
*/
export interface Schema$CreativeStatusRow {
/**
@@ -684,8 +574,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
bidCount?: Schema$MetricValue;
/**
- * The ID of the creative status. See
- * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
+ * The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
*/
creativeStatusId?: number;
/**
@@ -694,8 +583,7 @@ export namespace adexchangebuyer2_v2beta1 {
rowDimensions?: Schema$RowDimensions;
}
/**
- * Generic targeting used for targeting dimensions that contains a list of
- * included and excluded numeric IDs.
+ * Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs.
*/
export interface Schema$CriteriaTargeting {
/**
@@ -708,36 +596,24 @@ export namespace adexchangebuyer2_v2beta1 {
targetedCriteriaIds?: string[];
}
/**
- * Represents a whole or partial calendar date, e.g. a birthday. The time of
- * day and time zone are either specified elsewhere or are not significant.
- * The date is relative to the Proleptic Gregorian Calendar. This can
- * represent: * A full date, with non-zero year, month and day values * A
- * month and day value, with a zero year, e.g. an anniversary * A year on its
- * own, with zero month and day values * A year and month value, with a zero
- * day, e.g. a credit card expiration date Related types are
- * google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
- * Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- * if specifying a year by itself or a year and month where the day is not
- * significant.
+ * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
*/
day?: number;
/**
- * Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- * month and day.
+ * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number;
/**
- * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a
- * year.
+ * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number;
}
/**
- * Daypart targeting message that specifies if the ad can be shown only during
- * certain parts of a day/week.
+ * Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week.
*/
export interface Schema$DayPart {
/**
@@ -745,15 +621,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
dayOfWeek?: string;
/**
- * The ending time of the day for the ad to show (minute level granularity).
- * The end time is exclusive. This field is not available for filtering in
- * PQL queries.
+ * The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries.
*/
endTime?: Schema$TimeOfDay;
/**
- * The starting time of day for the ad to show (minute level granularity).
- * The start time is inclusive. This field is not available for filtering in
- * PQL queries.
+ * The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries.
*/
startTime?: Schema$TimeOfDay;
}
@@ -771,22 +643,15 @@ export namespace adexchangebuyer2_v2beta1 {
timeZoneType?: string;
}
/**
- * A deal represents a segment of inventory for displaying ads on. A proposal
- * can contain multiple deals. A deal contains the terms and targeting
- * information that is used for serving.
+ * A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
*/
export interface Schema$Deal {
/**
- * Proposed flight end time of the deal. This will generally be stored in a
- * granularity of a second. A value is not required for Private Auction
- * deals or Preferred Deals.
+ * Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals.
*/
availableEndTime?: string;
/**
- * Optional proposed flight start time of the deal. This will generally be
- * stored in the granularity of one second since deal serving starts at
- * seconds boundary. Any time specified with more granularity (e.g., in
- * milliseconds) will be truncated towards the start of time in seconds.
+ * Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.
*/
availableStartTime?: string;
/**
@@ -794,44 +659,35 @@ export namespace adexchangebuyer2_v2beta1 {
*/
buyerPrivateData?: Schema$PrivateData;
/**
- * The product ID from which this deal was created. Note: This field may be
- * set only when creating the resource. Modifying this field while updating
- * the resource will result in an error.
+ * The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
createProductId?: string;
/**
- * Optional revision number of the product that the deal was created from.
- * If present on create, and the server `product_revision` has advanced
- * sinced the passed-in `create_product_revision`, an `ABORTED` error will
- * be returned. Note: This field may be set only when creating the
- * resource. Modifying this field while updating the resource will result in
- * an error.
+ * Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
createProductRevision?: string;
/**
- * The time of the deal creation. @OutputOnly
+ * Output only. The time of the deal creation.
*/
createTime?: string;
/**
- * Specifies the creative pre-approval policy. @OutputOnly
+ * Output only. Specifies the creative pre-approval policy.
*/
creativePreApprovalPolicy?: string;
/**
- * Restricitions about the creatives associated with the deal (i.e., size)
- * This is available for Programmatic Guaranteed/Preferred Deals in Ad
- * Manager. @OutputOnly
+ * Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.
*/
creativeRestrictions?: Schema$CreativeRestrictions;
/**
- * Specifies whether the creative is safeFrame compatible. @OutputOnly
+ * Output only. Specifies whether the creative is safeFrame compatible.
*/
creativeSafeFrameCompatibility?: string;
/**
- * A unique deal ID for the deal (server-assigned). @OutputOnly
+ * Output only. A unique deal ID for the deal (server-assigned).
*/
dealId?: string;
/**
- * Metadata about the serving status of this deal. @OutputOnly
+ * Output only. Metadata about the serving status of this deal.
*/
dealServingMetadata?: Schema$DealServingMetadata;
/**
@@ -839,8 +695,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
dealTerms?: Schema$DealTerms;
/**
- * The set of fields around delivery control that are interesting for a
- * buyer to see but are non-negotiable. These are set by the publisher.
+ * The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher.
*/
deliveryControl?: Schema$DeliveryControl;
/**
@@ -852,46 +707,39 @@ export namespace adexchangebuyer2_v2beta1 {
*/
displayName?: string;
/**
- * The external deal ID assigned to this deal once the deal is finalized.
- * This is the deal ID that shows up in serving/reporting etc. @OutputOnly
+ * Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc.
*/
externalDealId?: string;
/**
- * True, if the buyside inventory setup is complete for this deal.
- * @OutputOnly
+ * Output only. True, if the buyside inventory setup is complete for this deal.
*/
isSetupComplete?: boolean;
/**
- * Specifies the creative source for programmatic deals. PUBLISHER means
- * creative is provided by seller and ADVERTISER means creative is provided
- * by buyer. @OutputOnly
+ * Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer.
*/
programmaticCreativeSource?: string;
/**
- * ID of the proposal that this deal is part of. @OutputOnly
+ * Output only. ID of the proposal that this deal is part of.
*/
proposalId?: string;
/**
- * Seller contact information for the deal. @OutputOnly
+ * Output only. Seller contact information for the deal.
*/
sellerContacts?: Schema$ContactInformation[];
/**
- * The syndication product associated with the deal. Note: This field may
- * be set only when creating the resource. Modifying this field while
- * updating the resource will result in an error.
+ * The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
syndicationProduct?: string;
/**
- * Specifies the subset of inventory targeted by the deal. @OutputOnly
+ * Output only. Specifies the subset of inventory targeted by the deal.
*/
targeting?: Schema$MarketplaceTargeting;
/**
- * The shared targeting visible to buyers and sellers. Each shared targeting
- * entity is AND'd together.
+ * The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.
*/
targetingCriterion?: Schema$TargetingCriteria[];
/**
- * The time when the deal was last updated. @OutputOnly
+ * Output only. The time when the deal was last updated.
*/
updateTime?: string;
/**
@@ -900,8 +748,7 @@ export namespace adexchangebuyer2_v2beta1 {
webPropertyCode?: string;
}
/**
- * Tracks which parties (if any) have paused a deal. The deal is considered
- * paused if either hasBuyerPaused or hasSellPaused is true.
+ * Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true.
*/
export interface Schema$DealPauseStatus {
/**
@@ -930,14 +777,12 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$DealServingMetadata {
/**
- * Tracks which parties (if any) have paused a deal. @OutputOnly
+ * Output only. Tracks which parties (if any) have paused a deal.
*/
dealPauseStatus?: Schema$DealPauseStatus;
}
/**
- * The deal terms specify the details of a Product/deal. They specify things
- * like price per buyer, the type of pricing model (e.g., fixed price,
- * auction) and expected impressions from the publisher.
+ * The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher.
*/
export interface Schema$DealTerms {
/**
@@ -949,13 +794,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
description?: string;
/**
- * Non-binding estimate of the estimated gross spend for this deal. Can be
- * set by buyer or seller.
+ * Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller.
*/
estimatedGrossSpend?: Schema$Price;
/**
- * Non-binding estimate of the impressions served per day. Can be set by
- * buyer or seller.
+ * Non-binding estimate of the impressions served per day. Can be set by buyer or seller.
*/
estimatedImpressionsPerDay?: string;
/**
@@ -971,10 +814,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
nonGuaranteedFixedPriceTerms?: Schema$NonGuaranteedFixedPriceTerms;
/**
- * The time zone name. For deals with Cost Per Day billing, defines the time
- * zone used to mark the boundaries of a day. It should be an IANA TZ name,
- * such as "America/Los_Angeles". For more information, see
- * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
+ * The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
*/
sellerTimeZone?: string;
}
@@ -983,20 +823,20 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$DeliveryControl {
/**
- * Specified the creative blocking levels to be applied. @OutputOnly
+ * Output only. Specified the creative blocking levels to be applied.
*/
creativeBlockingLevel?: string;
/**
- * Specifies how the impression delivery will be paced. @OutputOnly
+ * Output only. Specifies how the impression delivery will be paced.
*/
deliveryRateType?: string;
/**
- * Specifies any frequency caps. @OutputOnly
+ * Output only. Specifies any frequency caps.
*/
frequencyCaps?: Schema$FrequencyCap[];
}
/**
- * @OutputOnly The reason and details for a disapproval.
+ * Output only. The reason and details for a disapproval.
*/
export interface Schema$Disapproval {
/**
@@ -1009,16 +849,11 @@ export namespace adexchangebuyer2_v2beta1 {
reason?: string;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
- * The number of filtered bids with the specified dimension values that have
- * the specified creative.
+ * The number of filtered bids with the specified dimension values that have the specified creative.
*/
export interface Schema$FilteredBidCreativeRow {
/**
@@ -1035,9 +870,7 @@ export namespace adexchangebuyer2_v2beta1 {
rowDimensions?: Schema$RowDimensions;
}
/**
- * The number of filtered bids with the specified dimension values, among
- * those filtered due to the requested filtering reason (i.e. creative
- * status), that have the specified detail.
+ * The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail.
*/
export interface Schema$FilteredBidDetailRow {
/**
@@ -1045,8 +878,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
bidCount?: Schema$MetricValue;
/**
- * The ID of the detail. The associated value can be looked up in the
- * dictionary file corresponding to the DetailType in the response message.
+ * The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.
*/
detailId?: number;
/**
@@ -1055,52 +887,23 @@ export namespace adexchangebuyer2_v2beta1 {
rowDimensions?: Schema$RowDimensions;
}
/**
- * @OutputOnly Filtering reasons for this creative during a period of a single
- * day (from midnight to midnight Pacific).
- */
- export interface Schema$FilteringStats {
- /**
- * The day during which the data was collected. The data is collected from
- * 00:00:00 to 23:59:59 PT. During switches from PST to PDT and back, the
- * day may contain 23 or 25 hours of data instead of the usual 24.
- */
- date?: Schema$Date;
- /**
- * The set of filtering reasons for this date.
- */
- reasons?: Schema$Reason[];
- }
- /**
- * A set of filters that is applied to a request for data. Within a filter
- * set, an AND operation is performed across the filters represented by each
- * field. An OR operation is performed across the filters represented by the
- * multiple values of a repeated field, e.g., "format=VIDEO AND
- * deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)".
+ * A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)".
*/
export interface Schema$FilterSet {
/**
- * An absolute date range, defined by a start date and an end date.
- * Interpreted relative to Pacific time zone.
+ * An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
*/
absoluteDateRange?: Schema$AbsoluteDateRange;
/**
- * The set of dimensions along which to break down the response; may be
- * empty. If multiple dimensions are requested, the breakdown is along the
- * Cartesian product of the requested dimensions.
+ * The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.
*/
breakdownDimensions?: string[];
/**
- * The ID of the creative on which to filter; optional. This field may be
- * set only for a filter set that accesses account-level troubleshooting
- * data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x
- * pattern.
+ * The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x pattern.
*/
creativeId?: string;
/**
- * The ID of the deal on which to filter; optional. This field may be set
- * only for a filter set that accesses account-level troubleshooting data,
- * i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x
- * pattern.
+ * The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x pattern.
*/
dealId?: string;
/**
@@ -1108,63 +911,40 @@ export namespace adexchangebuyer2_v2beta1 {
*/
environment?: string;
/**
- * The list of formats on which to filter; may be empty. The filters
- * represented by multiple formats are ORed together (i.e., if non-empty,
- * results must match any one of the formats).
+ * The list of formats on which to filter; may be empty. The filters represented by multiple formats are ORed together (i.e., if non-empty, results must match any one of the formats).
*/
formats?: string[];
/**
- * A user-defined name of the filter set. Filter set names must be unique
- * globally and match one of the patterns: - `bidders/x/filterSets/x (for
- * accessing bidder-level troubleshooting data) -
- * `bidders/x/accounts/x/filterSets/x (for accessing account-level
- * troubleshooting data) This field is required in create operations.
+ * A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/x/filterSets/x (for accessing bidder-level troubleshooting data) - `bidders/x/accounts/x/filterSets/x (for accessing account-level troubleshooting data) This field is required in create operations.
*/
name?: string;
/**
- * The list of platforms on which to filter; may be empty. The filters
- * represented by multiple platforms are ORed together (i.e., if non-empty,
- * results must match any one of the platforms).
+ * The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms).
*/
platforms?: string[];
/**
- * For Open Bidding partners only. The list of publisher identifiers on
- * which to filter; may be empty. The filters represented by multiple
- * publisher identifiers are ORed together.
+ * For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together.
*/
publisherIdentifiers?: string[];
/**
- * An open-ended realtime time range, defined by the aggregation start
- * timestamp.
+ * An open-ended realtime time range, defined by the aggregation start timestamp.
*/
realtimeTimeRange?: Schema$RealtimeTimeRange;
/**
- * A relative date range, defined by an offset from today and a duration.
- * Interpreted relative to Pacific time zone.
+ * A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
*/
relativeDateRange?: Schema$RelativeDateRange;
/**
- * For Authorized Buyers only. The list of IDs of the seller (publisher)
- * networks on which to filter; may be empty. The filters represented by
- * multiple seller network IDs are ORed together (i.e., if non-empty,
- * results must match any one of the publisher networks). See
- * [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids)
- * file for the set of existing seller network IDs.
+ * For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
*/
sellerNetworkIds?: number[];
/**
- * The granularity of time intervals if a time series breakdown is desired;
- * optional.
+ * The granularity of time intervals if a time series breakdown is desired; optional.
*/
timeSeriesGranularity?: string;
}
/**
- * Represents a list of targeted and excluded mobile application IDs that
- * publishers own. Mobile application IDs are from App Store and Google Play
- * Store. Android App ID, for example, com.google.android.apps.maps, can be
- * found in Google Play Store URL. iOS App ID (which is a number) can be found
- * at the end of iTunes store URL. First party mobile applications is either
- * included or excluded.
+ * Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.
*/
export interface Schema$FirstPartyMobileApplicationTargeting {
/**
@@ -1181,18 +961,15 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$FrequencyCap {
/**
- * The maximum number of impressions that can be served to a user within the
- * specified time period.
+ * The maximum number of impressions that can be served to a user within the specified time period.
*/
maxImpressions?: number;
/**
- * The amount of time, in the units specified by time_unit_type. Defines the
- * amount of time over which impressions per user are counted and capped.
+ * The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
*/
numTimeUnits?: number;
/**
- * The time unit. Along with num_time_units defines the amount of time over
- * which impressions per user are counted and capped.
+ * The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
*/
timeUnitType?: string;
}
@@ -1205,8 +982,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
fixedPrices?: Schema$PricePerBuyer[];
/**
- * Guaranteed impressions as a percentage. This is the percentage of
- * guaranteed looks that the buyer is guaranteeing to buy.
+ * Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
*/
guaranteedImpressions?: string;
/**
@@ -1236,8 +1012,7 @@ export namespace adexchangebuyer2_v2beta1 {
width?: number;
}
/**
- * An image resource. You may provide a larger image than was requested, so
- * long as the aspect ratio is preserved.
+ * An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved.
*/
export interface Schema$Image {
/**
@@ -1254,29 +1029,23 @@ export namespace adexchangebuyer2_v2beta1 {
width?: number;
}
/**
- * The set of metrics that are measured in numbers of impressions,
- * representing how many impressions with the specified dimension values were
- * considered eligible at each stage of the bidding funnel.
+ * The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel.
*/
export interface Schema$ImpressionMetricsRow {
/**
- * The number of impressions available to the buyer on Ad Exchange. In some
- * cases this value may be unavailable.
+ * The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable.
*/
availableImpressions?: Schema$MetricValue;
/**
- * The number of impressions for which Ad Exchange sent the buyer a bid
- * request.
+ * The number of impressions for which Ad Exchange sent the buyer a bid request.
*/
bidRequests?: Schema$MetricValue;
/**
- * The number of impressions that match the buyer's inventory
- * pretargeting.
+ * The number of impressions that match the buyer's inventory pretargeting.
*/
inventoryMatches?: Schema$MetricValue;
/**
- * The number of impressions for which Ad Exchange received a response from
- * the buyer that contained at least one applicable bid.
+ * The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid.
*/
responsesWithBids?: Schema$MetricValue;
/**
@@ -1284,16 +1053,12 @@ export namespace adexchangebuyer2_v2beta1 {
*/
rowDimensions?: Schema$RowDimensions;
/**
- * The number of impressions for which the buyer successfully sent a
- * response to Ad Exchange.
+ * The number of impressions for which the buyer successfully sent a response to Ad Exchange.
*/
successfulResponses?: Schema$MetricValue;
}
/**
- * Represents the size of an ad unit that can be targeted on an ad request. It
- * only applies to Private Auction, AdX Preferred Deals and Auction Packages.
- * This targeting does not apply to Programmatic Guaranteed and Preferred
- * Deals in Ad Manager.
+ * Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager.
*/
export interface Schema$InventorySizeTargeting {
/**
@@ -1306,8 +1071,7 @@ export namespace adexchangebuyer2_v2beta1 {
targetedInventorySizes?: Schema$AdSize[];
}
/**
- * Response message for listing the metrics that are measured in number of
- * bids.
+ * Response message for listing the metrics that are measured in number of bids.
*/
export interface Schema$ListBidMetricsResponse {
/**
@@ -1315,15 +1079,12 @@ export namespace adexchangebuyer2_v2beta1 {
*/
bidMetricsRows?: Schema$BidMetricsRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListBidMetricsRequest.pageToken field in the subsequent call to the
- * bidMetrics.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListBidMetricsRequest.pageToken field in the subsequent call to the bidMetrics.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * Response message for listing all reasons that bid responses resulted in an
- * error.
+ * Response message for listing all reasons that bid responses resulted in an error.
*/
export interface Schema$ListBidResponseErrorsResponse {
/**
@@ -1331,27 +1092,20 @@ export namespace adexchangebuyer2_v2beta1 {
*/
calloutStatusRows?: Schema$CalloutStatusRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListBidResponseErrorsRequest.pageToken field in the subsequent call to
- * the bidResponseErrors.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListBidResponseErrorsRequest.pageToken field in the subsequent call to the bidResponseErrors.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * Response message for listing all reasons that bid responses were considered
- * to have no applicable bids.
+ * Response message for listing all reasons that bid responses were considered to have no applicable bids.
*/
export interface Schema$ListBidResponsesWithoutBidsResponse {
/**
- * List of rows, with counts of bid responses without bids aggregated by
- * status.
+ * List of rows, with counts of bid responses without bids aggregated by status.
*/
bidResponseWithoutBidsStatusRows?: Schema$BidResponseWithoutBidsStatusRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call
- * to the bidResponsesWithoutBids.list method to retrieve the next page of
- * results.
+ * A token to retrieve the next page of results. Pass this value in the ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call to the bidResponsesWithoutBids.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
@@ -1361,9 +1115,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
clients?: Schema$Client[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListClientsRequest.pageToken field in the subsequent call to the
- * accounts.clients.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the accounts.clients.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
@@ -1373,18 +1125,13 @@ export namespace adexchangebuyer2_v2beta1 {
*/
invitations?: Schema$ClientUserInvitation[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListClientUserInvitationsRequest.pageToken field in the subsequent call
- * to the clients.invitations.list method to retrieve the next page of
- * results.
+ * A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
export interface Schema$ListClientUsersResponse {
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListClientUsersRequest.pageToken field in the subsequent call to the
- * clients.invitations.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.
*/
nextPageToken?: string;
/**
@@ -1401,33 +1148,25 @@ export namespace adexchangebuyer2_v2beta1 {
*/
creatives?: Schema$Creative[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListCreativesRequest.page_token field in the subsequent call to
- * `ListCreatives` method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * Response message for listing all creatives associated with a given filtered
- * bid reason.
+ * Response message for listing all creatives associated with a given filtered bid reason.
*/
export interface Schema$ListCreativeStatusBreakdownByCreativeResponse {
/**
- * List of rows, with counts of bids with a given creative status aggregated
- * by creative.
+ * List of rows, with counts of bids with a given creative status aggregated by creative.
*/
filteredBidCreativeRows?: Schema$FilteredBidCreativeRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the
- * subsequent call to the filteredBids.creatives.list method to retrieve the
- * next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the subsequent call to the filteredBids.creatives.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * Response message for listing all details associated with a given filtered
- * bid reason.
+ * Response message for listing all details associated with a given filtered bid reason.
*/
export interface Schema$ListCreativeStatusBreakdownByDetailResponse {
/**
@@ -1435,15 +1174,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
detailType?: string;
/**
- * List of rows, with counts of bids with a given creative status aggregated
- * by detail.
+ * List of rows, with counts of bids with a given creative status aggregated by detail.
*/
filteredBidDetailRows?: Schema$FilteredBidDetailRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListCreativeStatusBreakdownByDetailRequest.pageToken field in the
- * subsequent call to the filteredBids.details.list method to retrieve the
- * next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByDetailRequest.pageToken field in the subsequent call to the filteredBids.details.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
@@ -1456,44 +1191,33 @@ export namespace adexchangebuyer2_v2beta1 {
*/
associations?: Schema$CreativeDealAssociation[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListDealAssociationsRequest.page_token field in the subsequent call to
- * 'ListDealAssociation' method to retrieve the next page of
- * results.
+ * A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * Response message for listing all reasons that bid requests were filtered
- * and not sent to the buyer.
+ * Response message for listing all reasons that bid requests were filtered and not sent to the buyer.
*/
export interface Schema$ListFilteredBidRequestsResponse {
/**
- * List of rows, with counts of filtered bid requests aggregated by callout
- * status.
+ * List of rows, with counts of filtered bid requests aggregated by callout status.
*/
calloutStatusRows?: Schema$CalloutStatusRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListFilteredBidRequestsRequest.pageToken field in the subsequent call to
- * the filteredBidRequests.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListFilteredBidRequestsRequest.pageToken field in the subsequent call to the filteredBidRequests.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * Response message for listing all reasons that bids were filtered from the
- * auction.
+ * Response message for listing all reasons that bids were filtered from the auction.
*/
export interface Schema$ListFilteredBidsResponse {
/**
- * List of rows, with counts of filtered bids aggregated by filtering reason
- * (i.e. creative status).
+ * List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status).
*/
creativeStatusRows?: Schema$CreativeStatusRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListFilteredBidsRequest.pageToken field in the subsequent call to the
- * filteredBids.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
@@ -1506,15 +1230,12 @@ export namespace adexchangebuyer2_v2beta1 {
*/
filterSets?: Schema$FilterSet[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListFilterSetsRequest.pageToken field in the subsequent call to the
- * accounts.filterSets.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * Response message for listing the metrics that are measured in number of
- * impressions.
+ * Response message for listing the metrics that are measured in number of impressions.
*/
export interface Schema$ListImpressionMetricsResponse {
/**
@@ -1522,9 +1243,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
impressionMetricsRows?: Schema$ImpressionMetricsRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListImpressionMetricsRequest.pageToken field in the subsequent call to
- * the impressionMetrics.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListImpressionMetricsRequest.pageToken field in the subsequent call to the impressionMetrics.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
@@ -1533,27 +1252,20 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$ListLosingBidsResponse {
/**
- * List of rows, with counts of losing bids aggregated by loss reason (i.e.
- * creative status).
+ * List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status).
*/
creativeStatusRows?: Schema$CreativeStatusRow[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListLosingBidsRequest.pageToken field in the subsequent call to the
- * losingBids.list method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * Response message for listing all reasons for which a buyer was not billed
- * for a winning bid.
+ * Response message for listing all reasons for which a buyer was not billed for a winning bid.
*/
export interface Schema$ListNonBillableWinningBidsResponse {
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListNonBillableWinningBidsRequest.pageToken field in the subsequent call
- * to the nonBillableWinningBids.list method to retrieve the next page of
- * results.
+ * A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list method to retrieve the next page of results.
*/
nextPageToken?: string;
/**
@@ -1601,21 +1313,16 @@ export namespace adexchangebuyer2_v2beta1 {
publisherProfiles?: Schema$PublisherProfile[];
}
/**
- * @OutputOnly The Geo criteria the restriction applies to.
+ * Output only. The Geo criteria the restriction applies to.
*/
export interface Schema$LocationContext {
/**
- * IDs representing the geo location for this context. Please refer to the
- * [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
- * file for different geo criteria IDs.
+ * IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
*/
geoCriteriaIds?: number[];
}
/**
- * Targeting represents different criteria that can be used by advertisers to
- * target ad inventory. For example, they can choose to target ad requests
- * only if the user is in the US. Multiple types of targeting are always
- * applied as a logical AND, unless noted otherwise.
+ * Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise.
*/
export interface Schema$MarketplaceTargeting {
/**
@@ -1631,8 +1338,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
placementTargeting?: Schema$PlacementTargeting;
/**
- * Technology targeting information, e.g., operating system, device
- * category.
+ * Technology targeting information, e.g., operating system, device category.
*/
technologyTargeting?: Schema$TechnologyTargeting;
/**
@@ -1641,8 +1347,7 @@ export namespace adexchangebuyer2_v2beta1 {
videoTargeting?: Schema$VideoTargeting;
}
/**
- * A metric value, with an expected value and a variance; represents a count
- * that may be either exact or estimated (i.e. when sampled).
+ * A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled).
*/
export interface Schema$MetricValue {
/**
@@ -1650,12 +1355,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
value?: string;
/**
- * The variance (i.e. square of the standard deviation) of the metric value.
- * If value is exact, variance is 0. Can be used to calculate margin of
- * error as a percentage of value, using the following formula, where Z is
- * the standard constant that depends on the desired size of the confidence
- * interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError
- * = 100 * Z * sqrt(variance) / value
+ * The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value
*/
variance?: string;
}
@@ -1664,8 +1364,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$MobileApplicationTargeting {
/**
- * Publisher owned apps to be targeted or excluded by the publisher to
- * display the ads in.
+ * Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
*/
firstPartyTargeting?: Schema$FirstPartyMobileApplicationTargeting;
}
@@ -1678,17 +1377,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
currencyCode?: string;
/**
- * Number of nano (10^-9) units of the amount. The value must be between
- * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos`
- * must be positive or zero. If `units` is zero, `nanos` can be positive,
- * zero, or negative. If `units` is negative, `nanos` must be negative or
- * zero. For example $-1.75 is represented as `units`=-1 and
- * `nanos`=-750,000,000.
+ * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number;
/**
- * The whole units of the amount. For example if `currencyCode` is
- * `"USD"`, then 1 unit is one US dollar.
+ * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string;
}
@@ -1697,8 +1390,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$NativeContent {
/**
- * The name of the advertiser or sponsor, to be displayed in the ad
- * creative.
+ * The name of the advertiser or sponsor, to be displayed in the ad creative.
*/
advertiserName?: string;
/**
@@ -1751,8 +1443,7 @@ export namespace adexchangebuyer2_v2beta1 {
videoUrl?: string;
}
/**
- * The number of winning bids with the specified dimension values for which
- * the buyer was not billed, as described by the specified status.
+ * The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status.
*/
export interface Schema$NonBillableWinningBidStatusRow {
/**
@@ -1769,13 +1460,11 @@ export namespace adexchangebuyer2_v2beta1 {
status?: string;
}
/**
- * Terms for Private Auctions. Note that Private Auctions can be created only
- * by the seller, but they can be returned in a get or list request.
+ * Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request.
*/
export interface Schema$NonGuaranteedAuctionTerms {
/**
- * True if open auction buyers are allowed to compete with invited buyers in
- * this private auction.
+ * True if open auction buyers are allowed to compete with invited buyers in this private auction.
*/
autoOptimizePrivateAuction?: boolean;
/**
@@ -1784,8 +1473,7 @@ export namespace adexchangebuyer2_v2beta1 {
reservePricesPerBuyer?: Schema$PricePerBuyer[];
}
/**
- * Terms for Preferred Deals. Note that Preferred Deals cannot be created via
- * the API at this time, but can be returned in a get or list request.
+ * Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request.
*/
export interface Schema$NonGuaranteedFixedPriceTerms {
/**
@@ -1798,25 +1486,23 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$Note {
/**
- * The timestamp for when this note was created. @OutputOnly
+ * Output only. The timestamp for when this note was created.
*/
createTime?: string;
/**
- * The role of the person (buyer/seller) creating the note. @OutputOnly
+ * Output only. The role of the person (buyer/seller) creating the note.
*/
creatorRole?: string;
/**
- * The actual note to attach. (max-length: 1024 unicode code units) Note:
- * This field may be set only when creating the resource. Modifying this
- * field while updating the resource will result in an error.
+ * The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
note?: string;
/**
- * The unique ID for the note. @OutputOnly
+ * Output only. The unique ID for the note.
*/
noteId?: string;
/**
- * The revision number of the proposal when the note is created. @OutputOnly
+ * Output only. The revision number of the proposal when the note is created.
*/
proposalRevision?: string;
}
@@ -1838,21 +1524,16 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$PauseProposalRequest {
/**
- * The reason why the proposal is being paused. This human readable message
- * will be displayed in the seller's UI. (Max length: 1000 unicode code
- * units.)
+ * The reason why the proposal is being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.)
*/
reason?: string;
}
/**
- * Represents targeting about where the ads can appear, e.g., certain sites or
- * mobile applications. Different placement targeting types will be logically
- * OR'ed.
+ * Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed.
*/
export interface Schema$PlacementTargeting {
/**
- * Mobile application targeting information in a deal. This doesn't
- * apply to Auction Packages.
+ * Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
*/
mobileApplicationTargeting?: Schema$MobileApplicationTargeting;
/**
@@ -1861,7 +1542,7 @@ export namespace adexchangebuyer2_v2beta1 {
urlTargeting?: Schema$UrlTargeting;
}
/**
- * @OutputOnly The type of platform the restriction applies to.
+ * Output only. The type of platform the restriction applies to.
*/
export interface Schema$PlatformContext {
/**
@@ -1883,23 +1564,15 @@ export namespace adexchangebuyer2_v2beta1 {
pricingType?: string;
}
/**
- * Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
- * a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
- * a particular buyer or buyer/advertiser pair, we look for the most specific
- * matching rule - we first look for a rule matching the buyer and advertiser,
- * next a rule with the buyer but an empty advertiser list, and otherwise look
- * for a matching rule where no buyer is set.
+ * Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
*/
export interface Schema$PricePerBuyer {
/**
- * The list of advertisers for this price when associated with this buyer.
- * If empty, all advertisers with this buyer pay this price.
+ * The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price.
*/
advertiserIds?: string[];
/**
- * The buyer who will pay this price. If unset, all buyers can pay this
- * price (if the advertisers match, and there's no more specific rule
- * matching the buyer).
+ * The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
*/
buyer?: Schema$Buyer;
/**
@@ -1908,33 +1581,24 @@ export namespace adexchangebuyer2_v2beta1 {
price?: Schema$Price;
}
/**
- * Buyers are allowed to store certain types of private data in a
- * proposal/deal.
+ * Buyers are allowed to store certain types of private data in a proposal/deal.
*/
export interface Schema$PrivateData {
/**
- * A buyer or seller specified reference ID. This can be queried in the list
- * operations (max-length: 1024 unicode code units).
+ * A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
*/
referenceId?: string;
}
/**
- * Note: this resource requires whitelisting for access. Please contact your
- * account manager for access to Marketplace resources. A product is a
- * segment of inventory that a seller wishes to sell. It is associated with
- * certain terms and targeting information which helps the buyer know more
- * about the inventory.
+ * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.
*/
export interface Schema$Product {
/**
- * The proposed end time for the deal. The field will be truncated to the
- * order of seconds during serving.
+ * The proposed end time for the deal. The field will be truncated to the order of seconds during serving.
*/
availableEndTime?: string;
/**
- * Inventory availability dates. The start time will be truncated to seconds
- * during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS)
- * will be truncated to 3:23:34 when serving.
+ * Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving.
*/
availableStartTime?: string;
/**
@@ -1950,10 +1614,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
displayName?: string;
/**
- * If the creator has already signed off on the product, then the buyer can
- * finalize the deal by accepting the product as is. When copying to a
- * proposal, if any of the terms are changed, then auto_finalize is
- * automatically set to false.
+ * If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
*/
hasCreatorSignedOff?: boolean;
/**
@@ -1965,8 +1626,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
productRevision?: string;
/**
- * An ID which can be used by the Publisher Profile API to get more
- * information about the seller that created this product.
+ * An ID which can be used by the Publisher Profile API to get more information about the seller that created this product.
*/
publisherProfileId?: string;
/**
@@ -1978,9 +1638,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
syndicationProduct?: string;
/**
- * Targeting that is shared between the buyer and the seller. Each targeting
- * criterion has a specified key and for each key there is a list of
- * inclusion value or exclusion values.
+ * Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values.
*/
targetingCriterion?: Schema$TargetingCriteria[];
/**
@@ -1992,29 +1650,20 @@ export namespace adexchangebuyer2_v2beta1 {
*/
updateTime?: string;
/**
- * The web-property code for the seller. This needs to be copied as is when
- * adding a new deal to a proposal.
+ * The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal.
*/
webPropertyCode?: string;
}
/**
- * Note: this resource requires whitelisting for access. Please contact your
- * account manager for access to Marketplace resources. Represents a proposal
- * in the Marketplace. A proposal is the unit of negotiation between a seller
- * and a buyer and contains deals which are served. Note: you can not update,
- * create, or otherwise modify Private Auction or Preferred Deals deals
- * through the API. Fields are updatable unless noted otherwise.
+ * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise.
*/
export interface Schema$Proposal {
/**
- * Reference to the buyer that will get billed for this proposal.
- * @OutputOnly
+ * Output only. Reference to the buyer that will get billed for this proposal.
*/
billedBuyer?: Schema$Buyer;
/**
- * Reference to the buyer on the proposal. Note: This field may be set only
- * when creating the resource. Modifying this field while updating the
- * resource will result in an error.
+ * Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
buyer?: Schema$Buyer;
/**
@@ -2026,9 +1675,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
buyerPrivateData?: Schema$PrivateData;
/**
- * The deals associated with this proposal. For Private Auction proposals
- * (whose deals have NonGuaranteedAuctionTerms), there will only be one
- * deal.
+ * The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
*/
deals?: Schema$Deal[];
/**
@@ -2036,70 +1683,56 @@ export namespace adexchangebuyer2_v2beta1 {
*/
displayName?: string;
/**
- * True if the proposal is being renegotiated. @OutputOnly
+ * Output only. True if the proposal is being renegotiated.
*/
isRenegotiating?: boolean;
/**
- * True, if the buyside inventory setup is complete for this proposal.
- * @OutputOnly
+ * Output only. True, if the buyside inventory setup is complete for this proposal.
*/
isSetupComplete?: boolean;
/**
- * The role of the last user that either updated the proposal or left a
- * comment. @OutputOnly
+ * Output only. The role of the last user that either updated the proposal or left a comment.
*/
lastUpdaterOrCommentorRole?: string;
/**
- * The notes associated with this proposal. @OutputOnly
+ * Output only. The notes associated with this proposal.
*/
notes?: Schema$Note[];
/**
- * Indicates whether the buyer/seller created the proposal. @OutputOnly
+ * Output only. Indicates whether the buyer/seller created the proposal.
*/
originatorRole?: string;
/**
- * Private auction ID if this proposal is a private auction proposal.
- * @OutputOnly
+ * Output only. Private auction ID if this proposal is a private auction proposal.
*/
privateAuctionId?: string;
/**
- * The unique ID of the proposal. @OutputOnly
+ * Output only. The unique ID of the proposal.
*/
proposalId?: string;
/**
- * The revision number for the proposal. Each update to the proposal or the
- * deal causes the proposal revision number to auto-increment. The buyer
- * keeps track of the last revision number they know of and pass it in when
- * making an update. If the head revision number on the server has since
- * incremented, then an ABORTED error is returned during the update
- * operation to let the buyer know that a subsequent update was made.
- * @OutputOnly
+ * Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
*/
proposalRevision?: string;
/**
- * The current state of the proposal. @OutputOnly
+ * Output only. The current state of the proposal.
*/
proposalState?: string;
/**
- * Reference to the seller on the proposal. Note: This field may be set
- * only when creating the resource. Modifying this field while updating the
- * resource will result in an error.
+ * Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
seller?: Schema$Seller;
/**
- * Contact information for the seller. @OutputOnly
+ * Output only. Contact information for the seller.
*/
sellerContacts?: Schema$ContactInformation[];
/**
- * The time when the proposal was last revised. @OutputOnly
+ * Output only. The time when the proposal was last revised.
*/
updateTime?: string;
}
/**
- * Note: this resource requires whitelisting for access. Please contact your
- * account manager for access to Marketplace resources. Represents a
- * publisher profile in Marketplace. All fields are read only. All string
- * fields are free-form text entered by the publisher unless noted otherwise.
+ * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.
*/
export interface Schema$PublisherProfile {
/**
@@ -2107,14 +1740,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
audienceDescription?: string;
/**
- * Statement explaining what's unique about publisher's business,
- * and why buyers should partner with the publisher.
+ * Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
*/
buyerPitchStatement?: string;
/**
- * Contact information for direct reservation deals. This is free text
- * entered by the publisher and may include information like names, phone
- * numbers and email addresses.
+ * Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
*/
directDealsContact?: string;
/**
@@ -2122,10 +1752,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
displayName?: string;
/**
- * The list of domains represented in this publisher profile. Empty if this
- * is a parent profile. These are top private domains, meaning that these
- * will not contain a string like "photos.google.co.uk/123", but
- * will instead contain "google.co.uk".
+ * The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk".
*/
domains?: string[];
/**
@@ -2133,8 +1760,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
googlePlusUrl?: string;
/**
- * A Google public URL to the logo for this publisher profile. The logo is
- * stored as a PNG, JPG, or GIF image.
+ * A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
*/
logoUrl?: string;
/**
@@ -2146,9 +1772,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
overview?: string;
/**
- * Contact information for programmatic deals. This is free text entered by
- * the publisher and may include information like names, phone numbers and
- * email addresses.
+ * Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
*/
programmaticDealsContact?: string;
/**
@@ -2168,15 +1792,12 @@ export namespace adexchangebuyer2_v2beta1 {
*/
seller?: Schema$Seller;
/**
- * Up to three key metrics and rankings. Max 100 characters each. For
- * example "#1 Mobile News Site for 20 Straight Months".
+ * Up to three key metrics and rankings. Max 100 characters each. For example "#1 Mobile News Site for 20 Straight Months".
*/
topHeadlines?: string[];
}
/**
- * An open-ended realtime time range specified by the start timestamp. For
- * filter sets that specify a realtime time range RTB metrics continue to be
- * aggregated throughout the lifetime of the filter set.
+ * An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set.
*/
export interface Schema$RealtimeTimeRange {
/**
@@ -2185,36 +1806,15 @@ export namespace adexchangebuyer2_v2beta1 {
startTimestamp?: string;
}
/**
- * A specific filtering status and how many times it occurred.
- */
- export interface Schema$Reason {
- /**
- * The number of times the creative was filtered for the status. The count
- * is aggregated across all publishers on the exchange.
- */
- count?: string;
- /**
- * The filtering status code. Please refer to the
- * [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
- * file for different statuses.
- */
- status?: number;
- }
- /**
- * A relative date range, specified by an offset and a duration. The supported
- * range of dates begins 30 days before today and ends today, i.e., the limits
- * for these values are: offset_days >= 0 duration_days >= 1 offset_days
- * + duration_days <= 30
+ * A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30
*/
export interface Schema$RelativeDateRange {
/**
- * The number of days in the requested date range, e.g., for a range
- * spanning today: 1. For a range spanning the last 7 days: 7.
+ * The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7.
*/
durationDays?: number;
/**
- * The end date of the filter set, specified as the number of days before
- * today, e.g., for a range where the last date is today: 0.
+ * The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0.
*/
offsetDays?: number;
}
@@ -2228,19 +1828,15 @@ export namespace adexchangebuyer2_v2beta1 {
association?: Schema$CreativeDealAssociation;
}
/**
- * Request message to resume (unpause) serving for an already-finalized
- * proposal.
+ * Request message to resume (unpause) serving for an already-finalized proposal.
*/
export interface Schema$ResumeProposalRequest {}
/**
- * A response may include multiple rows, breaking down along various
- * dimensions. Encapsulates the values of all dimensions for a given row.
+ * A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row.
*/
export interface Schema$RowDimensions {
/**
- * The publisher identifier for this row, if a breakdown by
- * [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension)
- * was requested.
+ * The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested.
*/
publisherIdentifier?: string;
/**
@@ -2249,7 +1845,7 @@ export namespace adexchangebuyer2_v2beta1 {
timeInterval?: Schema$TimeInterval;
}
/**
- * @OutputOnly A security context.
+ * Output only. A security context.
*/
export interface Schema$SecurityContext {
/**
@@ -2258,13 +1854,11 @@ export namespace adexchangebuyer2_v2beta1 {
securities?: string[];
}
/**
- * Represents a seller of inventory. Each seller is identified by a unique Ad
- * Manager account ID.
+ * Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID.
*/
export interface Schema$Seller {
/**
- * The unique ID for the seller. The seller fills in this field. The seller
- * account ID is then available to buyer in the product.
+ * The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product.
*/
accountId?: string;
/**
@@ -2289,8 +1883,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
auctionType?: Schema$AuctionContext;
/**
- * Matches impressions coming from users *or* publishers in a specific
- * location.
+ * Matches impressions coming from users *or* publishers in a specific location.
*/
location?: Schema$LocationContext;
/**
@@ -2303,10 +1896,7 @@ export namespace adexchangebuyer2_v2beta1 {
securityType?: Schema$SecurityContext;
}
/**
- * @OutputOnly A representation of the status of an ad in a specific context.
- * A context here relates to where something ultimately serves (for example, a
- * user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of
- * auction).
+ * Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
*/
export interface Schema$ServingRestriction {
/**
@@ -2314,26 +1904,20 @@ export namespace adexchangebuyer2_v2beta1 {
*/
contexts?: Schema$ServingContext[];
/**
- * Disapproval bound to this restriction. Only present if
- * status=DISAPPROVED. Can be used to filter the response of the
- * creatives.list method.
+ * Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
*/
disapproval?: Schema$Disapproval;
/**
- * Any disapprovals bound to this restriction. Only present if
- * status=DISAPPROVED. Can be used to filter the response of the
- * creatives.list method. Deprecated; please use disapproval field instead.
+ * Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
*/
disapprovalReasons?: Schema$Disapproval[];
/**
- * The status of the creative in this context (for example, it has been
- * explicitly disapproved or is pending review).
+ * The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
*/
status?: string;
}
/**
- * Message depicting the size of the creative. The units of width and height
- * depend on the type of the targeting.
+ * Message depicting the size of the creative. The units of width and height depend on the type of the targeting.
*/
export interface Schema$Size {
/**
@@ -2350,26 +1934,19 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$StopWatchingCreativeRequest {}
/**
- * Advertisers can target different attributes of an ad slot. For example,
- * they can choose to show ads only if the user is in the U.S. Such targeting
- * criteria can be specified as part of Shared Targeting.
+ * Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting.
*/
export interface Schema$TargetingCriteria {
/**
- * The list of values to exclude from targeting. Each value is AND'd
- * together.
+ * The list of values to exclude from targeting. Each value is AND'd together.
*/
exclusions?: Schema$TargetingValue[];
/**
- * The list of value to include as part of the targeting. Each value is
- * OR'd together.
+ * The list of value to include as part of the targeting. Each value is OR'd together.
*/
inclusions?: Schema$TargetingValue[];
/**
- * The key representing the shared targeting criterion. Targeting criteria
- * defined by Google ad servers will begin with GOOG_. Third parties may
- * define their own keys. A list of permissible keys along with the
- * acceptable values will be provided as part of the external documentation.
+ * The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation.
*/
key?: string;
}
@@ -2378,14 +1955,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$TargetingValue {
/**
- * The creative size value to include/exclude. Filled in when key =
- * GOOG_CREATIVE_SIZE
+ * The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE
*/
creativeSizeValue?: Schema$CreativeSize;
/**
- * The daypart targeting to include / exclude. Filled in when the key is
- * GOOG_DAYPART_TARGETING. The definition of this targeting is derived from
- * the structure used by Ad Manager.
+ * The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager.
*/
dayPartTargetingValue?: Schema$DayPartTargeting;
/**
@@ -2419,26 +1993,20 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$TimeInterval {
/**
- * The timestamp marking the end of the range (exclusive) for which data is
- * included.
+ * The timestamp marking the end of the range (exclusive) for which data is included.
*/
endTime?: string;
/**
- * The timestamp marking the start of the range (inclusive) for which data
- * is included.
+ * The timestamp marking the start of the range (inclusive) for which data is included.
*/
startTime?: string;
}
/**
- * Represents a time of day. The date and time zone are either not significant
- * or are specified elsewhere. An API may choose to allow leap seconds.
- * Related types are google.type.Date and `google.protobuf.Timestamp`.
+ * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
*/
export interface Schema$TimeOfDay {
/**
- * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
- * to allow the value "24:00:00" for scenarios like business
- * closing time.
+ * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
*/
hours?: number;
/**
@@ -2450,16 +2018,12 @@ export namespace adexchangebuyer2_v2beta1 {
*/
nanos?: number;
/**
- * Seconds of minutes of the time. Must normally be from 0 to 59. An API may
- * allow the value 60 if it allows leap-seconds.
+ * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
*/
seconds?: number;
}
/**
- * Represents a list of targeted and excluded URLs (e.g., google.com). For
- * Private Auction and AdX Preferred Deals, URLs are either included or
- * excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't
- * apply.
+ * Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.
*/
export interface Schema$UrlTargeting {
/**
@@ -2480,8 +2044,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
videoUrl?: string;
/**
- * The contents of a VAST document for a video ad. This document should
- * conform to the VAST 2.0 or 3.0 standard.
+ * The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
*/
videoVastXml?: string;
}
@@ -2490,14 +2053,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$VideoTargeting {
/**
- * A list of video positions to be excluded. Position types can either be
- * included or excluded (XOR).
+ * A list of video positions to be excluded. Position types can either be included or excluded (XOR).
*/
excludedPositionTypes?: string[];
/**
- * A list of video positions to be included. When the included list is
- * present, the excluded list must be empty. When the excluded list is
- * present, the included list must be empty.
+ * A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty.
*/
targetedPositionTypes?: string[];
}
@@ -2506,10 +2066,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
export interface Schema$WatchCreativeRequest {
/**
- * The Pub/Sub topic to publish notifications to. This topic must already
- * exist and must give permission to ad-exchange-buyside-reports@google.com
- * to write to the topic. This should be the full resource name in
- * "projects/{project_id}/topics/{topic_id}" format.
+ * The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in "projects/{project_id}/topics/{topic_id}" format.
*/
topic?: string;
}
@@ -2859,8 +2416,7 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique numerical account ID for the buyer of which the client buyer is a
- * customer; the sponsor buyer to create a client for. (required)
+ * Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)
*/
accountId?: string;
@@ -2897,20 +2453,15 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * Requested page size. The server may return fewer clients than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer clients than requested. If unspecified, the 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 ListClientsResponse.nextPageToken
- * returned from the previous call to the accounts.clients.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method.
*/
pageToken?: string;
/**
- * Optional unique identifier (from the standpoint of an Ad Exchange sponsor
- * buyer partner) of the client to return. If specified, at most one client
- * will be returned in the response.
+ * Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.
*/
partnerClientId?: string;
}
@@ -2922,8 +2473,7 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique numerical account ID for the buyer of which the client buyer is a
- * customer; the sponsor buyer to update a client for. (required)
+ * Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)
*/
accountId?: string;
/**
@@ -2945,8 +2495,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.clients.invitations.create
- * @desc Creates and sends out an email invitation to access an Ad Exchange
- * client buyer account.
+ * @desc Creates and sends out an email invitation to access an Ad Exchange client buyer account.
* @alias adexchangebuyer2.accounts.clients.invitations.create
* @memberOf! ()
*
@@ -3104,8 +2653,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.clients.invitations.list
- * @desc Lists all the client users invitations for a client with a given
- * account ID.
+ * @desc Lists all the client users invitations for a client with a given account ID.
* @alias adexchangebuyer2.accounts.clients.invitations.list
* @memberOf! ()
*
@@ -3203,8 +2751,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * Numerical account ID of the client buyer that the user should be
- * associated with. (required)
+ * Numerical account ID of the client buyer that the user should be associated with. (required)
*/
clientAccountId?: string;
@@ -3225,8 +2772,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * Numerical account ID of the client buyer that the user invitation to be
- * retrieved is associated with. (required)
+ * Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)
*/
clientAccountId?: string;
/**
@@ -3246,22 +2792,15 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * Numerical account ID of the client buyer to list invitations for.
- * (required) You must either specify a string representation of a numerical
- * account identifier or the `-` character to list all the invitations for
- * all the clients of a given sponsor buyer.
+ * Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer.
*/
clientAccountId?: string;
/**
- * Requested page size. Server may return fewer clients than requested. If
- * unspecified, server will pick an appropriate default.
+ * Requested page size. Server may return fewer clients 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
- * ListClientUserInvitationsResponse.nextPageToken returned from the
- * previous call to the clients.invitations.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.
*/
pageToken?: string;
}
@@ -3351,8 +2890,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.clients.users.list
- * @desc Lists all the known client users for a specified sponsor buyer
- * account ID.
+ * @desc Lists all the known client users for a specified sponsor buyer account ID.
* @alias adexchangebuyer2.accounts.clients.users.list
* @memberOf! ()
*
@@ -3432,8 +2970,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.clients.users.update
- * @desc Updates an existing client user. Only the user status can be
- * changed on update.
+ * @desc Updates an existing client user. Only the user status can be changed on update.
* @alias adexchangebuyer2.accounts.clients.users.update
* @memberOf! ()
*
@@ -3522,8 +3059,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * Numerical account ID of the client buyer that the user to be retrieved is
- * associated with. (required)
+ * Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)
*/
clientAccountId?: string;
/**
@@ -3539,27 +3075,19 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Numerical account ID of the sponsor buyer of the client to list users
- * for. (required)
+ * Numerical account ID of the sponsor buyer of the client to list users for. (required)
*/
accountId?: string;
/**
- * The account ID of the client buyer to list users for. (required) You must
- * specify either a string representation of a numerical account identifier
- * or the `-` character to list all the client users for all the clients of
- * a given sponsor buyer.
+ * The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.
*/
clientAccountId?: string;
/**
- * Requested page size. The server may return fewer clients than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer clients than requested. If unspecified, the 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 ListClientUsersResponse.nextPageToken
- * returned from the previous call to the accounts.clients.users.list
- * method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.
*/
pageToken?: string;
}
@@ -3575,8 +3103,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * Numerical account ID of the client buyer that the user to be retrieved is
- * associated with. (required)
+ * Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)
*/
clientAccountId?: string;
/**
@@ -3830,8 +3357,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.creatives.stopWatching
- * @desc Stops watching a creative. Will stop push notifications being sent
- * to the topics when the creative changes status.
+ * @desc Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.
* @alias adexchangebuyer2.accounts.creatives.stopWatching
* @memberOf! ()
*
@@ -3980,8 +3506,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.creatives.watch
- * @desc Watches a creative. Will result in push notifications being sent to
- * the topic when the creative changes status.
+ * @desc Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.
* @alias adexchangebuyer2.accounts.creatives.watch
* @memberOf! ()
*
@@ -4063,13 +3588,11 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The account that this creative belongs to. Can be used to filter the
- * response of the creatives.list method.
+ * The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
*/
accountId?: string;
/**
- * Indicates if multiple creatives can share an ID or not. Default is
- * NO_DUPLICATES (one ID per creative).
+ * Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).
*/
duplicateIdMode?: string;
@@ -4102,34 +3625,19 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The account to list the creatives from. Specify "-" to list all creatives
- * the current user has access to.
+ * The account to list the creatives from. Specify "-" to list all creatives the current user has access to.
*/
accountId?: string;
/**
- * Requested page size. The server may return fewer creatives than requested
- * (due to timeout constraint) even if more are available via another call.
- * If unspecified, server will pick an appropriate default. Acceptable
- * values are 1 to 1000, inclusive.
+ * Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
*/
pageSize?: number;
/**
- * A token identifying a page of results the server should return.
- * Typically, this is the value of ListCreativesResponse.next_page_token
- * returned from the previous call to 'ListCreatives' method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method.
*/
pageToken?: string;
/**
- * An optional query string to filter creatives. If no filter is specified,
- * all active creatives will be returned. Supported queries are:
- * - accountId=account_id_string
- *
- creativeId=creative_id_string
- dealsStatus: {approved,
- * conditionally_approved, disapproved, not_checked}
- *
- openAuctionStatus: {approved, conditionally_approved, disapproved,
- * not_checked}
- attribute: {a numeric attribute from the list of
- * attributes}
- disapprovalReason: {a reason from DisapprovalReason}
- *
Example: 'accountId=12345 AND (dealsStatus:disapproved AND
- * disapprovalReason:unacceptable_content) OR attribute:47'
+ * An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are:
- accountId=account_id_string
- creativeId=creative_id_string
- dealsStatus: {approved, conditionally_approved, disapproved, not_checked}
- openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked}
- attribute: {a numeric attribute from the list of attributes}
- disapprovalReason: {a reason from DisapprovalReason}
Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'
*/
query?: string;
}
@@ -4145,8 +3653,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * The creative ID of the creative to stop notifications for. Specify "-" to
- * specify stopping account level notifications.
+ * The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications.
*/
creativeId?: string;
@@ -4163,13 +3670,11 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The account that this creative belongs to. Can be used to filter the
- * response of the creatives.list method.
+ * The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
*/
accountId?: string;
/**
- * The buyer-defined creative ID of this creative. Can be used to filter the
- * response of the creatives.list method.
+ * The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
*/
creativeId?: string;
@@ -4190,10 +3695,7 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * The creative ID to watch for status changes. Specify "-" to watch all
- * creatives under the above account. If both creative-level and
- * account-level notifications are sent, only a single notification will be
- * sent to the creative-level notification topic.
+ * The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.
*/
creativeId?: string;
@@ -4477,36 +3979,23 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The account to list the associations from. Specify "-" to list all
- * creatives the current user has access to.
+ * The account to list the associations from. Specify "-" to list all creatives the current user has access to.
*/
accountId?: string;
/**
- * The creative ID to list the associations from. Specify "-" to list all
- * creatives under the above account.
+ * The creative ID to list the associations from. Specify "-" to list all creatives under the above account.
*/
creativeId?: string;
/**
- * Requested page size. Server may return fewer associations than requested.
- * If unspecified, server will pick an appropriate default.
+ * Requested page size. Server may return fewer associations 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
- * ListDealAssociationsResponse.next_page_token returned from the previous
- * call to 'ListDealAssociations' method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.
*/
pageToken?: string;
/**
- * An optional query string to filter deal associations. If no filter is
- * specified, all associations will be returned. Supported queries are:
- * - accountId=account_id_string
- *
- creativeId=creative_id_string
- *
- dealsId=deals_id_string
- dealsStatus:{approved,
- * conditionally_approved, disapproved, not_checked}
- *
- openAuctionStatus:{approved, conditionally_approved, disapproved,
- * not_checked}
Example: 'dealsId=12345 AND dealsStatus:disapproved'
+ * An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=account_id_string
- creativeId=creative_id_string
- dealsId=deals_id_string
- dealsStatus:{approved, conditionally_approved, disapproved, not_checked}
- openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked}
Example: 'dealsId=12345 AND dealsStatus:disapproved'
*/
query?: string;
}
@@ -4540,9 +4029,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.finalizedProposals.list
- * @desc List finalized proposals, regardless if a proposal is being
- * renegotiated. A filter expression (PQL query) may be specified to filter
- * the results. The notes will not be returned.
+ * @desc List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.
* @alias adexchangebuyer2.accounts.finalizedProposals.list
* @memberOf! ()
*
@@ -4633,19 +4120,15 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * An optional PQL filter query used to query for proposals. Nested
- * repeated fields, such as proposal.deals.targetingCriterion, cannot be
- * filtered.
+ * An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
*/
filter?: string;
/**
- * Syntax the filter is written in. Current implementation defaults to PQL
- * but in the future it will be LIST_FILTER.
+ * Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
*/
filterSyntax?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
@@ -4735,8 +4218,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.products.list
- * @desc List all products visible to the buyer (optionally filtered by the
- * specified PQL query).
+ * @desc List all products visible to the buyer (optionally filtered by the specified PQL query).
* @alias adexchangebuyer2.accounts.products.list
* @memberOf! ()
*
@@ -4843,15 +4325,11 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * An optional PQL query used to query for products. See
- * https://developers.google.com/ad-manager/docs/pqlreference for
- * documentation about PQL and examples. Nested repeated fields, such as
- * product.targetingCriterion.inclusions, cannot be filtered.
+ * An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered.
*/
filter?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
@@ -4868,10 +4346,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.accept
- * @desc Mark the proposal as accepted at the given revision number. If the
- * number does not match the server's revision number an `ABORTED` error
- * message will be returned. This call updates the proposal_state from
- * `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.
+ * @desc Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.
* @alias adexchangebuyer2.accounts.proposals.accept
* @memberOf! ()
*
@@ -4946,9 +4421,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.addNote
- * @desc Create a new note and attach it to the proposal. The note is
- * assigned a unique ID by the server. The proposal revision number will not
- * increase when associated with a new note.
+ * @desc Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.
* @alias adexchangebuyer2.accounts.proposals.addNote
* @memberOf! ()
*
@@ -5023,9 +4496,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.cancelNegotiation
- * @desc Cancel an ongoing negotiation on a proposal. This does not cancel
- * or end serving for the deals if the proposal has been finalized, but only
- * cancels a negotiation unilaterally.
+ * @desc Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.
* @alias adexchangebuyer2.accounts.proposals.cancelNegotiation
* @memberOf! ()
*
@@ -5100,13 +4571,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.completeSetup
- * @desc Update the given proposal to indicate that setup has been
- * completed. This method is called by the buyer when the line items have
- * been created on their end for a finalized proposal and all the required
- * creatives have been uploaded using the creatives API. This call updates
- * the `is_setup_completed` bit on the proposal and also notifies the
- * seller. The server will advance the revision number of the most recent
- * proposal.
+ * @desc Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the `is_setup_completed` bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal.
* @alias adexchangebuyer2.accounts.proposals.completeSetup
* @memberOf! ()
*
@@ -5181,8 +4646,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.create
- * @desc Create the given proposal. Each created proposal and any deals it
- * contains are assigned a unique ID by the server.
+ * @desc Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.
* @alias adexchangebuyer2.accounts.proposals.create
* @memberOf! ()
*
@@ -5256,8 +4720,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.get
- * @desc Gets a proposal given its ID. The proposal is returned at its head
- * revision.
+ * @desc Gets a proposal given its ID. The proposal is returned at its head revision.
* @alias adexchangebuyer2.accounts.proposals.get
* @memberOf! ()
*
@@ -5330,12 +4793,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.list
- * @desc List proposals. A filter expression (PQL query) may be specified to
- * filter the results. To retrieve all finalized proposals, regardless if a
- * proposal is being renegotiated, see the FinalizedProposals resource. Note
- * that Bidder/ChildSeat relationships differ from the usual behavior. A
- * Bidder account can only see its child seats' proposals by specifying the
- * ChildSeat's accountId in the request path.
+ * @desc List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.
* @alias adexchangebuyer2.accounts.proposals.list
* @memberOf! ()
*
@@ -5416,11 +4874,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.pause
- * @desc Update the given proposal to pause serving. This method will set
- * the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true
- * for all deals in the proposal. It is a no-op to pause an already-paused
- * proposal. It is an error to call PauseProposal for a proposal that is not
- * finalized or renegotiating.
+ * @desc Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.
* @alias adexchangebuyer2.accounts.proposals.pause
* @memberOf! ()
*
@@ -5495,12 +4949,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.resume
- * @desc Update the given proposal to resume serving. This method will set
- * the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false
- * for all deals in the proposal. Note that if the `has_seller_paused` bit
- * is also set, serving will not resume until the seller also resumes. It
- * is a no-op to resume an already-running proposal. It is an error to call
- * ResumeProposal for a proposal that is not finalized or renegotiating.
+ * @desc Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.
* @alias adexchangebuyer2.accounts.proposals.resume
* @memberOf! ()
*
@@ -5575,16 +5024,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.accounts.proposals.update
- * @desc Update the given proposal at the client known revision number. If
- * the server revision has advanced since the passed-in
- * `proposal.proposal_revision`, an `ABORTED` error message will be
- * returned. Only the buyer-modifiable fields of the proposal will be
- * updated. Note that the deals in the proposal will be updated to match
- * the passed-in copy. If a passed-in deal does not have a `deal_id`, the
- * server will assign a new unique ID and create the deal. If passed-in deal
- * has a `deal_id`, it will be updated to match the passed-in copy. Any
- * existing deals not present in the passed-in proposal will be deleted. It
- * is an error to pass in a deal with a `deal_id` not present at head.
+ * @desc Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head.
* @alias adexchangebuyer2.accounts.proposals.update
* @memberOf! ()
*
@@ -5786,19 +5226,15 @@ export namespace adexchangebuyer2_v2beta1 {
*/
accountId?: string;
/**
- * An optional PQL filter query used to query for proposals. Nested
- * repeated fields, such as proposal.deals.targetingCriterion, cannot be
- * filtered.
+ * An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
*/
filter?: string;
/**
- * Syntax the filter is written in. Current implementation defaults to PQL
- * but in the future it will be LIST_FILTER.
+ * Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
*/
filterSyntax?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
@@ -6135,8 +5571,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.create
- * @desc Creates the specified filter set for the account with the given
- * account ID.
+ * @desc Creates the specified filter set for the account with the given account ID.
* @alias adexchangebuyer2.bidders.accounts.filterSets.create
* @memberOf! ()
*
@@ -6213,8 +5648,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.delete
- * @desc Deletes the requested filter set from the account with the given
- * account ID.
+ * @desc Deletes the requested filter set from the account with the given account ID.
* @alias adexchangebuyer2.bidders.accounts.filterSets.delete
* @memberOf! ()
*
@@ -6284,8 +5718,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.get
- * @desc Retrieves the requested filter set for the account with the given
- * account ID.
+ * @desc Retrieves the requested filter set for the account with the given account ID.
* @alias adexchangebuyer2.bidders.accounts.filterSets.get
* @memberOf! ()
*
@@ -6443,18 +5876,11 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether the filter set is transient, or should be persisted indefinitely.
- * By default, filter sets are not transient. If transient, it will be
- * available for at least 1 hour after creation.
+ * Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
*/
isTransient?: boolean;
/**
- * Name of the owner (bidder or account) of the filter set to be created.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123` - For an account-level filter set for the buyer account
- * representing bidder 123: `bidders/123/accounts/123` - For an
- * account-level filter set for the child seat buyer account 456 whose
- * bidder is 123: `bidders/123/accounts/456`
+ * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
*/
ownerName?: string;
@@ -6471,12 +5897,7 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Full name of the resource to delete. For example: - For a bidder-level
- * filter set for bidder 123: `bidders/123/filterSets/abc` - For an
- * account-level filter set for the buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
name?: string;
}
@@ -6488,12 +5909,7 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Full name of the resource being requested. For example: - For a
- * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` -
- * For an account-level filter set for the buyer account representing bidder
- * 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level
- * filter set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
name?: string;
}
@@ -6505,23 +5921,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the owner (bidder or account) of the filter sets to be listed.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123` - For an account-level filter set for the buyer account
- * representing bidder 123: `bidders/123/accounts/123` - For an
- * account-level filter set for the child seat buyer account 456 whose
- * bidder is 123: `bidders/123/accounts/456`
+ * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
*/
ownerName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListFilterSetsResponse.nextPageToken
- * returned from the previous call to the accounts.filterSets.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.
*/
pageToken?: string;
}
@@ -6620,24 +6028,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListBidMetricsResponse.nextPageToken
- * returned from the previous call to the bidMetrics.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.
*/
pageToken?: string;
}
@@ -6650,10 +6049,8 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list
- * @desc List all errors that occurred in bid responses, with the number of
- * bid responses affected for each reason.
- * @alias
- * adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list
+ * @desc List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
+ * @alias adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -6744,25 +6141,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListBidResponseErrorsResponse.nextPageToken returned from the previous
- * call to the bidResponseErrors.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.
*/
pageToken?: string;
}
@@ -6775,11 +6162,8 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list
- * @desc List all reasons for which bid responses were considered to have no
- * applicable bids, with the number of bid responses affected for each
- * reason.
- * @alias
- * adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list
+ * @desc List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
+ * @alias adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -6872,25 +6256,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListBidResponsesWithoutBidsResponse.nextPageToken returned from the
- * previous call to the bidResponsesWithoutBids.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.
*/
pageToken?: string;
}
@@ -6903,10 +6277,8 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list
- * @desc List all reasons that caused a bid request not to be sent for an
- * impression, with the number of bid requests not sent for each reason.
- * @alias
- * adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list
+ * @desc List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
+ * @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -6997,25 +6369,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListFilteredBidRequestsResponse.nextPageToken returned from the previous
- * call to the filteredBidRequests.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.
*/
pageToken?: string;
}
@@ -7036,8 +6398,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list
- * @desc List all reasons for which bids were filtered, with the number of
- * bids filtered for each reason.
+ * @desc List all reasons for which bids were filtered, with the number of bids filtered for each reason.
* @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list
* @memberOf! ()
*
@@ -7123,24 +6484,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListFilteredBidsResponse.nextPageToken
- * returned from the previous call to the filteredBids.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.
*/
pageToken?: string;
}
@@ -7153,10 +6505,8 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list
- * @desc List all creatives associated with a specific reason for which bids
- * were filtered, with the number of bids filtered for each creative.
- * @alias
- * adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list
+ * @desc List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
+ * @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -7265,31 +6615,19 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The ID of the creative status for which to retrieve a breakdown by
- * creative. See
- * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
+ * The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
*/
creativeStatusId?: number;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from
- * the previous call to the filteredBids.creatives.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.
*/
pageToken?: string;
}
@@ -7302,10 +6640,8 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list
- * @desc List all details associated with a specific reason for which bids
- * were filtered, with the number of bids filtered for each detail.
- * @alias
- * adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list
+ * @desc List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
+ * @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -7414,33 +6750,19 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The ID of the creative status for which to retrieve a breakdown by
- * detail. See
- * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
- * Details are only available for statuses 10, 14, 15, 17, 18, 19, 86,
- * and 87.
+ * The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.
*/
creativeStatusId?: number;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from
- * the previous call to the filteredBids.details.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.
*/
pageToken?: string;
}
@@ -7453,10 +6775,8 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list
- * @desc Lists all metrics that are measured in terms of number of
- * impressions.
- * @alias
- * adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list
+ * @desc Lists all metrics that are measured in terms of number of impressions.
+ * @alias adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -7547,25 +6867,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListImpressionMetricsResponse.nextPageToken returned from the previous
- * call to the impressionMetrics.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.
*/
pageToken?: string;
}
@@ -7578,8 +6888,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.losingBids.list
- * @desc List all reasons for which bids lost in the auction, with the
- * number of bids that lost for each reason.
+ * @desc List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
* @alias adexchangebuyer2.bidders.accounts.filterSets.losingBids.list
* @memberOf! ()
*
@@ -7665,24 +6974,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListLosingBidsResponse.nextPageToken
- * returned from the previous call to the losingBids.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.
*/
pageToken?: string;
}
@@ -7695,10 +6995,8 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list
- * @desc List all reasons for which winning bids were not billable, with the
- * number of bids not billed for each reason.
- * @alias
- * adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list
+ * @desc List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
+ * @alias adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -7789,25 +7087,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListNonBillableWinningBidsResponse.nextPageToken returned from the
- * previous call to the nonBillableWinningBids.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.
*/
pageToken?: string;
}
@@ -7852,8 +7140,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.create
- * @desc Creates the specified filter set for the account with the given
- * account ID.
+ * @desc Creates the specified filter set for the account with the given account ID.
* @alias adexchangebuyer2.bidders.filterSets.create
* @memberOf! ()
*
@@ -7930,8 +7217,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.delete
- * @desc Deletes the requested filter set from the account with the given
- * account ID.
+ * @desc Deletes the requested filter set from the account with the given account ID.
* @alias adexchangebuyer2.bidders.filterSets.delete
* @memberOf! ()
*
@@ -8001,8 +7287,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.get
- * @desc Retrieves the requested filter set for the account with the given
- * account ID.
+ * @desc Retrieves the requested filter set for the account with the given account ID.
* @alias adexchangebuyer2.bidders.filterSets.get
* @memberOf! ()
*
@@ -8160,18 +7445,11 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether the filter set is transient, or should be persisted indefinitely.
- * By default, filter sets are not transient. If transient, it will be
- * available for at least 1 hour after creation.
+ * Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
*/
isTransient?: boolean;
/**
- * Name of the owner (bidder or account) of the filter set to be created.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123` - For an account-level filter set for the buyer account
- * representing bidder 123: `bidders/123/accounts/123` - For an
- * account-level filter set for the child seat buyer account 456 whose
- * bidder is 123: `bidders/123/accounts/456`
+ * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
*/
ownerName?: string;
@@ -8188,12 +7466,7 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Full name of the resource to delete. For example: - For a bidder-level
- * filter set for bidder 123: `bidders/123/filterSets/abc` - For an
- * account-level filter set for the buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
name?: string;
}
@@ -8205,12 +7478,7 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Full name of the resource being requested. For example: - For a
- * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` -
- * For an account-level filter set for the buyer account representing bidder
- * 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level
- * filter set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
name?: string;
}
@@ -8222,23 +7490,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the owner (bidder or account) of the filter sets to be listed.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123` - For an account-level filter set for the buyer account
- * representing bidder 123: `bidders/123/accounts/123` - For an
- * account-level filter set for the child seat buyer account 456 whose
- * bidder is 123: `bidders/123/accounts/456`
+ * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
*/
ownerName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListFilterSetsResponse.nextPageToken
- * returned from the previous call to the accounts.filterSets.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.
*/
pageToken?: string;
}
@@ -8337,24 +7597,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListBidMetricsResponse.nextPageToken
- * returned from the previous call to the bidMetrics.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.
*/
pageToken?: string;
}
@@ -8367,8 +7618,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.bidResponseErrors.list
- * @desc List all errors that occurred in bid responses, with the number of
- * bid responses affected for each reason.
+ * @desc List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
* @alias adexchangebuyer2.bidders.filterSets.bidResponseErrors.list
* @memberOf! ()
*
@@ -8460,25 +7710,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListBidResponseErrorsResponse.nextPageToken returned from the previous
- * call to the bidResponseErrors.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.
*/
pageToken?: string;
}
@@ -8491,9 +7731,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list
- * @desc List all reasons for which bid responses were considered to have no
- * applicable bids, with the number of bid responses affected for each
- * reason.
+ * @desc List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
* @alias adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list
* @memberOf! ()
*
@@ -8587,25 +7825,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListBidResponsesWithoutBidsResponse.nextPageToken returned from the
- * previous call to the bidResponsesWithoutBids.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.
*/
pageToken?: string;
}
@@ -8618,8 +7846,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.filteredBidRequests.list
- * @desc List all reasons that caused a bid request not to be sent for an
- * impression, with the number of bid requests not sent for each reason.
+ * @desc List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
* @alias adexchangebuyer2.bidders.filterSets.filteredBidRequests.list
* @memberOf! ()
*
@@ -8711,25 +7938,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListFilteredBidRequestsResponse.nextPageToken returned from the previous
- * call to the filteredBidRequests.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.
*/
pageToken?: string;
}
@@ -8750,8 +7967,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.filteredBids.list
- * @desc List all reasons for which bids were filtered, with the number of
- * bids filtered for each reason.
+ * @desc List all reasons for which bids were filtered, with the number of bids filtered for each reason.
* @alias adexchangebuyer2.bidders.filterSets.filteredBids.list
* @memberOf! ()
*
@@ -8837,24 +8053,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListFilteredBidsResponse.nextPageToken
- * returned from the previous call to the filteredBids.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.
*/
pageToken?: string;
}
@@ -8867,8 +8074,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list
- * @desc List all creatives associated with a specific reason for which bids
- * were filtered, with the number of bids filtered for each creative.
+ * @desc List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
* @alias adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list
* @memberOf! ()
*
@@ -8978,31 +8184,19 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The ID of the creative status for which to retrieve a breakdown by
- * creative. See
- * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
+ * The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
*/
creativeStatusId?: number;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from
- * the previous call to the filteredBids.creatives.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.
*/
pageToken?: string;
}
@@ -9015,8 +8209,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.filteredBids.details.list
- * @desc List all details associated with a specific reason for which bids
- * were filtered, with the number of bids filtered for each detail.
+ * @desc List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
* @alias adexchangebuyer2.bidders.filterSets.filteredBids.details.list
* @memberOf! ()
*
@@ -9126,33 +8319,19 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The ID of the creative status for which to retrieve a breakdown by
- * detail. See
- * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
- * Details are only available for statuses 10, 14, 15, 17, 18, 19, 86,
- * and 87.
+ * The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.
*/
creativeStatusId?: number;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from
- * the previous call to the filteredBids.details.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.
*/
pageToken?: string;
}
@@ -9165,8 +8344,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.impressionMetrics.list
- * @desc Lists all metrics that are measured in terms of number of
- * impressions.
+ * @desc Lists all metrics that are measured in terms of number of impressions.
* @alias adexchangebuyer2.bidders.filterSets.impressionMetrics.list
* @memberOf! ()
*
@@ -9258,25 +8436,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListImpressionMetricsResponse.nextPageToken returned from the previous
- * call to the impressionMetrics.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.
*/
pageToken?: string;
}
@@ -9289,8 +8457,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.losingBids.list
- * @desc List all reasons for which bids lost in the auction, with the
- * number of bids that lost for each reason.
+ * @desc List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
* @alias adexchangebuyer2.bidders.filterSets.losingBids.list
* @memberOf! ()
*
@@ -9376,24 +8543,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListLosingBidsResponse.nextPageToken
- * returned from the previous call to the losingBids.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.
*/
pageToken?: string;
}
@@ -9406,8 +8564,7 @@ export namespace adexchangebuyer2_v2beta1 {
/**
* adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list
- * @desc List all reasons for which winning bids were not billable, with the
- * number of bids not billed for each reason.
+ * @desc List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
* @alias adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list
* @memberOf! ()
*
@@ -9499,25 +8656,15 @@ export namespace adexchangebuyer2_v2beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Name of the filter set that should be applied to the requested metrics.
- * For example: - For a bidder-level filter set for bidder 123:
- * `bidders/123/filterSets/abc` - For an account-level filter set for the
- * buyer account representing bidder 123:
- * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter
- * set for the child seat buyer account 456 whose bidder is 123:
- * `bidders/123/accounts/456/filterSets/abc`
+ * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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
- * ListNonBillableWinningBidsResponse.nextPageToken returned from the
- * previous call to the nonBillableWinningBids.list method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.
*/
pageToken?: string;
}
diff --git a/src/apis/adexperiencereport/package.json b/src/apis/adexperiencereport/package.json
index 3959fd32adb..a4c7f117436 100644
--- a/src/apis/adexperiencereport/package.json
+++ b/src/apis/adexperiencereport/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/adexperiencereport/v1.ts b/src/apis/adexperiencereport/v1.ts
index 80c84a14b8a..5ef1ced9a48 100644
--- a/src/apis/adexperiencereport/v1.ts
+++ b/src/apis/adexperiencereport/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace adexperiencereport_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace adexperiencereport_v1 {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace adexperiencereport_v1 {
/**
* Ad Experience Report API
*
- * Views Ad Experience Report data, and gets a list of sites that have a
- * significant number of annoying ads.
+ * Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads.
*
* @example
* const {google} = require('googleapis');
@@ -114,7 +109,10 @@ export namespace adexperiencereport_v1 {
violatingSites: Resource$Violatingsites;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.sites = new Resource$Sites(this.context);
this.violatingSites = new Resource$Violatingsites(this.context);
@@ -266,14 +264,7 @@ export namespace adexperiencereport_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The required site name. It should be the site property whose ad
- * experiences may have been reviewed, and it should be URL-encoded. For
- * example, sites/https%3A%2F%2Fwww.google.com. The server will return an
- * error of BAD_REQUEST if this field is not filled in. Note that if the
- * site property is not yet verified in Search Console, the reportUrl field
- * returned by the API will lead to the verification page, prompting the
- * user to go through that process before they can gain access to the Ad
- * Experience Report.
+ * The required site name. It should be the site property whose ad experiences may have been reviewed, and it should be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The server will return an error of BAD_REQUEST if this field is not filled in. Note that if the site property is not yet verified in Search Console, the reportUrl field returned by the API will lead to the verification page, prompting the user to go through that process before they can gain access to the Ad Experience Report.
*/
name?: string;
}
@@ -286,8 +277,7 @@ export namespace adexperiencereport_v1 {
/**
* adexperiencereport.violatingSites.list
- * @desc Lists sites with Ad Experience Report statuses of "Failing" or
- * "Warning".
+ * @desc Lists sites with Ad Experience Report statuses of "Failing" or "Warning".
* @alias adexperiencereport.violatingSites.list
* @memberOf! ()
*
diff --git a/src/apis/admin/datatransfer_v1.ts b/src/apis/admin/datatransfer_v1.ts
index fcfc7e95b51..482f15aedae 100644
--- a/src/apis/admin/datatransfer_v1.ts
+++ b/src/apis/admin/datatransfer_v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace admin_datatransfer_v1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace admin_datatransfer_v1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -96,7 +93,10 @@ export namespace admin_datatransfer_v1 {
transfers: Resource$Transfers;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.applications = new Resource$Applications(this.context);
this.transfers = new Resource$Transfers(this.context);
@@ -124,9 +124,7 @@ export namespace admin_datatransfer_v1 {
*/
name?: string;
/**
- * The list of all possible transfer parameters for this application. These
- * parameters can be used to select the data of the user in this application
- * to be transfered.
+ * The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.
*/
transferParams?: Schema$ApplicationTransferParam[];
}
@@ -139,8 +137,7 @@ export namespace admin_datatransfer_v1 {
*/
applicationId?: string;
/**
- * The transfer parameters for the application. These parameters are used to
- * select the data which will get transfered in context of this application.
+ * The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
*/
applicationTransferParams?: Schema$ApplicationTransferParam[];
/**
@@ -153,8 +150,7 @@ export namespace admin_datatransfer_v1 {
*/
export interface Schema$ApplicationsListResponse {
/**
- * List of applications that support data transfer and are also installed
- * for the customer.
+ * List of applications that support data transfer and are also installed for the customer.
*/
applications?: Schema$Application[];
/**
@@ -179,8 +175,7 @@ export namespace admin_datatransfer_v1 {
*/
key?: string;
/**
- * The value of the coressponding transfer parameter. eg: 'PRIVATE'
- * or 'SHARED'
+ * The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
*/
value?: string[];
}
@@ -189,11 +184,7 @@ export namespace admin_datatransfer_v1 {
*/
export interface Schema$DataTransfer {
/**
- * List of per application data transfer resources. It contains data
- * transfer details of the applications associated with this transfer
- * resource. Note that this list is also used to specify the applications
- * for which data transfer has to be done at the time of the transfer
- * resource creation.
+ * List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
*/
applicationDataTransfers?: Schema$ApplicationDataTransfer[];
/**
@@ -255,8 +246,7 @@ export namespace admin_datatransfer_v1 {
/**
* datatransfer.applications.get
- * @desc Retrieves information about an application for the given
- * application ID.
+ * @desc Retrieves information about an application for the given application ID.
* @alias datatransfer.applications.get
* @memberOf! ()
*
@@ -590,8 +580,7 @@ export namespace admin_datatransfer_v1 {
/**
* datatransfer.transfers.list
- * @desc Lists the transfers for a customer by source user, destination
- * user, or status.
+ * @desc Lists the transfers for a customer by source user, destination user, or status.
* @alias datatransfer.transfers.list
* @memberOf! ()
*
@@ -682,8 +671,7 @@ export namespace admin_datatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * ID of the resource to be retrieved. This is returned in the response from
- * the insert method.
+ * ID of the resource to be retrieved. This is returned in the response from the insert method.
*/
dataTransferId?: string;
}
diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts
index c97b5546361..0440d9a5583 100644
--- a/src/apis/admin/directory_v1.ts
+++ b/src/apis/admin/directory_v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace admin_directory_v1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace admin_directory_v1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -78,8 +75,7 @@ export namespace admin_directory_v1 {
/**
* Admin Directory API
*
- * Manages enterprise resources such as users and groups, administrative
- * notifications, security features, and more.
+ * Manages enterprise resources such as users and groups, administrative notifications, security features, and more.
*
* @example
* const {google} = require('googleapis');
@@ -115,7 +111,10 @@ export namespace admin_directory_v1 {
verificationCodes: Resource$Verificationcodes;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.asps = new Resource$Asps(this.context);
this.channels = new Resource$Channels(this.context);
@@ -163,8 +162,7 @@ export namespace admin_directory_v1 {
*/
kind?: string;
/**
- * Group's primary email (Read-only) User's primary email
- * (Read-only)
+ * Group's primary email (Read-only) User's primary email (Read-only)
*/
primaryEmail?: string;
}
@@ -194,13 +192,11 @@ export namespace admin_directory_v1 {
*/
blockedApiAccessBuckets?: string[];
/**
- * Boolean to indicate whether to enforce app access settings on Android
- * Drive or not.
+ * Boolean to indicate whether to enforce app access settings on Android Drive or not.
*/
enforceSettingsForAndroidDrive?: boolean;
/**
- * Error message provided by the Admin that will be shown to the user when
- * an app is blocked.
+ * Error message provided by the Admin that will be shown to the user when an app is blocked.
*/
errorMessage?: string;
/**
@@ -208,8 +204,7 @@ export namespace admin_directory_v1 {
*/
etag?: string;
/**
- * Identifies the resource as an app access collection. Value:
- * admin#directory#appaccesscollection
+ * Identifies the resource as an app access collection. Value: admin#directory#appaccesscollection
*/
kind?: string;
/**
@@ -217,8 +212,7 @@ export namespace admin_directory_v1 {
*/
resourceId?: string;
/**
- * Resource name given by the customer while creating/updating. Should be
- * unique under given customer.
+ * Resource name given by the customer while creating/updating. Should be unique under given customer.
*/
resourceName?: string;
/**
@@ -251,8 +245,7 @@ export namespace admin_directory_v1 {
*/
lastTimeUsed?: string;
/**
- * The name of the application that the user, represented by their userId,
- * entered when the ASP was created.
+ * The name of the application that the user, represented by their userId, entered when the ASP was created.
*/
name?: string;
/**
@@ -279,8 +272,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$Building {
/**
- * The postal address of the building. See PostalAddress for details. Note
- * that only a single address line and region code are required.
+ * The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
*/
address?: Schema$BuildingAddress;
/**
@@ -288,19 +280,15 @@ export namespace admin_directory_v1 {
*/
buildingId?: string;
/**
- * The building name as seen by users in Calendar. Must be unique for the
- * customer. For example, "NYC-CHEL". The maximum length is 100
- * characters.
+ * The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
*/
buildingName?: string;
/**
- * The geographic coordinates of the center of the building, expressed as
- * latitude and longitude in decimal degrees.
+ * The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
*/
coordinates?: Schema$BuildingCoordinates;
/**
- * A brief description of the building. For example, "Chelsea
- * Market".
+ * A brief description of the building. For example, "Chelsea Market".
*/
description?: string;
/**
@@ -308,11 +296,7 @@ export namespace admin_directory_v1 {
*/
etags?: string;
/**
- * The display names for all floors in this building. The floors are
- * expected to be sorted in ascending order, from lowest floor to highest
- * floor. For example, ["B2", "B1", "L",
- * "1", "2", "2M", "3",
- * "PH"] Must contain at least one entry.
+ * The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
*/
floorNames?: string[];
/**
@@ -329,20 +313,15 @@ export namespace admin_directory_v1 {
*/
addressLines?: string[];
/**
- * Optional. Highest administrative subdivision which is used for postal
- * addresses of a country or region.
+ * Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
*/
administrativeArea?: string;
/**
- * Optional. BCP-47 language code of the contents of this address (if
- * known).
+ * Optional. BCP-47 language code of the contents of this address (if known).
*/
languageCode?: string;
/**
- * Optional. Generally refers to the city/town portion of the address.
- * Examples: US city, IT comune, UK post town. In regions of the world where
- * localities are not well defined or do not fit into this structure well,
- * leave locality empty and use addressLines.
+ * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
*/
locality?: string;
/**
@@ -388,8 +367,7 @@ export namespace admin_directory_v1 {
*/
kind?: string;
/**
- * The continuation token, used to page through large result sets. Provide
- * this value in a subsequent request to return the next page of results.
+ * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string;
}
@@ -419,19 +397,15 @@ export namespace admin_directory_v1 {
*/
floorSection?: string;
/**
- * The read-only auto-generated name of the calendar resource which includes
- * metadata about the resource such as building name, floor, capacity, etc.
- * For example, "NYC-2-Training Room 1A (16)".
+ * The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, "NYC-2-Training Room 1A (16)".
*/
generatedResourceName?: string;
/**
- * The type of the resource. For calendar resources, the value is
- * admin#directory#resources#calendars#CalendarResource.
+ * The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
*/
kind?: string;
/**
- * The category of the calendar resource. Either CONFERENCE_ROOM or OTHER.
- * Legacy data is set to CATEGORY_UNKNOWN.
+ * The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
*/
resourceCategory?: string;
/**
@@ -439,8 +413,7 @@ export namespace admin_directory_v1 {
*/
resourceDescription?: string;
/**
- * The read-only email for the calendar resource. Generated as part of
- * creating a new calendar resource.
+ * The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
*/
resourceEmail?: string;
/**
@@ -448,8 +421,7 @@ export namespace admin_directory_v1 {
*/
resourceId?: string;
/**
- * The name of the calendar resource. For example, "Training Room
- * 1A".
+ * The name of the calendar resource. For example, "Training Room 1A".
*/
resourceName?: string;
/**
@@ -474,13 +446,11 @@ export namespace admin_directory_v1 {
*/
items?: Schema$CalendarResource[];
/**
- * Identifies this as a collection of CalendarResources. This is always
- * admin#directory#resources#calendars#calendarResourcesList.
+ * Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.
*/
kind?: string;
/**
- * The continuation token, used to page through large result sets. Provide
- * this value in a subsequent request to return the next page of results.
+ * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string;
}
@@ -493,8 +463,7 @@ export namespace admin_directory_v1 {
*/
address?: string;
/**
- * Date and time of notification channel expiration, expressed as a Unix
- * timestamp, in milliseconds. Optional.
+ * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
*/
expiration?: string;
/**
@@ -502,8 +471,7 @@ export namespace admin_directory_v1 {
*/
id?: string;
/**
- * Identifies this as a notification channel used to watch for changes to a
- * resource. Value: the fixed string "api#channel".
+ * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
*/
kind?: string;
/**
@@ -515,8 +483,7 @@ export namespace admin_directory_v1 {
*/
payload?: boolean;
/**
- * An opaque ID that identifies the resource being watched on this channel.
- * Stable across different API versions.
+ * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
*/
resourceId?: string;
/**
@@ -524,8 +491,7 @@ export namespace admin_directory_v1 {
*/
resourceUri?: string;
/**
- * An arbitrary string delivered to the target address with each
- * notification delivered over this channel. Optional.
+ * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
*/
token?: string;
/**
@@ -609,8 +575,7 @@ export namespace admin_directory_v1 {
*/
lastEnrollmentTime?: string;
/**
- * Date and time the device was last synchronized with the policy settings
- * in the G Suite administrator control panel (Read-only)
+ * Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
*/
lastSync?: string;
/**
@@ -618,8 +583,7 @@ export namespace admin_directory_v1 {
*/
macAddress?: string;
/**
- * Mobile Equipment identifier for the 3G mobile card in the Chromebook
- * (Read-only)
+ * Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
*/
meid?: string;
/**
@@ -647,8 +611,7 @@ export namespace admin_directory_v1 {
*/
platformVersion?: string;
/**
- * List of recent device users, in descending order by last login time
- * (Read-only)
+ * List of recent device users, in descending order by last login time (Read-only)
*/
recentUsers?: Array<{email?: string; type?: string}>;
/**
@@ -691,8 +654,7 @@ export namespace admin_directory_v1 {
willAutoRenew?: boolean;
}
/**
- * JSON request template for firing actions on ChromeOs Device in Directory
- * Devices API.
+ * JSON request template for firing actions on ChromeOs Device in Directory Devices API.
*/
export interface Schema$ChromeOsDeviceAction {
/**
@@ -702,8 +664,7 @@ export namespace admin_directory_v1 {
deprovisionReason?: string;
}
/**
- * JSON response template for List Chrome OS Devices operation in Directory
- * API.
+ * JSON response template for List Chrome OS Devices operation in Directory API.
*/
export interface Schema$ChromeOsDevices {
/**
@@ -724,8 +685,7 @@ export namespace admin_directory_v1 {
nextPageToken?: string;
}
/**
- * JSON request template for moving ChromeOs Device to given OU in Directory
- * Devices API.
+ * JSON request template for moving ChromeOs Device to given OU in Directory Devices API.
*/
export interface Schema$ChromeOsMoveDevicesToOu {
/**
@@ -738,8 +698,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$Customer {
/**
- * The customer's secondary contact email address. This email address
- * cannot be on the same domain as the customerDomain
+ * The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
*/
alternateEmail?: string;
/**
@@ -747,8 +706,7 @@ export namespace admin_directory_v1 {
*/
customerCreationTime?: string;
/**
- * The customer's primary domain name string. Do not include the www
- * prefix when creating a new customer.
+ * The customer's primary domain name string. Do not include the www prefix when creating a new customer.
*/
customerDomain?: string;
/**
@@ -781,8 +739,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$CustomerPostalAddress {
/**
- * A customer's physical address. The address can be composed of one to
- * three lines.
+ * A customer's physical address. The address can be composed of one to three lines.
*/
addressLine1?: string;
/**
@@ -798,13 +755,11 @@ export namespace admin_directory_v1 {
*/
contactName?: string;
/**
- * This is a required property. For countryCode information see the ISO 3166
- * country code elements.
+ * This is a required property. For countryCode information see the ISO 3166 country code elements.
*/
countryCode?: string;
/**
- * Name of the locality. An example of a locality value is the city of San
- * Francisco.
+ * Name of the locality. An example of a locality value is the city of San Francisco.
*/
locality?: string;
/**
@@ -812,14 +767,11 @@ export namespace admin_directory_v1 {
*/
organizationName?: string;
/**
- * The postal code. A postalCode example is a postal zip code such as 10009.
- * This is in accordance with -
- * http://portablecontacts.net/draft-spec.html#address_element.
+ * The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
*/
postalCode?: string;
/**
- * Name of the region. An example of a region value is NY for the state of
- * New York.
+ * Name of the region. An example of a region value is NY for the state of New York.
*/
region?: string;
}
@@ -844,8 +796,7 @@ export namespace admin_directory_v1 {
*/
kind?: string;
/**
- * The parent domain name that the domain alias is associated with. This can
- * either be a primary or secondary domain name within a customer.
+ * The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
*/
parentDomainName?: string;
/**
@@ -942,8 +893,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$FeatureInstance {
/**
- * The feature that this is an instance of. A calendar resource may have
- * multiple instances of a feature.
+ * The feature that this is an instance of. A calendar resource may have multiple instances of a feature.
*/
feature?: Schema$Feature;
}
@@ -973,8 +923,7 @@ export namespace admin_directory_v1 {
*/
kind?: string;
/**
- * The continuation token, used to page through large result sets. Provide
- * this value in a subsequent request to return the next page of results.
+ * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string;
}
@@ -1061,8 +1010,7 @@ export namespace admin_directory_v1 {
*/
etag?: string;
/**
- * Unique identifier of customer member (Read-only) Unique identifier of
- * group (Read-only) Unique identifier of member (Read-only)
+ * Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
*/
id?: string;
/**
@@ -1108,8 +1056,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$MembersHasMember {
/**
- * Identifies whether the given user is a member of the group. Membership
- * can be direct or nested.
+ * Identifies whether the given user is a member of the group. Membership can be direct or nested.
*/
isMember?: boolean;
}
@@ -1180,8 +1127,7 @@ export namespace admin_directory_v1 {
*/
etag?: string;
/**
- * Date and time the device was first synchronized with the policy settings
- * in the G Suite administrator control panel (Read-only)
+ * Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)
*/
firstSync?: string;
/**
@@ -1205,13 +1151,11 @@ export namespace admin_directory_v1 {
*/
kind?: string;
/**
- * Date and time the device was last synchronized with the policy settings
- * in the G Suite administrator control panel (Read-only)
+ * Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
*/
lastSync?: string;
/**
- * Boolean indicating if this account is on owner/primary profile or not
- * (Read-only)
+ * Boolean indicating if this account is on owner/primary profile or not (Read-only)
*/
managedAccountIsOnOwnerProfile?: boolean;
/**
@@ -1288,8 +1232,7 @@ export namespace admin_directory_v1 {
wifiMacAddress?: string;
}
/**
- * JSON request template for firing commands on Mobile Device in Directory
- * Devices API.
+ * JSON request template for firing commands on Mobile Device in Directory Devices API.
*/
export interface Schema$MobileDeviceAction {
/**
@@ -1419,8 +1362,7 @@ export namespace admin_directory_v1 {
parentOrgUnitPath?: string;
}
/**
- * JSON response template for List Organization Units operation in Directory
- * API.
+ * JSON response template for List Organization Units operation in Directory API.
*/
export interface Schema$OrgUnits {
/**
@@ -1441,9 +1383,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$Privilege {
/**
- * A list of child privileges. Privileges for a service form a tree. Each
- * privilege can have a list of child privileges; this list is empty for a
- * leaf privilege.
+ * A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.
*/
childPrivileges?: Schema$Privilege[];
/**
@@ -1538,13 +1478,11 @@ export namespace admin_directory_v1 {
*/
etag?: string;
/**
- * The type of the API resource. This is always
- * admin#directory#roleAssignment.
+ * The type of the API resource. This is always admin#directory#roleAssignment.
*/
kind?: string;
/**
- * If the role is restricted to an organization unit, this contains the ID
- * for the organization unit the exercise of this role is restricted to.
+ * If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
*/
orgUnitId?: string;
/**
@@ -1556,8 +1494,7 @@ export namespace admin_directory_v1 {
*/
roleId?: string;
/**
- * The scope in which this role is assigned. Possible values are: -
- * CUSTOMER - ORG_UNIT
+ * The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT
*/
scopeType?: string;
}
@@ -1574,8 +1511,7 @@ export namespace admin_directory_v1 {
*/
items?: Schema$RoleAssignment[];
/**
- * The type of the API resource. This is always
- * admin#directory#roleAssignments.
+ * The type of the API resource. This is always admin#directory#roleAssignments.
*/
kind?: string;
nextPageToken?: string;
@@ -1664,15 +1600,11 @@ export namespace admin_directory_v1 {
*/
multiValued?: boolean;
/**
- * Indexing spec for a numeric field. By default, only exact match queries
- * will be supported for numeric fields. Setting the numericIndexingSpec
- * allows range queries to be supported.
+ * Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
*/
numericIndexingSpec?: {maxValue?: number; minValue?: number};
/**
- * Read ACLs on the field specifying who can view values of this field.
- * Valid values are "ALL_DOMAIN_USERS" and
- * "ADMINS_AND_SELF".
+ * Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
*/
readAccessType?: string;
}
@@ -1698,8 +1630,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$Token {
/**
- * Whether the application is registered with Google. The value is true if
- * the application has an anonymous Client ID.
+ * Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.
*/
anonymous?: boolean;
/**
@@ -1719,8 +1650,7 @@ export namespace admin_directory_v1 {
*/
kind?: string;
/**
- * Whether the token is issued to an installed application. The value is
- * true if the application is installed to a desktop or mobile device.
+ * Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.
*/
nativeApp?: boolean;
/**
@@ -1927,9 +1857,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$UserAbout {
/**
- * About entry can have a type which indicates the content type. It can
- * either be plain or html. By default, notes contents are assumed to
- * contain plain text.
+ * About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text.
*/
contentType?: string;
/**
@@ -1974,8 +1902,7 @@ export namespace admin_directory_v1 {
*/
postalCode?: string;
/**
- * If this is user's primary address. Only one entry could be marked as
- * primary.
+ * If this is user's primary address. Only one entry could be marked as primary.
*/
primary?: boolean;
/**
@@ -1983,9 +1910,7 @@ export namespace admin_directory_v1 {
*/
region?: string;
/**
- * User supplied address was structured. Structured addresses are NOT
- * supported at this time. You might be able to write structured addresses,
- * but any values will eventually be clobbered.
+ * User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses, but any values will eventually be clobbered.
*/
sourceIsStructured?: boolean;
/**
@@ -1993,17 +1918,12 @@ export namespace admin_directory_v1 {
*/
streetAddress?: string;
/**
- * Each entry can have a type which indicates standard values of that entry.
- * For example address could be of home, work etc. In addition to the
- * standard type, an entry can have a custom type and can take any value.
- * Such type should have the CUSTOM value as type and also have a customType
- * value.
+ * Each entry can have a type which indicates standard values of that entry. For example address could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value.
*/
type?: string;
}
/**
- * JSON template for a set of custom properties (i.e. all fields in a
- * particular schema)
+ * JSON template for a set of custom properties (i.e. all fields in a particular schema)
*/
export interface Schema$UserCustomProperties {}
/**
@@ -2019,15 +1939,11 @@ export namespace admin_directory_v1 {
*/
customType?: string;
/**
- * If this is user's primary email. Only one entry could be marked as
- * primary.
+ * If this is user's primary email. Only one entry could be marked as primary.
*/
primary?: boolean;
/**
- * Each entry can have a type which indicates standard types of that entry.
- * For example email could be of home, work etc. In addition to the standard
- * type, an entry can have a custom type and can take any value Such types
- * should have the CUSTOM value as type and also have a customType value.
+ * Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value.
*/
type?: string;
}
@@ -2050,9 +1966,7 @@ export namespace admin_directory_v1 {
}
export interface Schema$UserGender {
/**
- * AddressMeAs. A human-readable string containing the proper way to refer
- * to the profile owner by humans, for example "he/him/his" or
- * "they/them/their".
+ * AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans, for example "he/him/his" or "they/them/their".
*/
addressMeAs?: string;
/**
@@ -2081,22 +1995,15 @@ export namespace admin_directory_v1 {
*/
im?: string;
/**
- * If this is user's primary im. Only one entry could be marked as
- * primary.
+ * If this is user's primary im. Only one entry could be marked as primary.
*/
primary?: boolean;
/**
- * Protocol used in the instant messenger. It should be one of the values
- * from ImProtocolTypes map. Similar to type, it can take a CUSTOM value and
- * specify the custom name in customProtocol field.
+ * Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type, it can take a CUSTOM value and specify the custom name in customProtocol field.
*/
protocol?: string;
/**
- * Each entry can have a type which indicates standard types of that entry.
- * For example instant messengers could be of home, work etc. In addition to
- * the standard type, an entry can have a custom type and can take any
- * value. Such types should have the CUSTOM value as type and also have a
- * customType value.
+ * Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value.
*/
type?: string;
}
@@ -2109,11 +2016,7 @@ export namespace admin_directory_v1 {
*/
customType?: string;
/**
- * Each entry can have a type which indicates standard type of that entry.
- * For example, keyword could be of type occupation or outlook. In addition
- * to the standard type, an entry can have a custom type and can give it any
- * name. Such types should have the CUSTOM value as type and also have a
- * customType value.
+ * Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.
*/
type?: string;
/**
@@ -2126,14 +2029,11 @@ export namespace admin_directory_v1 {
*/
export interface Schema$UserLanguage {
/**
- * Other language. User can provide own language name if there is no
- * corresponding Google III language code. If this is set LanguageCode
- * can't be set
+ * Other language. User can provide own language name if there is no corresponding Google III language code. If this is set LanguageCode can't be set
*/
customLanguage?: string;
/**
- * Language Code. Should be used for storing Google III LanguageCode string
- * representation for language. Illegal values cause SchemaException.
+ * Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.
*/
languageCode?: string;
}
@@ -2142,9 +2042,7 @@ export namespace admin_directory_v1 {
*/
export interface Schema$UserLocation {
/**
- * Textual location. This is most useful for display purposes to concisely
- * describe the location. For example, "Mountain View, CA",
- * "Near Seattle", "US-NYC-9TH 9A209A".
+ * Textual location. This is most useful for display purposes to concisely describe the location. For example, "Mountain View, CA", "Near Seattle", "US-NYC-9TH 9A209A".
*/
area?: string;
/**
@@ -2164,23 +2062,16 @@ export namespace admin_directory_v1 {
*/
floorName?: string;
/**
- * Floor section. More specific location within the floor. For example, if a
- * floor is divided into sections "A", "B", and
- * "C", this field would identify one of those values.
+ * Floor section. More specific location within the floor. For example, if a floor is divided into sections "A", "B", and "C", this field would identify one of those values.
*/
floorSection?: string;
/**
- * Each entry can have a type which indicates standard types of that entry.
- * For example location could be of types default and desk. In addition to
- * standard type, an entry can have a custom type and can give it any name.
- * Such types should have "custom" as type and also have a
- * customType value.
+ * Each entry can have a type which indicates standard types of that entry. For example location could be of types default and desk. In addition to standard type, an entry can have a custom type and can give it any name. Such types should have "custom" as type and also have a customType value.
*/
type?: string;
}
/**
- * JSON request template for setting/revoking admin status of a user in
- * Directory API.
+ * JSON request template for setting/revoking admin status of a user in Directory API.
*/
export interface Schema$UserMakeAdmin {
/**
@@ -2254,11 +2145,7 @@ export namespace admin_directory_v1 {
*/
title?: string;
/**
- * Each entry can have a type which indicates standard types of that entry.
- * For example organization could be of school, work etc. In addition to the
- * standard type, an entry can have a custom type and can give it any name.
- * Such types should have the CUSTOM value as type and also have a
- * CustomType value.
+ * Each entry can have a type which indicates standard types of that entry. For example organization could be of school, work etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value.
*/
type?: string;
}
@@ -2275,11 +2162,7 @@ export namespace admin_directory_v1 {
*/
primary?: boolean;
/**
- * Each entry can have a type which indicates standard types of that entry.
- * For example phone could be of home_fax, work, mobile etc. In addition to
- * the standard type, an entry can have a custom type and can give it any
- * name. Such types should have the CUSTOM value as type and also have a
- * customType value.
+ * Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax, work, mobile etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.
*/
type?: string;
/**
@@ -2325,8 +2208,7 @@ export namespace admin_directory_v1 {
width?: number;
}
/**
- * JSON template for a POSIX account entry. Description of the field family:
- * go/fbs-posix.
+ * JSON template for a POSIX account entry. Description of the field family: go/fbs-posix.
*/
export interface Schema$UserPosixAccount {
/**
@@ -2379,8 +2261,7 @@ export namespace admin_directory_v1 {
*/
customType?: string;
/**
- * The relation of the user. Some of the possible values are mother, father,
- * sister, brother, manager, assistant, partner.
+ * The relation of the user. Some of the possible values are mother, father, sister, brother, manager, assistant, partner.
*/
type?: string;
/**
@@ -2452,11 +2333,7 @@ export namespace admin_directory_v1 {
*/
primary?: boolean;
/**
- * Each entry can have a type which indicates standard types of that entry.
- * For example website could be of home, work, blog etc. In addition to the
- * standard type, an entry can have a custom type and can give it any name.
- * Such types should have the CUSTOM value as type and also have a
- * customType value.
+ * Each entry can have a type which indicates standard types of that entry. For example website could be of home, work, blog etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.
*/
type?: string;
/**
@@ -2473,8 +2350,7 @@ export namespace admin_directory_v1 {
*/
etag?: string;
/**
- * The type of the resource. This is always
- * admin#directory#verificationCode.
+ * The type of the resource. This is always admin#directory#verificationCode.
*/
kind?: string;
/**
@@ -2482,14 +2358,12 @@ export namespace admin_directory_v1 {
*/
userId?: string;
/**
- * A current verification code for the user. Invalidated or used
- * verification codes are not returned as part of the result.
+ * A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.
*/
verificationCode?: string;
}
/**
- * JSON response template for List verification codes operation in Directory
- * API.
+ * JSON response template for List verification codes operation in Directory API.
*/
export interface Schema$VerificationCodes {
/**
@@ -2501,8 +2375,7 @@ export namespace admin_directory_v1 {
*/
items?: Schema$VerificationCode[];
/**
- * The type of the resource. This is always
- * admin#directory#verificationCodesList.
+ * The type of the resource. This is always admin#directory#verificationCodesList.
*/
kind?: string;
}
@@ -2738,8 +2611,7 @@ export namespace admin_directory_v1 {
*/
codeId?: number;
/**
- * Identifies the user in the API request. The value can be the user's
- * primary email address, alias email address, or unique user ID.
+ * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
*/
userKey?: string;
}
@@ -2754,8 +2626,7 @@ export namespace admin_directory_v1 {
*/
codeId?: number;
/**
- * Identifies the user in the API request. The value can be the user's
- * primary email address, alias email address, or unique user ID.
+ * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
*/
userKey?: string;
}
@@ -2766,8 +2637,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifies the user in the API request. The value can be the user's
- * primary email address, alias email address, or unique user ID.
+ * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
*/
userKey?: string;
}
@@ -3400,13 +3270,11 @@ export namespace admin_directory_v1 {
*/
projection?: string;
/**
- * Search string in the format given at
- * http://support.google.com/chromeos/a/bin/answer.py?answer=1698333
+ * Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?answer=1698333
*/
query?: string;
/**
- * Whether to return results in ascending or descending order. Only of use
- * when orderBy is also used
+ * Whether to return results in ascending or descending order. Only of use when orderBy is also used
*/
sortOrder?: string;
}
@@ -4687,8 +4555,7 @@ export namespace admin_directory_v1 {
/**
* directory.groups.list
- * @desc Retrieve all groups of a domain or of a user given a userKey
- * (paginated)
+ * @desc Retrieve all groups of a domain or of a user given a userKey (paginated)
* @alias directory.groups.list
* @memberOf! ()
*
@@ -4949,13 +4816,11 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Immutable ID of the G Suite account. In case of multi-domain, to fetch
- * all groups for a customer, fill this field instead of domain.
+ * Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
*/
customer?: string;
/**
- * Name of the domain. Fill this field to get groups from only this domain.
- * To return all groups in a multi-domain fill customer field instead.
+ * Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
*/
domain?: string;
/**
@@ -4971,20 +4836,15 @@ export namespace admin_directory_v1 {
*/
pageToken?: string;
/**
- * Query string search. Should be of the form "". Complete documentation is
- * at
- * https://developers.google.com/admin-sdk/directory/v1/guides/search-groups
+ * Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups
*/
query?: string;
/**
- * Whether to return results in ascending or descending order. Only of use
- * when orderBy is also used
+ * Whether to return results in ascending or descending order. Only of use when orderBy is also used
*/
sortOrder?: string;
/**
- * Email or immutable Id of the user if only those groups are to be listed,
- * the given user is a member of. If Id, it should match with id of user
- * object
+ * Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object
*/
userKey?: string;
}
@@ -4995,8 +4855,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Email or immutable ID of the group. If ID, it should match with id of
- * group object
+ * Email or immutable ID of the group. If ID, it should match with id of group object
*/
groupKey?: string;
@@ -5012,8 +4871,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Email or immutable ID of the group. If ID, it should match with id of
- * group object
+ * Email or immutable ID of the group. If ID, it should match with id of group object
*/
groupKey?: string;
@@ -5443,8 +5301,7 @@ export namespace admin_directory_v1 {
/**
* directory.members.hasMember
- * @desc Checks whether the given user is a member of the group. Membership
- * can be direct or nested.
+ * @desc Checks whether the given user is a member of the group. Membership can be direct or nested.
* @alias directory.members.hasMember
* @memberOf! ()
*
@@ -5664,8 +5521,7 @@ export namespace admin_directory_v1 {
/**
* directory.members.patch
- * @desc Update membership of a user in the specified group. This method
- * supports patch semantics.
+ * @desc Update membership of a user in the specified group. This method supports patch semantics.
* @alias directory.members.patch
* @memberOf! ()
*
@@ -5848,13 +5704,11 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifies the group in the API request. The value can be the group's
- * email address, group alias, or the unique group ID.
+ * Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
*/
groupKey?: string;
/**
- * Identifies the user member in the API request. The value can be the
- * user's primary email address, alias, or unique ID.
+ * Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.
*/
memberKey?: string;
}
@@ -5908,13 +5762,11 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Email or immutable ID of the group. If ID, it should match with id of
- * group object
+ * Email or immutable ID of the group. If ID, it should match with id of group object
*/
groupKey?: string;
/**
- * Email or immutable ID of the user. If ID, it should match with id of
- * member object
+ * Email or immutable ID of the user. If ID, it should match with id of member object
*/
memberKey?: string;
@@ -5930,13 +5782,11 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Email or immutable ID of the group. If ID, it should match with id of
- * group object
+ * Email or immutable ID of the group. If ID, it should match with id of group object
*/
groupKey?: string;
/**
- * Email or immutable ID of the user. If ID, it should match with id of
- * member object
+ * Email or immutable ID of the user. If ID, it should match with id of member object
*/
memberKey?: string;
@@ -6341,13 +6191,11 @@ export namespace admin_directory_v1 {
*/
projection?: string;
/**
- * Search string in the format given at
- * http://support.google.com/a/bin/answer.py?answer=1408863#search
+ * Search string in the format given at http://support.google.com/a/bin/answer.py?answer=1408863#search
*/
query?: string;
/**
- * Whether to return results in ascending or descending order. Only of use
- * when orderBy is also used
+ * Whether to return results in ascending or descending order. Only of use when orderBy is also used
*/
sortOrder?: string;
}
@@ -6743,8 +6591,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. The customerId is also
- * returned as part of the Users resource.
+ * The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource.
*/
customer?: string;
/**
@@ -6760,8 +6607,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. The customerId is also
- * returned as part of the Users resource.
+ * The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource.
*/
customer?: string;
/**
@@ -6781,8 +6627,7 @@ export namespace admin_directory_v1 {
*/
customer?: string;
/**
- * The ISO 639-1 code of the language notifications are returned in. The
- * default is English (en).
+ * The ISO 639-1 code of the language notifications are returned in. The default is English (en).
*/
language?: string;
/**
@@ -7559,8 +7404,7 @@ export namespace admin_directory_v1 {
/**
* directory.resolvedAppAccessSettings.ListTrustedApps
- * @desc Retrieves the list of apps trusted by the admin of the logged in
- * user.
+ * @desc Retrieves the list of apps trusted by the admin of the logged in user.
* @alias directory.resolvedAppAccessSettings.ListTrustedApps
* @memberOf! ()
*
@@ -8125,9 +7969,7 @@ export namespace admin_directory_v1 {
*/
buildingId?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
}
@@ -8143,9 +7985,7 @@ export namespace admin_directory_v1 {
*/
buildingId?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
}
@@ -8161,9 +8001,7 @@ export namespace admin_directory_v1 {
*/
coordinatesSource?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
@@ -8180,9 +8018,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
/**
@@ -8210,9 +8046,7 @@ export namespace admin_directory_v1 {
*/
coordinatesSource?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
@@ -8237,9 +8071,7 @@ export namespace admin_directory_v1 {
*/
coordinatesSource?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
@@ -8558,10 +8390,7 @@ export namespace admin_directory_v1 {
/**
* directory.resources.calendars.patch
- * @desc Updates a calendar resource. This method supports patch semantics,
- * meaning you only need to include the fields you wish to update. Fields
- * that are not present in the request will be preserved. This method
- * supports patch semantics.
+ * @desc Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. This method supports patch semantics.
* @alias directory.resources.calendars.patch
* @memberOf! ()
*
@@ -8637,9 +8466,7 @@ export namespace admin_directory_v1 {
/**
* directory.resources.calendars.update
- * @desc Updates a calendar resource. This method supports patch semantics,
- * meaning you only need to include the fields you wish to update. Fields
- * that are not present in the request will be preserved.
+ * @desc Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved.
* @alias directory.resources.calendars.update
* @memberOf! ()
*
@@ -8726,9 +8553,7 @@ export namespace admin_directory_v1 {
*/
calendarResourceId?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
}
@@ -8744,9 +8569,7 @@ export namespace admin_directory_v1 {
*/
calendarResourceId?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
}
@@ -8758,9 +8581,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
@@ -8777,9 +8598,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
/**
@@ -8787,12 +8606,7 @@ export namespace admin_directory_v1 {
*/
maxResults?: number;
/**
- * Field(s) to sort results by in either ascending or descending order.
- * Supported fields include resourceId, resourceName, capacity, buildingId,
- * and floorName. If no order is specified, defaults to ascending. Should be
- * of the form "field [asc|desc], field [asc|desc], ...". For example
- * buildingId, capacity desc would return results sorted first by buildingId
- * in ascending order then by capacity in descending order.
+ * Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order.
*/
orderBy?: string;
/**
@@ -8800,14 +8614,7 @@ export namespace admin_directory_v1 {
*/
pageToken?: string;
/**
- * String query used to filter results. Should be of the form "field
- * operator value" where field can be any of supported fields and operators
- * can be any of supported operations. Operators include '=' for exact match
- * and ':' for prefix match or HAS match where applicable. For prefix match,
- * the value should always be followed by a *. Supported fields include
- * generatedResourceName, name, buildingId, featureInstances.feature.name.
- * For example buildingId=US-NYC-9TH AND
- * featureInstances.feature.name:Phone.
+ * String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Supported fields include generatedResourceName, name, buildingId, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone.
*/
query?: string;
}
@@ -8823,9 +8630,7 @@ export namespace admin_directory_v1 {
*/
calendarResourceId?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
@@ -8846,9 +8651,7 @@ export namespace admin_directory_v1 {
*/
calendarResourceId?: string;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
@@ -9388,9 +9191,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
/**
@@ -9406,9 +9207,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
/**
@@ -9424,9 +9223,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
@@ -9443,9 +9240,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
/**
@@ -9465,9 +9260,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
/**
@@ -9488,9 +9281,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
/**
@@ -9511,9 +9302,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique ID for the customer's G Suite account. As an account
- * administrator, you can also use the my_customer alias to represent your
- * account's customer ID.
+ * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
*/
customer?: string;
/**
@@ -9904,13 +9693,11 @@ export namespace admin_directory_v1 {
*/
pageToken?: string;
/**
- * Immutable ID of a role. If included in the request, returns only role
- * assignments containing this role ID.
+ * Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
*/
roleId?: string;
/**
- * The user's primary email address, alias email address, or unique user ID.
- * If included in the request, returns role assignments only for this user.
+ * The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.
*/
userKey?: string;
}
@@ -11143,8 +10930,7 @@ export namespace admin_directory_v1 {
/**
* directory.tokens.list
- * @desc Returns the set of tokens specified user has issued to 3rd party
- * applications.
+ * @desc Returns the set of tokens specified user has issued to 3rd party applications.
* @alias directory.tokens.list
* @memberOf! ()
*
@@ -11224,8 +11010,7 @@ export namespace admin_directory_v1 {
*/
clientId?: string;
/**
- * Identifies the user in the API request. The value can be the user's
- * primary email address, alias email address, or unique user ID.
+ * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
*/
userKey?: string;
}
@@ -11240,8 +11025,7 @@ export namespace admin_directory_v1 {
*/
clientId?: string;
/**
- * Identifies the user in the API request. The value can be the user's
- * primary email address, alias email address, or unique user ID.
+ * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
*/
userKey?: string;
}
@@ -11252,8 +11036,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifies the user in the API request. The value can be the user's
- * primary email address, alias email address, or unique user ID.
+ * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
*/
userKey?: string;
}
@@ -11954,8 +11737,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Comma-separated list of schema names. All fields from these schemas are
- * fetched. This should only be set when projection=custom.
+ * Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
*/
customFieldMask?: string;
/**
@@ -11989,18 +11771,15 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Immutable ID of the G Suite account. In case of multi-domain, to fetch
- * all users for a customer, fill this field instead of domain.
+ * Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
*/
customer?: string;
/**
- * Comma-separated list of schema names. All fields from these schemas are
- * fetched. This should only be set when projection=custom.
+ * Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
*/
customFieldMask?: string;
/**
- * Name of the domain. Fill this field to get users from only this domain.
- * To return all users in a multi-domain fill customer field instead.
+ * Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
*/
domain?: string;
/**
@@ -12024,9 +11803,7 @@ export namespace admin_directory_v1 {
*/
projection?: string;
/**
- * Query string search. Should be of the form "". Complete documentation is
- * at
- * https://developers.google.com/admin-sdk/directory/v1/guides/search-users
+ * Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
*/
query?: string;
/**
@@ -12065,8 +11842,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Email or immutable ID of the user. If ID, it should match with id of user
- * object
+ * Email or immutable ID of the user. If ID, it should match with id of user object
*/
userKey?: string;
@@ -12098,8 +11874,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Email or immutable ID of the user. If ID, it should match with id of user
- * object
+ * Email or immutable ID of the user. If ID, it should match with id of user object
*/
userKey?: string;
@@ -12115,18 +11890,15 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Immutable ID of the G Suite account. In case of multi-domain, to fetch
- * all users for a customer, fill this field instead of domain.
+ * Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
*/
customer?: string;
/**
- * Comma-separated list of schema names. All fields from these schemas are
- * fetched. This should only be set when projection=custom.
+ * Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
*/
customFieldMask?: string;
/**
- * Name of the domain. Fill this field to get users from only this domain.
- * To return all users in a multi-domain fill customer field instead.
+ * Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
*/
domain?: string;
/**
@@ -12150,9 +11922,7 @@ export namespace admin_directory_v1 {
*/
projection?: string;
/**
- * Query string search. Should be of the form "". Complete documentation is
- * at
- * https://developers.google.com/admin-sdk/directory/v1/guides/search-users
+ * Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
*/
query?: string;
/**
@@ -13049,8 +12819,7 @@ export namespace admin_directory_v1 {
/**
* directory.verificationCodes.list
- * @desc Returns the current set of valid backup verification codes for the
- * specified user.
+ * @desc Returns the current set of valid backup verification codes for the specified user.
* @alias directory.verificationCodes.list
* @memberOf! ()
*
@@ -13154,8 +12923,7 @@ export namespace admin_directory_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifies the user in the API request. The value can be the user's
- * primary email address, alias email address, or unique user ID.
+ * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
*/
userKey?: string;
}
diff --git a/src/apis/admin/package.json b/src/apis/admin/package.json
index 3afa1daa4f7..362a3bb6d59 100644
--- a/src/apis/admin/package.json
+++ b/src/apis/admin/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts
index 8ad4711d9d6..1bbca1bb44d 100644
--- a/src/apis/admin/reports_v1.ts
+++ b/src/apis/admin/reports_v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace admin_reports_v1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace admin_reports_v1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -78,8 +75,7 @@ export namespace admin_reports_v1 {
/**
* Admin Reports API
*
- * Fetches reports for the administrators of G Suite customers about the
- * usage, collaboration, security, and risk for their users.
+ * Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.
*
* @example
* const {google} = require('googleapis');
@@ -100,7 +96,10 @@ export namespace admin_reports_v1 {
userUsageReport: Resource$Userusagereport;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.activities = new Resource$Activities(this.context);
this.channels = new Resource$Channels(this.context);
@@ -196,8 +195,7 @@ export namespace admin_reports_v1 {
*/
address?: string;
/**
- * Date and time of notification channel expiration, expressed as a Unix
- * timestamp, in milliseconds. Optional.
+ * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
*/
expiration?: string;
/**
@@ -205,8 +203,7 @@ export namespace admin_reports_v1 {
*/
id?: string;
/**
- * Identifies this as a notification channel used to watch for changes to a
- * resource. Value: the fixed string "api#channel".
+ * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
*/
kind?: string;
/**
@@ -218,8 +215,7 @@ export namespace admin_reports_v1 {
*/
payload?: boolean;
/**
- * An opaque ID that identifies the resource being watched on this channel.
- * Stable across different API versions.
+ * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
*/
resourceId?: string;
/**
@@ -227,8 +223,7 @@ export namespace admin_reports_v1 {
*/
resourceUri?: string;
/**
- * An arbitrary string delivered to the target address with each
- * notification delivered over this channel. Optional.
+ * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
*/
token?: string;
/**
@@ -312,8 +307,7 @@ export namespace admin_reports_v1 {
/**
* reports.activities.list
- * @desc Retrieves a list of activities for a specific customer and
- * application.
+ * @desc Retrieves a list of activities for a specific customer and application.
* @alias reports.activities.list
* @memberOf! ()
*
@@ -484,8 +478,7 @@ export namespace admin_reports_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * IP Address of host where the event was performed. Supports both IPv4 and
- * IPv6 addresses.
+ * IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
*/
actorIpAddress?: string;
/**
@@ -505,8 +498,7 @@ export namespace admin_reports_v1 {
*/
eventName?: string;
/**
- * Event parameters in the form [parameter1 name][operator][parameter1
- * value],[parameter2 name][operator][parameter2 value],...
+ * Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
*/
filters?: string;
/**
@@ -514,8 +506,7 @@ export namespace admin_reports_v1 {
*/
maxResults?: number;
/**
- * the organizational unit's(OU) ID to filter activities from users
- * belonging to a specific OU or one of its sub-OU(s)
+ * the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)
*/
orgUnitID?: string;
/**
@@ -527,9 +518,7 @@ export namespace admin_reports_v1 {
*/
startTime?: string;
/**
- * Represents the profile id or the user email for which the data should be
- * filtered. When 'all' is specified as the userKey, it returns usageReports
- * for all users.
+ * Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.
*/
userKey?: string;
}
@@ -540,8 +529,7 @@ export namespace admin_reports_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * IP Address of host where the event was performed. Supports both IPv4 and
- * IPv6 addresses.
+ * IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
*/
actorIpAddress?: string;
/**
@@ -561,8 +549,7 @@ export namespace admin_reports_v1 {
*/
eventName?: string;
/**
- * Event parameters in the form [parameter1 name][operator][parameter1
- * value],[parameter2 name][operator][parameter2 value],...
+ * Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
*/
filters?: string;
/**
@@ -570,8 +557,7 @@ export namespace admin_reports_v1 {
*/
maxResults?: number;
/**
- * the organizational unit's(OU) ID to filter activities from users
- * belonging to a specific OU or one of its sub-OU(s)
+ * the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)
*/
orgUnitID?: string;
/**
@@ -583,9 +569,7 @@ export namespace admin_reports_v1 {
*/
startTime?: string;
/**
- * Represents the profile id or the user email for which the data should be
- * filtered. When 'all' is specified as the userKey, it returns usageReports
- * for all users.
+ * Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.
*/
userKey?: string;
@@ -692,8 +676,7 @@ export namespace admin_reports_v1 {
/**
* reports.customerUsageReports.get
- * @desc Retrieves a report which is a collection of properties / statistics
- * for a specific customer.
+ * @desc Retrieves a report which is a collection of properties / statistics for a specific customer.
* @alias reports.customerUsageReports.get
* @memberOf! ()
*
@@ -781,8 +764,7 @@ export namespace admin_reports_v1 {
*/
customerId?: string;
/**
- * Represents the date in yyyy-mm-dd format for which the data is to be
- * fetched.
+ * Represents the date in yyyy-mm-dd format for which the data is to be fetched.
*/
date?: string;
/**
@@ -790,8 +772,7 @@ export namespace admin_reports_v1 {
*/
pageToken?: string;
/**
- * Represents the application name, parameter name pairs to fetch in csv as
- * app_name1:param_name1, app_name2:param_name2.
+ * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
*/
parameters?: string;
}
@@ -804,8 +785,7 @@ export namespace admin_reports_v1 {
/**
* reports.entityUsageReports.get
- * @desc Retrieves a report which is a collection of properties / statistics
- * for a set of objects.
+ * @desc Retrieves a report which is a collection of properties / statistics for a set of objects.
* @alias reports.entityUsageReports.get
* @memberOf! ()
*
@@ -897,8 +877,7 @@ export namespace admin_reports_v1 {
*/
customerId?: string;
/**
- * Represents the date in yyyy-mm-dd format for which the data is to be
- * fetched.
+ * Represents the date in yyyy-mm-dd format for which the data is to be fetched.
*/
date?: string;
/**
@@ -922,8 +901,7 @@ export namespace admin_reports_v1 {
*/
pageToken?: string;
/**
- * Represents the application name, parameter name pairs to fetch in csv as
- * app_name1:param_name1, app_name2:param_name2.
+ * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
*/
parameters?: string;
}
@@ -936,8 +914,7 @@ export namespace admin_reports_v1 {
/**
* reports.userUsageReport.get
- * @desc Retrieves a report which is a collection of properties / statistics
- * for a set of users.
+ * @desc Retrieves a report which is a collection of properties / statistics for a set of users.
* @alias reports.userUsageReport.get
* @memberOf! ()
*
@@ -1028,8 +1005,7 @@ export namespace admin_reports_v1 {
*/
customerId?: string;
/**
- * Represents the date in yyyy-mm-dd format for which the data is to be
- * fetched.
+ * Represents the date in yyyy-mm-dd format for which the data is to be fetched.
*/
date?: string;
/**
@@ -1041,8 +1017,7 @@ export namespace admin_reports_v1 {
*/
maxResults?: number;
/**
- * the organizational unit's ID to filter usage parameters from users
- * belonging to a specific OU or one of its sub-OU(s).
+ * the organizational unit's ID to filter usage parameters from users belonging to a specific OU or one of its sub-OU(s).
*/
orgUnitID?: string;
/**
@@ -1050,13 +1025,11 @@ export namespace admin_reports_v1 {
*/
pageToken?: string;
/**
- * Represents the application name, parameter name pairs to fetch in csv as
- * app_name1:param_name1, app_name2:param_name2.
+ * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
*/
parameters?: string;
/**
- * Represents the profile id or the user email for which the data should be
- * filtered.
+ * Represents the profile id or the user email for which the data should be filtered.
*/
userKey?: string;
}
diff --git a/src/apis/adsense/package.json b/src/apis/adsense/package.json
index c0af0c71338..da3c0e9ae89 100644
--- a/src/apis/adsense/package.json
+++ b/src/apis/adsense/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/adsense/v1.4.ts b/src/apis/adsense/v1.4.ts
index 2fd75c2d634..50e7d894e1f 100644
--- a/src/apis/adsense/v1.4.ts
+++ b/src/apis/adsense/v1.4.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace adsense_v1_4 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace adsense_v1_4 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -78,8 +75,7 @@ export namespace adsense_v1_4 {
/**
* AdSense Management API
*
- * Accesses AdSense publishers' inventory and generates performance
- * reports.
+ * Accesses AdSense publishers' inventory and generates performance reports.
*
* @example
* const {google} = require('googleapis');
@@ -105,7 +101,10 @@ export namespace adsense_v1_4 {
urlchannels: Resource$Urlchannels;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.accounts = new Resource$Accounts(this.context);
this.adclients = new Resource$Adclients(this.context);
@@ -161,9 +160,7 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * Continuation token used to page through accounts. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -181,8 +178,7 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * This ad client's product code, which corresponds to the PRODUCT_CODE
- * report dimension.
+ * This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
*/
productCode?: string;
/**
@@ -204,9 +200,7 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * Continuation token used to page through ad clients. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -230,8 +224,7 @@ export namespace adsense_v1_4 {
}
export interface Schema$AdsenseReportsGenerateResponse {
/**
- * The averages of the report. This is the same length as any other row in
- * the report; cells corresponding to dimension columns are empty.
+ * The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
*/
averages?: string[];
/**
@@ -239,9 +232,7 @@ export namespace adsense_v1_4 {
*/
endDate?: string;
/**
- * The header information of the columns requested in the report. This is a
- * list of headers; one for each dimension in the request, followed by one
- * for each metric in the request.
+ * The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
*/
headers?: Array<{currency?: string; name?: string; type?: string}>;
/**
@@ -249,10 +240,7 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * The output rows of the report. Each row is a list of cells; one for each
- * dimension in the request, followed by one for each metric in the request.
- * The dimension cells contain strings, and the metric cells contain
- * numbers.
+ * The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
*/
rows?: string[][];
/**
@@ -260,14 +248,11 @@ export namespace adsense_v1_4 {
*/
startDate?: string;
/**
- * The total number of rows matched by the report request. Fewer rows may be
- * returned in the response due to being limited by the row count requested
- * or the report row limit.
+ * The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
*/
totalMatchedRows?: string;
/**
- * The totals of the report. This is the same length as any other row in the
- * report; cells corresponding to dimension columns are empty.
+ * The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
*/
totals?: string[];
/**
@@ -277,9 +262,7 @@ export namespace adsense_v1_4 {
}
export interface Schema$AdStyle {
/**
- * The colors which are included in the style. These are represented as six
- * hexadecimal characters, similar to HTML color codes, but without the
- * leading hash.
+ * The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
*/
colors?: {
background?: string;
@@ -289,8 +272,7 @@ export namespace adsense_v1_4 {
url?: string;
};
/**
- * The style of the corners in the ad (deprecated: never populated,
- * ignored).
+ * The style of the corners in the ad (deprecated: never populated, ignored).
*/
corners?: string;
/**
@@ -308,8 +290,7 @@ export namespace adsense_v1_4 {
*/
code?: string;
/**
- * Settings specific to content ads (AFC) and highend mobile content ads
- * (AFMC - deprecated).
+ * Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
*/
contentAdsSettings?: {
backupOption?: {color?: string; type?: string; url?: string};
@@ -330,8 +311,7 @@ export namespace adsense_v1_4 {
type?: string;
};
/**
- * Unique identifier of this ad unit. This should be considered an opaque
- * identifier; it is not safe to rely on it being in any particular format.
+ * Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string;
/**
@@ -352,16 +332,11 @@ export namespace adsense_v1_4 {
*/
name?: string;
/**
- * ID of the saved ad style which holds this ad unit's style
- * information.
+ * ID of the saved ad style which holds this ad unit's style information.
*/
savedStyleId?: string;
/**
- * Status of this ad unit. Possible values are: NEW: Indicates that the ad
- * unit was created within the last seven days and does not yet have any
- * activity associated with it. ACTIVE: Indicates that there has been
- * activity on this ad unit in the last seven days. INACTIVE: Indicates
- * that there has been no activity on this ad unit in the last seven days.
+ * Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
*/
status?: string;
}
@@ -379,16 +354,13 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * Continuation token used to page through ad units. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
export interface Schema$Alert {
/**
- * Unique identifier of this alert. This should be considered an opaque
- * identifier; it is not safe to rely on it being in any particular format.
+ * Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string;
/**
@@ -408,9 +380,7 @@ export namespace adsense_v1_4 {
*/
severity?: string;
/**
- * Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3,
- * ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY,
- * GRAYLISTED_PUBLISHER, API_HOLD.
+ * Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
*/
type?: string;
}
@@ -430,9 +400,7 @@ export namespace adsense_v1_4 {
*/
code?: string;
/**
- * Unique identifier of this custom channel. This should be considered an
- * opaque identifier; it is not safe to rely on it being in any particular
- * format.
+ * Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string;
/**
@@ -467,9 +435,7 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * Continuation token used to page through custom channels. To retrieve the
- * next page of results, set the next request's "pageToken"
- * value to this.
+ * Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -498,15 +464,13 @@ export namespace adsense_v1_4 {
*/
paymentAmountCurrencyCode?: string;
/**
- * The date this payment was/will be credited to the user, or none if the
- * payment threshold has not been met.
+ * The date this payment was/will be credited to the user, or none if the payment threshold has not been met.
*/
paymentDate?: string;
}
export interface Schema$Payments {
/**
- * The list of Payments for the account. One or both of a) the account's
- * most recent payment; and b) the account's upcoming payment.
+ * The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment.
*/
items?: Schema$Payment[];
/**
@@ -516,19 +480,15 @@ export namespace adsense_v1_4 {
}
export interface Schema$ReportingMetadataEntry {
/**
- * For metrics this is a list of dimension IDs which the metric is
- * compatible with, for dimensions it is a list of compatibility groups the
- * dimension belongs to.
+ * For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
*/
compatibleDimensions?: string[];
/**
- * The names of the metrics the dimension or metric this reporting metadata
- * entry describes is compatible with.
+ * The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
*/
compatibleMetrics?: string[];
/**
- * Unique identifier of this reporting metadata entry, corresponding to the
- * name of the appropriate dimension or metric.
+ * Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
*/
id?: string;
/**
@@ -536,22 +496,15 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * The names of the dimensions which the dimension or metric this reporting
- * metadata entry describes requires to also be present in order for the
- * report to be valid. Omitting these will not cause an error or warning,
- * but may result in data which cannot be correctly interpreted.
+ * The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
*/
requiredDimensions?: string[];
/**
- * The names of the metrics which the dimension or metric this reporting
- * metadata entry describes requires to also be present in order for the
- * report to be valid. Omitting these will not cause an error or warning,
- * but may result in data which cannot be correctly interpreted.
+ * The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
*/
requiredMetrics?: string[];
/**
- * The codes of the projects supported by the dimension or metric this
- * reporting metadata entry describes.
+ * The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
*/
supportedProducts?: string[];
}
@@ -561,9 +514,7 @@ export namespace adsense_v1_4 {
*/
adStyle?: Schema$AdStyle;
/**
- * Unique identifier of this saved ad style. This should be considered an
- * opaque identifier; it is not safe to rely on it being in any particular
- * format.
+ * Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string;
/**
@@ -589,9 +540,7 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * Continuation token used to page through ad units. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -623,17 +572,13 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * Continuation token used to page through saved reports. To retrieve the
- * next page of results, set the next request's "pageToken"
- * value to this.
+ * Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
export interface Schema$UrlChannel {
/**
- * Unique identifier of this URL channel. This should be considered an
- * opaque identifier; it is not safe to rely on it being in any particular
- * format.
+ * Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string;
/**
@@ -641,8 +586,7 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * URL Pattern of this URL channel. Does not include "http://" or
- * "https://". Example: www.example.com/home
+ * URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
*/
urlPattern?: string;
}
@@ -660,9 +604,7 @@ export namespace adsense_v1_4 {
*/
kind?: string;
/**
- * Continuation token used to page through URL channels. To retrieve the
- * next page of results, set the next request's "pageToken"
- * value to this.
+ * Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -856,14 +798,11 @@ export namespace adsense_v1_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of accounts to include in the response, used for
- * paging.
+ * The maximum number of accounts to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through accounts. To retrieve the next
- * page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -1051,14 +990,11 @@ export namespace adsense_v1_4 {
*/
accountId?: string;
/**
- * The maximum number of ad clients to include in the response, used for
- * paging.
+ * The maximum number of ad clients to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad clients. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -1075,8 +1011,7 @@ export namespace adsense_v1_4 {
/**
* adsense.accounts.adunits.get
- * @desc Gets the specified ad unit in the specified ad client for the
- * specified account.
+ * @desc Gets the specified ad unit in the specified ad client for the specified account.
* @alias adsense.accounts.adunits.get
* @memberOf! ()
*
@@ -1224,8 +1159,7 @@ export namespace adsense_v1_4 {
/**
* adsense.accounts.adunits.list
- * @desc List all ad units in the specified ad client for the specified
- * account.
+ * @desc List all ad units in the specified ad client for the specified account.
* @alias adsense.accounts.adunits.list
* @memberOf! ()
*
@@ -1360,14 +1294,11 @@ export namespace adsense_v1_4 {
*/
includeInactive?: boolean;
/**
- * The maximum number of ad units to include in the response, used for
- * paging.
+ * The maximum number of ad units to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad units. To retrieve the next
- * page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -1477,14 +1408,11 @@ export namespace adsense_v1_4 {
*/
adUnitId?: string;
/**
- * The maximum number of custom channels to include in the response, used
- * for paging.
+ * The maximum number of custom channels to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through custom channels. To retrieve
- * the next page, set this parameter to the value of "nextPageToken" from
- * the previous response.
+ * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -1497,8 +1425,7 @@ export namespace adsense_v1_4 {
/**
* adsense.accounts.alerts.delete
- * @desc Dismiss (delete) the specified alert from the specified publisher
- * AdSense account.
+ * @desc Dismiss (delete) the specified alert from the specified publisher AdSense account.
* @alias adsense.accounts.alerts.delete
* @memberOf! ()
*
@@ -1669,9 +1596,7 @@ export namespace adsense_v1_4 {
*/
accountId?: string;
/**
- * The locale to use for translating alert messages. The account locale will
- * be used if this is not supplied. The AdSense default (English) will be
- * used if the supplied locale is invalid or unsupported.
+ * The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
*/
locale?: string;
}
@@ -1686,8 +1611,7 @@ export namespace adsense_v1_4 {
/**
* adsense.accounts.customchannels.get
- * @desc Get the specified custom channel from the specified ad client for
- * the specified account.
+ * @desc Get the specified custom channel from the specified ad client for the specified account.
* @alias adsense.accounts.customchannels.get
* @memberOf! ()
*
@@ -1763,8 +1687,7 @@ export namespace adsense_v1_4 {
/**
* adsense.accounts.customchannels.list
- * @desc List all custom channels in the specified ad client for the
- * specified account.
+ * @desc List all custom channels in the specified ad client for the specified account.
* @alias adsense.accounts.customchannels.list
* @memberOf! ()
*
@@ -1876,14 +1799,11 @@ export namespace adsense_v1_4 {
*/
adClientId?: string;
/**
- * The maximum number of custom channels to include in the response, used
- * for paging.
+ * The maximum number of custom channels to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through custom channels. To retrieve
- * the next page, set this parameter to the value of "nextPageToken" from
- * the previous response.
+ * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -1996,14 +1916,11 @@ export namespace adsense_v1_4 {
*/
includeInactive?: boolean;
/**
- * The maximum number of ad units to include in the response, used for
- * paging.
+ * The maximum number of ad units to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad units. To retrieve the next
- * page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -2109,9 +2026,7 @@ export namespace adsense_v1_4 {
/**
* adsense.accounts.reports.generate
- * @desc Generate an AdSense report based on the report request sent in the
- * query parameters. Returns the result as JSON; to retrieve output in CSV
- * format specify "alt=csv" as a query parameter.
+ * @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
* @alias adsense.accounts.reports.generate
* @memberOf! ()
*
@@ -2215,8 +2130,7 @@ export namespace adsense_v1_4 {
*/
accountId?: string;
/**
- * Optional currency to use when reporting on monetary metrics. Defaults to
- * the account's currency if not set.
+ * Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
*/
currency?: string;
/**
@@ -2232,8 +2146,7 @@ export namespace adsense_v1_4 {
*/
filter?: string[];
/**
- * Optional locale to use for translating report output to a local language.
- * Defaults to "en_US" if not specified.
+ * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
*/
locale?: string;
/**
@@ -2245,9 +2158,7 @@ export namespace adsense_v1_4 {
*/
metric?: string[];
/**
- * The name of a dimension or metric to sort the resulting report on,
- * optionally prefixed with "+" to sort ascending or "-" to sort descending.
- * If no prefix is specified, the column is sorted ascending.
+ * The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
*/
sort?: string[];
/**
@@ -2259,8 +2170,7 @@ export namespace adsense_v1_4 {
*/
startIndex?: number;
/**
- * Whether the report should be generated in the AdSense account's local
- * timezone. If false default PST/PDT timezone will be used.
+ * Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
*/
useTimezoneReporting?: boolean;
}
@@ -2273,8 +2183,7 @@ export namespace adsense_v1_4 {
/**
* adsense.accounts.reports.saved.generate
- * @desc Generate an AdSense report based on the saved report ID sent in the
- * query parameters.
+ * @desc Generate an AdSense report based on the saved report ID sent in the query parameters.
* @alias adsense.accounts.reports.saved.generate
* @memberOf! ()
*
@@ -2447,8 +2356,7 @@ export namespace adsense_v1_4 {
*/
accountId?: string;
/**
- * Optional locale to use for translating report output to a local language.
- * Defaults to "en_US" if not specified.
+ * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
*/
locale?: string;
/**
@@ -2476,14 +2384,11 @@ export namespace adsense_v1_4 {
*/
accountId?: string;
/**
- * The maximum number of saved reports to include in the response, used for
- * paging.
+ * The maximum number of saved reports to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through saved reports. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -2673,14 +2578,11 @@ export namespace adsense_v1_4 {
*/
accountId?: string;
/**
- * The maximum number of saved ad styles to include in the response, used
- * for paging.
+ * The maximum number of saved ad styles to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through saved ad styles. To retrieve
- * the next page, set this parameter to the value of "nextPageToken" from
- * the previous response.
+ * A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -2693,8 +2595,7 @@ export namespace adsense_v1_4 {
/**
* adsense.accounts.urlchannels.list
- * @desc List all URL channels in the specified ad client for the specified
- * account.
+ * @desc List all URL channels in the specified ad client for the specified account.
* @alias adsense.accounts.urlchannels.list
* @memberOf! ()
*
@@ -2786,14 +2687,11 @@ export namespace adsense_v1_4 {
*/
adClientId?: string;
/**
- * The maximum number of URL channels to include in the response, used for
- * paging.
+ * The maximum number of URL channels to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through URL channels. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -2886,14 +2784,11 @@ export namespace adsense_v1_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of ad clients to include in the response, used for
- * paging.
+ * The maximum number of ad clients to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad clients. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -3053,8 +2948,7 @@ export namespace adsense_v1_4 {
/**
* adsense.adunits.list
- * @desc List all ad units in the specified ad client for this AdSense
- * account.
+ * @desc List all ad units in the specified ad client for this AdSense account.
* @alias adsense.adunits.list
* @memberOf! ()
*
@@ -3172,14 +3066,11 @@ export namespace adsense_v1_4 {
*/
includeInactive?: boolean;
/**
- * The maximum number of ad units to include in the response, used for
- * paging.
+ * The maximum number of ad units to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad units. To retrieve the next
- * page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -3284,14 +3175,11 @@ export namespace adsense_v1_4 {
*/
adUnitId?: string;
/**
- * The maximum number of custom channels to include in the response, used
- * for paging.
+ * The maximum number of custom channels to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through custom channels. To retrieve
- * the next page, set this parameter to the value of "nextPageToken" from
- * the previous response.
+ * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -3304,8 +3192,7 @@ export namespace adsense_v1_4 {
/**
* adsense.alerts.delete
- * @desc Dismiss (delete) the specified alert from the publisher's AdSense
- * account.
+ * @desc Dismiss (delete) the specified alert from the publisher's AdSense account.
* @alias adsense.alerts.delete
* @memberOf! ()
*
@@ -3464,9 +3351,7 @@ export namespace adsense_v1_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The locale to use for translating alert messages. The account locale will
- * be used if this is not supplied. The AdSense default (English) will be
- * used if the supplied locale is invalid or unsupported.
+ * The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
*/
locale?: string;
}
@@ -3556,8 +3441,7 @@ export namespace adsense_v1_4 {
/**
* adsense.customchannels.list
- * @desc List all custom channels in the specified ad client for this
- * AdSense account.
+ * @desc List all custom channels in the specified ad client for this AdSense account.
* @alias adsense.customchannels.list
* @memberOf! ()
*
@@ -3659,14 +3543,11 @@ export namespace adsense_v1_4 {
*/
adClientId?: string;
/**
- * The maximum number of custom channels to include in the response, used
- * for paging.
+ * The maximum number of custom channels to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through custom channels. To retrieve
- * the next page, set this parameter to the value of "nextPageToken" from
- * the previous response.
+ * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -3774,14 +3655,11 @@ export namespace adsense_v1_4 {
*/
includeInactive?: boolean;
/**
- * The maximum number of ad units to include in the response, used for
- * paging.
+ * The maximum number of ad units to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad units. To retrieve the next
- * page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -3805,8 +3683,7 @@ export namespace adsense_v1_4 {
/**
* adsense.metadata.dimensions.list
- * @desc List the metadata for the dimensions available to this AdSense
- * account.
+ * @desc List the metadata for the dimensions available to this AdSense account.
* @alias adsense.metadata.dimensions.list
* @memberOf! ()
*
@@ -3892,8 +3769,7 @@ export namespace adsense_v1_4 {
/**
* adsense.metadata.metrics.list
- * @desc List the metadata for the metrics available to this AdSense
- * account.
+ * @desc List the metadata for the metrics available to this AdSense account.
* @alias adsense.metadata.metrics.list
* @memberOf! ()
*
@@ -4065,9 +3941,7 @@ export namespace adsense_v1_4 {
/**
* adsense.reports.generate
- * @desc Generate an AdSense report based on the report request sent in the
- * query parameters. Returns the result as JSON; to retrieve output in CSV
- * format specify "alt=csv" as a query parameter.
+ * @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
* @alias adsense.reports.generate
* @memberOf! ()
*
@@ -4170,8 +4044,7 @@ export namespace adsense_v1_4 {
*/
accountId?: string[];
/**
- * Optional currency to use when reporting on monetary metrics. Defaults to
- * the account's currency if not set.
+ * Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
*/
currency?: string;
/**
@@ -4187,8 +4060,7 @@ export namespace adsense_v1_4 {
*/
filter?: string[];
/**
- * Optional locale to use for translating report output to a local language.
- * Defaults to "en_US" if not specified.
+ * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
*/
locale?: string;
/**
@@ -4200,9 +4072,7 @@ export namespace adsense_v1_4 {
*/
metric?: string[];
/**
- * The name of a dimension or metric to sort the resulting report on,
- * optionally prefixed with "+" to sort ascending or "-" to sort descending.
- * If no prefix is specified, the column is sorted ascending.
+ * The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
*/
sort?: string[];
/**
@@ -4214,8 +4084,7 @@ export namespace adsense_v1_4 {
*/
startIndex?: number;
/**
- * Whether the report should be generated in the AdSense account's local
- * timezone. If false default PST/PDT timezone will be used.
+ * Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
*/
useTimezoneReporting?: boolean;
}
@@ -4228,8 +4097,7 @@ export namespace adsense_v1_4 {
/**
* adsense.reports.saved.generate
- * @desc Generate an AdSense report based on the saved report ID sent in the
- * query parameters.
+ * @desc Generate an AdSense report based on the saved report ID sent in the query parameters.
* @alias adsense.reports.saved.generate
* @memberOf! ()
*
@@ -4397,8 +4265,7 @@ export namespace adsense_v1_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Optional locale to use for translating report output to a local language.
- * Defaults to "en_US" if not specified.
+ * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
*/
locale?: string;
/**
@@ -4422,14 +4289,11 @@ export namespace adsense_v1_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of saved reports to include in the response, used for
- * paging.
+ * The maximum number of saved reports to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through saved reports. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -4609,14 +4473,11 @@ export namespace adsense_v1_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of saved ad styles to include in the response, used
- * for paging.
+ * The maximum number of saved ad styles to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through saved ad styles. To retrieve
- * the next page, set this parameter to the value of "nextPageToken" from
- * the previous response.
+ * A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -4629,8 +4490,7 @@ export namespace adsense_v1_4 {
/**
* adsense.urlchannels.list
- * @desc List all URL channels in the specified ad client for this AdSense
- * account.
+ * @desc List all URL channels in the specified ad client for this AdSense account.
* @alias adsense.urlchannels.list
* @memberOf! ()
*
@@ -4714,14 +4574,11 @@ export namespace adsense_v1_4 {
*/
adClientId?: string;
/**
- * The maximum number of URL channels to include in the response, used for
- * paging.
+ * The maximum number of URL channels to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through URL channels. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
diff --git a/src/apis/adsensehost/package.json b/src/apis/adsensehost/package.json
index b118c10e9f5..a827cc3eca9 100644
--- a/src/apis/adsensehost/package.json
+++ b/src/apis/adsensehost/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/adsensehost/v4.1.ts b/src/apis/adsensehost/v4.1.ts
index 233c22d1859..243e47ab6fa 100644
--- a/src/apis/adsensehost/v4.1.ts
+++ b/src/apis/adsensehost/v4.1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace adsensehost_v4_1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace adsensehost_v4_1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -78,8 +75,7 @@ export namespace adsensehost_v4_1 {
/**
* AdSense Host API
*
- * Generates performance reports, generates ad codes, and provides publisher
- * management capabilities for AdSense Hosts.
+ * Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.
*
* @example
* const {google} = require('googleapis');
@@ -101,7 +97,10 @@ export namespace adsensehost_v4_1 {
urlchannels: Resource$Urlchannels;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.accounts = new Resource$Accounts(this.context);
this.adclients = new Resource$Adclients(this.context);
@@ -158,8 +157,7 @@ export namespace adsensehost_v4_1 {
*/
kind?: string;
/**
- * This ad client's product code, which corresponds to the PRODUCT_CODE
- * report dimension.
+ * This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
*/
productCode?: string;
/**
@@ -181,9 +179,7 @@ export namespace adsensehost_v4_1 {
*/
kind?: string;
/**
- * Continuation token used to page through ad clients. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -199,9 +195,7 @@ export namespace adsensehost_v4_1 {
}
export interface Schema$AdStyle {
/**
- * The colors included in the style. These are represented as six
- * hexadecimal characters, similar to HTML color codes, but without the
- * leading hash.
+ * The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
*/
colors?: {
background?: string;
@@ -211,8 +205,7 @@ export namespace adsensehost_v4_1 {
url?: string;
};
/**
- * The style of the corners in the ad (deprecated: never populated,
- * ignored).
+ * The style of the corners in the ad (deprecated: never populated, ignored).
*/
corners?: string;
/**
@@ -230,8 +223,7 @@ export namespace adsensehost_v4_1 {
*/
code?: string;
/**
- * Settings specific to content ads (AFC) and highend mobile content ads
- * (AFMC - deprecated).
+ * Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
*/
contentAdsSettings?: {
backupOption?: {color?: string; type?: string; url?: string};
@@ -243,8 +235,7 @@ export namespace adsensehost_v4_1 {
*/
customStyle?: Schema$AdStyle;
/**
- * Unique identifier of this ad unit. This should be considered an opaque
- * identifier; it is not safe to rely on it being in any particular format.
+ * Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string;
/**
@@ -265,11 +256,7 @@ export namespace adsensehost_v4_1 {
*/
name?: string;
/**
- * Status of this ad unit. Possible values are: NEW: Indicates that the ad
- * unit was created within the last seven days and does not yet have any
- * activity associated with it. ACTIVE: Indicates that there has been
- * activity on this ad unit in the last seven days. INACTIVE: Indicates
- * that there has been no activity on this ad unit in the last seven days.
+ * Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
*/
status?: string;
}
@@ -287,16 +274,13 @@ export namespace adsensehost_v4_1 {
*/
kind?: string;
/**
- * Continuation token used to page through ad units. To retrieve the next
- * page of results, set the next request's "pageToken" value
- * to this.
+ * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
export interface Schema$AssociationSession {
/**
- * Hosted account id of the associated publisher after association. Present
- * if status is ACCEPTED.
+ * Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
*/
accountId?: string;
/**
@@ -308,23 +292,19 @@ export namespace adsensehost_v4_1 {
*/
kind?: string;
/**
- * The products to associate with the user. Options: AFC, AFG, AFV, AFS
- * (deprecated), AFMC (deprecated)
+ * The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated)
*/
productCodes?: string[];
/**
- * Redirect URL of this association session. Used to redirect users into the
- * AdSense association flow.
+ * Redirect URL of this association session. Used to redirect users into the AdSense association flow.
*/
redirectUrl?: string;
/**
- * Status of the completed association, available once the association
- * callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
+ * Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
*/
status?: string;
/**
- * The preferred locale of the user themselves when going through the
- * AdSense association flow.
+ * The preferred locale of the user themselves when going through the AdSense association flow.
*/
userLocale?: string;
/**
@@ -342,9 +322,7 @@ export namespace adsensehost_v4_1 {
*/
code?: string;
/**
- * Unique identifier of this custom channel. This should be considered an
- * opaque identifier; it is not safe to rely on it being in any particular
- * format.
+ * Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string;
/**
@@ -370,22 +348,17 @@ export namespace adsensehost_v4_1 {
*/
kind?: string;
/**
- * Continuation token used to page through custom channels. To retrieve the
- * next page of results, set the next request's "pageToken"
- * value to this.
+ * Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
export interface Schema$Report {
/**
- * The averages of the report. This is the same length as any other row in
- * the report; cells corresponding to dimension columns are empty.
+ * The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
*/
averages?: string[];
/**
- * The header information of the columns requested in the report. This is a
- * list of headers; one for each dimension in the request, followed by one
- * for each metric in the request.
+ * The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
*/
headers?: Array<{currency?: string; name?: string; type?: string}>;
/**
@@ -393,21 +366,15 @@ export namespace adsensehost_v4_1 {
*/
kind?: string;
/**
- * The output rows of the report. Each row is a list of cells; one for each
- * dimension in the request, followed by one for each metric in the request.
- * The dimension cells contain strings, and the metric cells contain
- * numbers.
+ * The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
*/
rows?: string[][];
/**
- * The total number of rows matched by the report request. Fewer rows may be
- * returned in the response due to being limited by the row count requested
- * or the report row limit.
+ * The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
*/
totalMatchedRows?: string;
/**
- * The totals of the report. This is the same length as any other row in the
- * report; cells corresponding to dimension columns are empty.
+ * The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
*/
totals?: string[];
/**
@@ -417,9 +384,7 @@ export namespace adsensehost_v4_1 {
}
export interface Schema$UrlChannel {
/**
- * Unique identifier of this URL channel. This should be considered an
- * opaque identifier; it is not safe to rely on it being in any particular
- * format.
+ * Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string;
/**
@@ -427,8 +392,7 @@ export namespace adsensehost_v4_1 {
*/
kind?: string;
/**
- * URL Pattern of this URL channel. Does not include "http://" or
- * "https://". Example: www.example.com/home
+ * URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
*/
urlPattern?: string;
}
@@ -446,9 +410,7 @@ export namespace adsensehost_v4_1 {
*/
kind?: string;
/**
- * Continuation token used to page through URL channels. To retrieve the
- * next page of results, set the next request's "pageToken"
- * value to this.
+ * Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string;
}
@@ -538,8 +500,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.accounts.list
- * @desc List hosted accounts associated with this AdSense account by ad
- * client id.
+ * @desc List hosted accounts associated with this AdSense account by ad client id.
* @alias adsensehost.accounts.list
* @memberOf! ()
*
@@ -640,8 +601,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.accounts.adclients.get
- * @desc Get information about one of the ad clients in the specified
- * publisher's AdSense account.
+ * @desc Get information about one of the ad clients in the specified publisher's AdSense account.
* @alias adsensehost.accounts.adclients.get
* @memberOf! ()
*
@@ -816,14 +776,11 @@ export namespace adsensehost_v4_1 {
*/
accountId?: string;
/**
- * The maximum number of ad clients to include in the response, used for
- * paging.
+ * The maximum number of ad clients to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad clients. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -836,8 +793,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.accounts.adunits.delete
- * @desc Delete the specified ad unit from the specified publisher AdSense
- * account.
+ * @desc Delete the specified ad unit from the specified publisher AdSense account.
* @alias adsensehost.accounts.adunits.delete
* @memberOf! ()
*
@@ -985,8 +941,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.accounts.adunits.getAdCode
- * @desc Get ad code for the specified ad unit, attaching the specified host
- * custom channels.
+ * @desc Get ad code for the specified ad unit, attaching the specified host custom channels.
* @alias adsensehost.accounts.adunits.getAdCode
* @memberOf! ()
*
@@ -1061,8 +1016,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.accounts.adunits.insert
- * @desc Insert the supplied ad unit into the specified publisher AdSense
- * account.
+ * @desc Insert the supplied ad unit into the specified publisher AdSense account.
* @alias adsensehost.accounts.adunits.insert
* @memberOf! ()
*
@@ -1212,8 +1166,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.accounts.adunits.patch
- * @desc Update the supplied ad unit in the specified publisher AdSense
- * account. This method supports patch semantics.
+ * @desc Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
* @alias adsensehost.accounts.adunits.patch
* @memberOf! ()
*
@@ -1288,8 +1241,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.accounts.adunits.update
- * @desc Update the supplied ad unit in the specified publisher AdSense
- * account.
+ * @desc Update the supplied ad unit in the specified publisher AdSense account.
* @alias adsensehost.accounts.adunits.update
* @memberOf! ()
*
@@ -1467,14 +1419,11 @@ export namespace adsensehost_v4_1 {
*/
includeInactive?: boolean;
/**
- * The maximum number of ad units to include in the response, used for
- * paging.
+ * The maximum number of ad units to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad units. To retrieve the next
- * page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -1533,9 +1482,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.accounts.reports.generate
- * @desc Generate an AdSense report based on the report request sent in the
- * query parameters. Returns the result as JSON; to retrieve output in CSV
- * format specify "alt=csv" as a query parameter.
+ * @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
* @alias adsensehost.accounts.reports.generate
* @memberOf! ()
*
@@ -1638,8 +1585,7 @@ export namespace adsensehost_v4_1 {
*/
filter?: string[];
/**
- * Optional locale to use for translating report output to a local language.
- * Defaults to "en_US" if not specified.
+ * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
*/
locale?: string;
/**
@@ -1651,9 +1597,7 @@ export namespace adsensehost_v4_1 {
*/
metric?: string[];
/**
- * The name of a dimension or metric to sort the resulting report on,
- * optionally prefixed with "+" to sort ascending or "-" to sort descending.
- * If no prefix is specified, the column is sorted ascending.
+ * The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
*/
sort?: string[];
/**
@@ -1674,8 +1618,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.adclients.get
- * @desc Get information about one of the ad clients in the Host AdSense
- * account.
+ * @desc Get information about one of the ad clients in the Host AdSense account.
* @alias adsensehost.adclients.get
* @memberOf! ()
*
@@ -1837,14 +1780,11 @@ export namespace adsensehost_v4_1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of ad clients to include in the response, used for
- * paging.
+ * The maximum number of ad clients to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through ad clients. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -1857,8 +1797,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.associationsessions.start
- * @desc Create an association session for initiating an association with an
- * AdSense user.
+ * @desc Create an association session for initiating an association with an AdSense user.
* @alias adsensehost.associationsessions.start
* @memberOf! ()
*
@@ -1934,8 +1873,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.associationsessions.verify
- * @desc Verify an association session after the association callback
- * returns from AdSense signup.
+ * @desc Verify an association session after the association callback returns from AdSense signup.
* @alias adsensehost.associationsessions.verify
* @memberOf! ()
*
@@ -2353,8 +2291,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.customchannels.patch
- * @desc Update a custom channel in the host AdSense account. This method
- * supports patch semantics.
+ * @desc Update a custom channel in the host AdSense account. This method supports patch semantics.
* @alias adsensehost.customchannels.patch
* @memberOf! ()
*
@@ -2565,14 +2502,11 @@ export namespace adsensehost_v4_1 {
*/
adClientId?: string;
/**
- * The maximum number of custom channels to include in the response, used
- * for paging.
+ * The maximum number of custom channels to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through custom channels. To retrieve
- * the next page, set this parameter to the value of "nextPageToken" from
- * the previous response.
+ * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
@@ -2623,9 +2557,7 @@ export namespace adsensehost_v4_1 {
/**
* adsensehost.reports.generate
- * @desc Generate an AdSense report based on the report request sent in the
- * query parameters. Returns the result as JSON; to retrieve output in CSV
- * format specify "alt=csv" as a query parameter.
+ * @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
* @alias adsensehost.reports.generate
* @memberOf! ()
*
@@ -2722,8 +2654,7 @@ export namespace adsensehost_v4_1 {
*/
filter?: string[];
/**
- * Optional locale to use for translating report output to a local language.
- * Defaults to "en_US" if not specified.
+ * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
*/
locale?: string;
/**
@@ -2735,9 +2666,7 @@ export namespace adsensehost_v4_1 {
*/
metric?: string[];
/**
- * The name of a dimension or metric to sort the resulting report on,
- * optionally prefixed with "+" to sort ascending or "-" to sort descending.
- * If no prefix is specified, the column is sorted ascending.
+ * The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
*/
sort?: string[];
/**
@@ -3024,14 +2953,11 @@ export namespace adsensehost_v4_1 {
*/
adClientId?: string;
/**
- * The maximum number of URL channels to include in the response, used for
- * paging.
+ * The maximum number of URL channels to include in the response, used for paging.
*/
maxResults?: number;
/**
- * A continuation token, used to page through URL channels. To retrieve the
- * next page, set this parameter to the value of "nextPageToken" from the
- * previous response.
+ * A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
diff --git a/src/apis/alertcenter/package.json b/src/apis/alertcenter/package.json
index 9b928eff02c..244f99fb332 100644
--- a/src/apis/alertcenter/package.json
+++ b/src/apis/alertcenter/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts
index 9968bca4941..e4f5ed1f2dd 100644
--- a/src/apis/alertcenter/v1beta1.ts
+++ b/src/apis/alertcenter/v1beta1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace alertcenter_v1beta1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace alertcenter_v1beta1 {
*/
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.
+ * 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;
/**
@@ -113,7 +109,10 @@ export namespace alertcenter_v1beta1 {
v1beta1: Resource$V1beta1;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.alerts = new Resource$Alerts(this.context);
this.v1beta1 = new Resource$V1beta1(this.context);
@@ -129,10 +128,7 @@ export namespace alertcenter_v1beta1 {
*/
email?: string;
/**
- * Optional. Details of the login action associated with the warning event.
- * This is only available for: * Suspicious login * Suspicious login (less
- * secure app) * Suspicious programmatic login * User suspended (suspicious
- * activity)
+ * Optional. Details of the login action associated with the warning event. This is only available for: * Suspicious login * Suspicious login (less secure app) * Suspicious programmatic login * User suspended (suspicious activity)
*/
loginDetails?: Schema$LoginDetails;
}
@@ -165,15 +161,11 @@ export namespace alertcenter_v1beta1 {
*/
query?: string;
/**
- * List of alert ids superseded by this alert. It is used to indicate that
- * this alert is essentially extension of superseded alerts and we found the
- * relationship after creating these alerts.
+ * List of alert ids superseded by this alert. It is used to indicate that this alert is essentially extension of superseded alerts and we found the relationship after creating these alerts.
*/
supersededAlerts?: string[];
/**
- * Alert id superseding this alert. It is used to indicate that superseding
- * alert is essentially extension of this alert and we found the
- * relationship after creating both alerts.
+ * Alert id superseding this alert. It is used to indicate that superseding alert is essentially extension of this alert and we found the relationship after creating both alerts.
*/
supersedingAlert?: string;
/**
@@ -181,8 +173,7 @@ export namespace alertcenter_v1beta1 {
*/
threshold?: string;
/**
- * The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS *
- * USER_EVENTS
+ * The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * USER_EVENTS
*/
triggerSource?: string;
/**
@@ -211,8 +202,7 @@ export namespace alertcenter_v1beta1 {
*/
customerId?: string;
/**
- * Optional. The data associated with this alert, for example
- * google.apps.alertcenter.type.DeviceCompromised.
+ * Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
*/
data?: {[key: string]: any};
/**
@@ -220,33 +210,23 @@ export namespace alertcenter_v1beta1 {
*/
deleted?: boolean;
/**
- * Optional. The time the event that caused this alert ceased being active.
- * If provided, the end time must not be earlier than the start time. If not
- * provided, it indicates an ongoing alert.
+ * Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.
*/
endTime?: string;
/**
- * Output only. An optional [Security Investigation
- * Tool](https://support.google.com/a/answer/7575955) query for this alert.
+ * Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
*/
securityInvestigationToolLink?: string;
/**
- * Required. A unique identifier for the system that reported the alert.
- * This is output only after alert is created. Supported sources are any of
- * the following: * Google Operations * Mobile device management * Gmail
- * phishing * Domain wide takeout * Government attack warning * Google
- * identity
+ * Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * Government attack warning * Google identity
*/
source?: string;
/**
- * Required. The time the event that caused this alert was started or
- * detected.
+ * Required. The time the event that caused this alert was started or detected.
*/
startTime?: string;
/**
- * Required. The type of the alert. This is output only after alert is
- * created. For a list of available alert types see [G Suite Alert
- * types](/admin-sdk/alertcenter/reference/alert-types).
+ * Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).
*/
type?: string;
/**
@@ -293,8 +273,7 @@ export namespace alertcenter_v1beta1 {
csv?: Schema$Csv;
}
/**
- * Alert for setting the domain or IP that malicious email comes from as
- * whitelisted domain or IP in Gmail advanced settings.
+ * Alert for setting the domain or IP that malicious email comes from as whitelisted domain or IP in Gmail advanced settings.
*/
export interface Schema$BadWhitelist {
/**
@@ -315,31 +294,24 @@ export namespace alertcenter_v1beta1 {
sourceIp?: string;
}
/**
- * A reference to a Cloud Pubsub topic. To register for notifications, the
- * owner of the topic must grant
- * `alerts-api-push-notifications@system.gserviceaccount.com` the
- * `projects.topics.publish` permission.
+ * A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.
*/
export interface Schema$CloudPubsubTopic {
/**
- * Optional. The format of the payload that would be sent. If not specified
- * the format will be JSON.
+ * Optional. The format of the payload that would be sent. If not specified the format will be JSON.
*/
payloadFormat?: string;
/**
- * The `name` field of a Cloud Pubsub [Topic]
- * (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
+ * The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
*/
topicName?: string;
}
/**
- * A representation of a CSV file attachment, as a list of column headers and
- * a list of data rows.
+ * A representation of a CSV file attachment, as a list of column headers and a list of data rows.
*/
export interface Schema$Csv {
/**
- * The list of data rows in a CSV file, as string arrays rather than as a
- * single comma-separated string.
+ * The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.
*/
dataRows?: Schema$CsvRow[];
/**
@@ -352,8 +324,7 @@ export namespace alertcenter_v1beta1 {
*/
export interface Schema$CsvRow {
/**
- * The data entries in a CSV file row, as a string array rather than a
- * single comma-separated string.
+ * The data entries in a CSV file row, as a string array rather than a single comma-separated string.
*/
entries?: string[];
}
@@ -375,8 +346,7 @@ export namespace alertcenter_v1beta1 {
*/
export interface Schema$DeviceCompromisedSecurityDetail {
/**
- * The device compromised state. Possible values are
- * "`Compromised`" or "`Not Compromised`".
+ * The device compromised state. Possible values are "`Compromised`" or "`Not Compromised`".
*/
deviceCompromisedState?: string;
/**
@@ -414,8 +384,7 @@ export namespace alertcenter_v1beta1 {
customerPrimaryDomain?: string;
}
/**
- * A takeout operation for the entire domain was initiated by an admin.
- * Derived from audit logs.
+ * A takeout operation for the entire domain was initiated by an admin. Derived from audit logs.
*/
export interface Schema$DomainWideTakeoutInitiated {
/**
@@ -428,11 +397,7 @@ export namespace alertcenter_v1beta1 {
takeoutRequestId?: string;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
@@ -456,8 +421,7 @@ export namespace alertcenter_v1beta1 {
*/
md5HashSubject?: string;
/**
- * The snippet of the message body text (only available for reported
- * emails).
+ * The snippet of the message body text (only available for reported emails).
*/
messageBodySnippet?: string;
/**
@@ -478,14 +442,11 @@ export namespace alertcenter_v1beta1 {
*/
export interface Schema$GoogleOperations {
/**
- * The list of emails which correspond to the users directly affected by the
- * incident.
+ * The list of emails which correspond to the users directly affected by the incident.
*/
affectedUserEmails?: string[];
/**
- * Optional. Application-specific data for an incident, provided when the G
- * Suite application which reported the incident cannot be completely
- * restored to a valid state.
+ * Optional. Application-specific data for an incident, provided when the G Suite application which reported the incident cannot be completely restored to a valid state.
*/
attachmentData?: Schema$Attachment;
/**
@@ -502,8 +463,7 @@ export namespace alertcenter_v1beta1 {
*/
export interface Schema$ListAlertFeedbackResponse {
/**
- * The list of alert feedback. Feedback entries for each alert are ordered
- * by creation time descending.
+ * The list of alert feedback. Feedback entries for each alert are ordered by creation time descending.
*/
feedback?: Schema$AlertFeedback[];
}
@@ -516,10 +476,7 @@ export namespace alertcenter_v1beta1 {
*/
alerts?: Schema$Alert[];
/**
- * The token for the next page. If not empty, indicates that there may be
- * more alerts that match the listing request; this value can be used in a
- * subsequent ListAlertsRequest to get alerts continuing from last result of
- * the current list call.
+ * The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call.
*/
nextPageToken?: string;
}
@@ -528,21 +485,16 @@ export namespace alertcenter_v1beta1 {
*/
export interface Schema$LoginDetails {
/**
- * Optional. The human-readable IP address (for example, `11.22.33.44`) that
- * is associated with the warning event.
+ * Optional. The human-readable IP address (for example, `11.22.33.44`) that is associated with the warning event.
*/
ipAddress?: string;
/**
- * Optional. The successful login time that is associated with the warning
- * event. This will not be present for blocked login attempts.
+ * Optional. The successful login time that is associated with the warning event. This will not be present for blocked login attempts.
*/
loginTime?: string;
}
/**
- * Proto for all phishing alerts with common payload. Supported types are any
- * of the following: * User reported phishing * User reported spam spike *
- * Suspicious message reported * Phishing reclassification * Malware
- * reclassification
+ * Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification
*/
export interface Schema$MailPhishing {
/**
@@ -572,8 +524,7 @@ export namespace alertcenter_v1beta1 {
fromHeader?: string;
}
/**
- * Settings for callback notifications. For more details see [G Suite Alert
- * Notification](/admin-sdk/alertcenter/guides/notifications).
+ * Settings for callback notifications. For more details see [G Suite Alert Notification](/admin-sdk/alertcenter/guides/notifications).
*/
export interface Schema$Notification {
/**
@@ -582,11 +533,7 @@ export namespace alertcenter_v1beta1 {
cloudPubsubTopic?: Schema$CloudPubsubTopic;
}
/**
- * Alert for a spike in user reported phishing. <aside
- * class="warning"><b>Warning</b>: This type has been
- * deprecated. Use
- * [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing)
- * instead.</aside>
+ * Alert for a spike in user reported phishing. <aside class="warning"><b>Warning</b>: This type has been deprecated. Use [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) instead.</aside>
*/
export interface Schema$PhishingSpike {
/**
@@ -683,9 +630,7 @@ export namespace alertcenter_v1beta1 {
*/
export interface Schema$UndeleteAlertRequest {
/**
- * Optional. The unique identifier of the G Suite organization account of
- * the customer the alert is associated with. Inferred from the caller
- * identity if not provided.
+ * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
}
@@ -700,11 +645,7 @@ export namespace alertcenter_v1beta1 {
/**
* alertcenter.alerts.delete
- * @desc Marks the specified alert for deletion. An alert that has been
- * marked for deletion is removed from Alert Center after 30 days. Marking
- * an alert for deletion has no effect on an alert which has already been
- * marked for deletion. Attempting to mark a nonexistent alert for deletion
- * results in a `NOT_FOUND` error.
+ * @desc Marks the specified alert for deletion. An alert that has been marked for deletion is removed from Alert Center after 30 days. Marking an alert for deletion has no effect on an alert which has already been marked for deletion. Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND` error.
* @alias alertcenter.alerts.delete
* @memberOf! ()
*
@@ -776,8 +717,7 @@ export namespace alertcenter_v1beta1 {
/**
* alertcenter.alerts.get
- * @desc Gets the specified alert. Attempting to get a nonexistent alert
- * returns `NOT_FOUND` error.
+ * @desc Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error.
* @alias alertcenter.alerts.get
* @memberOf! ()
*
@@ -923,12 +863,7 @@ export namespace alertcenter_v1beta1 {
/**
* alertcenter.alerts.undelete
- * @desc Restores, or "undeletes", an alert that was marked for deletion
- * within the past 30 days. Attempting to undelete an alert which was marked
- * for deletion over 30 days ago (which has been removed from the Alert
- * Center database) or a nonexistent alert returns a `NOT_FOUND` error.
- * Attempting to undelete an alert which has not been marked for deletion
- * has no effect.
+ * @desc Restores, or "undeletes", an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30 days ago (which has been removed from the Alert Center database) or a nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert which has not been marked for deletion has no effect.
* @alias alertcenter.alerts.undelete
* @memberOf! ()
*
@@ -1010,9 +945,7 @@ export namespace alertcenter_v1beta1 {
*/
alertId?: string;
/**
- * Optional. The unique identifier of the G Suite organization account of
- * the customer the alert is associated with. Inferred from the caller
- * identity if not provided.
+ * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
}
@@ -1027,9 +960,7 @@ export namespace alertcenter_v1beta1 {
*/
alertId?: string;
/**
- * Optional. The unique identifier of the G Suite organization account of
- * the customer the alert is associated with. Inferred from the caller
- * identity if not provided.
+ * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
}
@@ -1040,35 +971,23 @@ export namespace alertcenter_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Optional. The unique identifier of the G Suite organization account of
- * the customer the alerts are associated with. Inferred from the caller
- * identity if not provided.
+ * Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
/**
- * Optional. A query string for filtering alert results. For more details,
- * see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and
- * [Supported query filter
- * fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).
+ * Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).
*/
filter?: string;
/**
- * Optional. The sort order of the list results. If not specified results
- * may be returned in arbitrary order. You can sort the results in
- * descending order based on the creation timestamp using
- * `order_by="create_time desc"`. Currently, supported sorting are
- * `create_time asc`, `create_time desc`, `update_time desc`
+ * Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
*/
orderBy?: string;
/**
- * Optional. The requested page size. Server may return fewer items than
- * requested. If unspecified, server picks an appropriate default.
+ * Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
*/
pageSize?: number;
/**
- * Optional. A token identifying a page of results the server should return.
- * If empty, a new iteration is started. To continue an iteration, pass in
- * the value from the previous ListAlertsResponse's next_page_token field.
+ * Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.
*/
pageToken?: string;
}
@@ -1097,8 +1016,7 @@ export namespace alertcenter_v1beta1 {
/**
* alertcenter.alerts.feedback.create
- * @desc Creates new feedback for an alert. Attempting to create a feedback
- * for a non-existent alert returns `NOT_FOUND` error.
+ * @desc Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns `NOT_FOUND` error.
* @alias alertcenter.alerts.feedback.create
* @memberOf! ()
*
@@ -1174,8 +1092,7 @@ export namespace alertcenter_v1beta1 {
/**
* alertcenter.alerts.feedback.list
- * @desc Lists all the feedback for an alert. Attempting to list feedbacks
- * for a non-existent alert returns `NOT_FOUND` error.
+ * @desc Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns `NOT_FOUND` error.
* @alias alertcenter.alerts.feedback.list
* @memberOf! ()
*
@@ -1269,9 +1186,7 @@ export namespace alertcenter_v1beta1 {
*/
alertId?: string;
/**
- * Optional. The unique identifier of the G Suite organization account of
- * the customer the alert is associated with. Inferred from the caller
- * identity if not provided.
+ * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
@@ -1288,21 +1203,15 @@ export namespace alertcenter_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The alert identifier. The "-" wildcard could be used to
- * represent all alerts.
+ * Required. The alert identifier. The "-" wildcard could be used to represent all alerts.
*/
alertId?: string;
/**
- * Optional. The unique identifier of the G Suite organization account of
- * the customer the alert feedback are associated with. Inferred from the
- * caller identity if not provided.
+ * Optional. The unique identifier of the G Suite organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
/**
- * Optional. A query string for filtering alert feedback results. For more
- * details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters)
- * and [Supported query filter
- * fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).
+ * Optional. A query string for filtering alert feedback results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).
*/
filter?: string;
}
@@ -1461,9 +1370,7 @@ export namespace alertcenter_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Optional. The unique identifier of the G Suite organization account of
- * the customer the alert settings are associated with. Inferred from the
- * caller identity if not provided.
+ * Optional. The unique identifier of the G Suite organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
}
@@ -1475,9 +1382,7 @@ export namespace alertcenter_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Optional. The unique identifier of the G Suite organization account of
- * the customer the alert settings are associated with. Inferred from the
- * caller identity if not provided.
+ * Optional. The unique identifier of the G Suite organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
diff --git a/src/apis/analytics/package.json b/src/apis/analytics/package.json
index 4cabad8fd85..5099fb2b12f 100644
--- a/src/apis/analytics/package.json
+++ b/src/apis/analytics/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/analytics/v2.4.ts b/src/apis/analytics/v2.4.ts
index e3b9851f997..6429b039dcb 100644
--- a/src/apis/analytics/v2.4.ts
+++ b/src/apis/analytics/v2.4.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace analytics_v2_4 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace analytics_v2_4 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -96,7 +93,10 @@ export namespace analytics_v2_4 {
management: Resource$Management;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.data = new Resource$Data(this.context);
this.management = new Resource$Management(this.context);
@@ -195,23 +195,19 @@ export namespace analytics_v2_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * A comma-separated list of Analytics dimensions. E.g.,
- * 'ga:browser,ga:city'.
+ * A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
*/
dimensions?: string;
/**
- * End date for fetching report data. All requests should specify an end
- * date formatted as YYYY-MM-DD.
+ * End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.
*/
'end-date'?: string;
/**
- * A comma-separated list of dimension or metric filters to be applied to
- * the report data.
+ * A comma-separated list of dimension or metric filters to be applied to the report data.
*/
filters?: string;
/**
- * Unique table ID for retrieving report data. Table ID is of the form
- * ga:XXXX, where XXXX is the Analytics view (profile) ID.
+ * Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
*/
ids?: string;
/**
@@ -219,9 +215,7 @@ export namespace analytics_v2_4 {
*/
'max-results'?: number;
/**
- * A comma-separated list of Analytics metrics. E.g.,
- * 'ga:sessions,ga:pageviews'. At least one metric must be specified to
- * retrieve a valid Analytics report.
+ * A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.
*/
metrics?: string;
/**
@@ -229,18 +223,15 @@ export namespace analytics_v2_4 {
*/
segment?: string;
/**
- * A comma-separated list of dimensions or metrics that determine the sort
- * order for the report data.
+ * A comma-separated list of dimensions or metrics that determine the sort order for the report data.
*/
sort?: string;
/**
- * Start date for fetching report data. All requests should specify a start
- * date formatted as YYYY-MM-DD.
+ * Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.
*/
'start-date'?: string;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -354,8 +345,7 @@ export namespace analytics_v2_4 {
*/
'max-results'?: number;
/**
- * An index of the first account to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -451,8 +441,7 @@ export namespace analytics_v2_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Account ID to retrieve goals for. Can either be a specific account ID or
- * '~all', which refers to all the accounts that user has access to.
+ * Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
*/
accountId?: string;
/**
@@ -460,20 +449,15 @@ export namespace analytics_v2_4 {
*/
'max-results'?: number;
/**
- * View (Profile) ID to retrieve goals for. Can either be a specific view
- * (profile) ID or '~all', which refers to all the views (profiles) that
- * user has access to.
+ * View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.
*/
profileId?: string;
/**
- * An index of the first goal to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
- * Web property ID to retrieve goals for. Can either be a specific web
- * property ID or '~all', which refers to all the web properties that user
- * has access to.
+ * Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
*/
webPropertyId?: string;
}
@@ -568,9 +552,7 @@ export namespace analytics_v2_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Account ID for the views (profiles) to retrieve. Can either be a specific
- * account ID or '~all', which refers to all the accounts to which the user
- * has access.
+ * Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.
*/
accountId?: string;
/**
@@ -578,14 +560,11 @@ export namespace analytics_v2_4 {
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
- * Web property ID for the views (profiles) to retrieve. Can either be a
- * specific web property ID or '~all', which refers to all the web
- * properties to which the user has access.
+ * Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.
*/
webPropertyId?: string;
}
@@ -682,8 +661,7 @@ export namespace analytics_v2_4 {
*/
'max-results'?: number;
/**
- * An index of the first advanced segment to retrieve. Use this parameter as
- * a pagination mechanism along with the max-results parameter.
+ * An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -777,9 +755,7 @@ export namespace analytics_v2_4 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Account ID to retrieve web properties for. Can either be a specific
- * account ID or '~all', which refers to all the accounts that user has
- * access to.
+ * Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
*/
accountId?: string;
/**
@@ -787,8 +763,7 @@ export namespace analytics_v2_4 {
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts
index f491e1f95cd..b75c109875d 100644
--- a/src/apis/analytics/v3.ts
+++ b/src/apis/analytics/v3.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace analytics_v3 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace analytics_v3 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -99,7 +96,10 @@ export namespace analytics_v3 {
userDeletion: Resource$Userdeletion;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.data = new Resource$Data(this.context);
this.management = new Resource$Management(this.context);
@@ -114,8 +114,7 @@ export namespace analytics_v3 {
*/
export interface Schema$Account {
/**
- * Child link for an account entry. Points to the list of web properties for
- * this account.
+ * Child link for an account entry. Points to the list of web properties for this account.
*/
childLink?: {href?: string; type?: string};
/**
@@ -173,10 +172,7 @@ export namespace analytics_v3 {
name?: string;
}
/**
- * An account collection provides a list of Analytics accounts to which a user
- * has access. The account collection is the entry point to all management
- * information. Each resource in the collection corresponds to a single
- * Analytics account.
+ * An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.
*/
export interface Schema$Accounts {
/**
@@ -184,10 +180,7 @@ export namespace analytics_v3 {
*/
items?: Schema$Account[];
/**
- * The maximum number of entries the response can contain, regardless of the
- * actual number of entries returned. Its value ranges from 1 to 1000 with a
- * value of 1000 by default, or otherwise specified by the max-results query
- * parameter.
+ * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -203,13 +196,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the entries, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -218,9 +209,7 @@ export namespace analytics_v3 {
username?: string;
}
/**
- * An AccountSummary collection lists a summary of accounts, properties and
- * views (profiles) to which the user has access. Each resource in the
- * collection corresponds to a single AccountSummary.
+ * An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary.
*/
export interface Schema$AccountSummaries {
/**
@@ -228,10 +217,7 @@ export namespace analytics_v3 {
*/
items?: Schema$AccountSummary[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -247,13 +233,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -262,8 +246,7 @@ export namespace analytics_v3 {
username?: string;
}
/**
- * JSON template for an Analytics AccountSummary. An AccountSummary is a
- * lightweight tree comprised of properties/profiles.
+ * JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.
*/
export interface Schema$AccountSummary {
/**
@@ -288,9 +271,7 @@ export namespace analytics_v3 {
webProperties?: Schema$WebPropertySummary[];
}
/**
- * JSON template for an Analytics account ticket. The account ticket consists
- * of the ticket ID and the basic information for the account, property and
- * profile.
+ * JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.
*/
export interface Schema$AccountTicket {
/**
@@ -310,8 +291,7 @@ export namespace analytics_v3 {
*/
profile?: Schema$Profile;
/**
- * Redirect URI where the user will be sent after accepting Terms of
- * Service. Must be configured in APIs console as a callback URL.
+ * Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.
*/
redirectUri?: string;
/**
@@ -320,10 +300,7 @@ export namespace analytics_v3 {
webproperty?: Schema$Webproperty;
}
/**
- * JSON template for an Analytics account tree requests. The account tree
- * request is used in the provisioning api to create an account, property, and
- * view (profile). It contains the basic information required to make these
- * fields.
+ * JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields.
*/
export interface Schema$AccountTreeRequest {
accountName?: string;
@@ -337,9 +314,7 @@ export namespace analytics_v3 {
websiteUrl?: string;
}
/**
- * JSON template for an Analytics account tree response. The account tree
- * response is used in the provisioning api to return the result of creating
- * an account, property, and view (profile).
+ * JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile).
*/
export interface Schema$AccountTreeResponse {
/**
@@ -364,8 +339,7 @@ export namespace analytics_v3 {
*/
export interface Schema$AdWordsAccount {
/**
- * True if auto-tagging is enabled on the Google Ads account. Read-only
- * after the insert operation.
+ * True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
*/
autoTaggingEnabled?: boolean;
/**
@@ -412,8 +386,7 @@ export namespace analytics_v3 {
*/
attributeNames?: string[];
/**
- * Etag of collection. This etag can be compared with the last response etag
- * to check if response has changed.
+ * Etag of collection. This etag can be compared with the last response etag to check if response has changed.
*/
etag?: string;
/**
@@ -460,8 +433,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Parent link for this custom data source. Points to the web property to
- * which this custom data source belongs.
+ * Parent link for this custom data source. Points to the web property to which this custom data source belongs.
*/
parentLink?: {href?: string; type?: string};
/**
@@ -489,15 +461,12 @@ export namespace analytics_v3 {
*/
uploadType?: string;
/**
- * Web property ID of the form UA-XXXXX-YY to which this custom data source
- * belongs.
+ * Web property ID of the form UA-XXXXX-YY to which this custom data source belongs.
*/
webPropertyId?: string;
}
/**
- * Lists Analytics custom data sources to which the user has access. Each
- * resource in the collection corresponds to a single Analytics custom data
- * source.
+ * Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.
*/
export interface Schema$CustomDataSources {
/**
@@ -505,10 +474,7 @@ export namespace analytics_v3 {
*/
items?: Schema$CustomDataSource[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -524,13 +490,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -563,8 +527,7 @@ export namespace analytics_v3 {
*/
index?: number;
/**
- * Kind value for a custom dimension. Set to
- * "analytics#customDimension". It is a read-only field.
+ * Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
*/
kind?: string;
/**
@@ -572,8 +535,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Parent link for the custom dimension. Points to the property to which the
- * custom dimension belongs.
+ * Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
*/
parentLink?: {href?: string; type?: string};
/**
@@ -594,9 +556,7 @@ export namespace analytics_v3 {
webPropertyId?: string;
}
/**
- * A custom dimension collection lists Analytics custom dimensions to which
- * the user has access. Each resource in the collection corresponds to a
- * single Analytics custom dimension.
+ * A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.
*/
export interface Schema$CustomDimensions {
/**
@@ -604,10 +564,7 @@ export namespace analytics_v3 {
*/
items?: Schema$CustomDimension[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -623,13 +580,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -662,8 +617,7 @@ export namespace analytics_v3 {
*/
index?: number;
/**
- * Kind value for a custom metric. Set to
- * "analytics#customMetric". It is a read-only field.
+ * Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
*/
kind?: string;
/**
@@ -679,8 +633,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Parent link for the custom metric. Points to the property to which the
- * custom metric belongs.
+ * Parent link for the custom metric. Points to the property to which the custom metric belongs.
*/
parentLink?: {href?: string; type?: string};
/**
@@ -705,9 +658,7 @@ export namespace analytics_v3 {
webPropertyId?: string;
}
/**
- * A custom metric collection lists Analytics custom metrics to which the user
- * has access. Each resource in the collection corresponds to a single
- * Analytics custom metric.
+ * A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.
*/
export interface Schema$CustomMetrics {
/**
@@ -715,10 +666,7 @@ export namespace analytics_v3 {
*/
items?: Schema$CustomMetric[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -734,13 +682,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -753,8 +699,7 @@ export namespace analytics_v3 {
*/
export interface Schema$EntityAdWordsLink {
/**
- * A list of Google Ads client accounts. These cannot be MCC accounts. This
- * field is required when creating a Google Ads link. It cannot be empty.
+ * A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty.
*/
adWordsAccounts?: Schema$AdWordsAccount[];
/**
@@ -783,8 +728,7 @@ export namespace analytics_v3 {
selfLink?: string;
}
/**
- * An entity Google Ads link collection provides a list of GA-Google Ads links
- * Each resource in this collection corresponds to a single link.
+ * An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link.
*/
export interface Schema$EntityAdWordsLinks {
/**
@@ -792,10 +736,7 @@ export namespace analytics_v3 {
*/
items?: Schema$EntityAdWordsLink[];
/**
- * The maximum number of entries the response can contain, regardless of the
- * actual number of entries returned. Its value ranges from 1 to 1000 with a
- * value of 1000 by default, or otherwise specified by the max-results query
- * parameter.
+ * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -811,24 +752,20 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the entries, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
}
/**
- * JSON template for an Analytics Entity-User Link. Returns permissions that a
- * user has for an entity.
+ * JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
*/
export interface Schema$EntityUserLink {
/**
- * Entity for this link. It can be an account, a web property, or a view
- * (profile).
+ * Entity for this link. It can be an account, a web property, or a view (profile).
*/
entity?: {
accountRef?: Schema$AccountRef;
@@ -857,8 +794,7 @@ export namespace analytics_v3 {
userRef?: Schema$UserRef;
}
/**
- * An entity user link collection provides a list of Analytics ACL links Each
- * resource in this collection corresponds to a single link.
+ * An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.
*/
export interface Schema$EntityUserLinks {
/**
@@ -866,10 +802,7 @@ export namespace analytics_v3 {
*/
items?: Schema$EntityUserLink[];
/**
- * The maximum number of entries the response can contain, regardless of the
- * actual number of entries returned. Its value ranges from 1 to 1000 with a
- * value of 1000 by default, or otherwise specified by the max-results query
- * parameter.
+ * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -885,13 +818,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the entries, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
}
@@ -912,22 +843,15 @@ export namespace analytics_v3 {
*/
description?: string;
/**
- * If true, the end user will be able to edit the experiment via the Google
- * Analytics user interface.
+ * If true, the end user will be able to edit the experiment via the Google Analytics user interface.
*/
editableInGaUi?: boolean;
/**
- * The ending time of the experiment (the time the status changed from
- * RUNNING to ENDED). This field is present only if the experiment has
- * ended. This field is read-only.
+ * The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
*/
endTime?: string;
/**
- * Boolean specifying whether to distribute traffic evenly across all
- * variations. If the value is False, content experiments follows the
- * default behavior of adjusting traffic dynamically based on variation
- * performance. Optional -- defaults to False. This field may not be changed
- * for an experiment whose status is ENDED.
+ * Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
*/
equalWeighting?: boolean;
/**
@@ -935,8 +859,7 @@ export namespace analytics_v3 {
*/
id?: string;
/**
- * Internal ID for the web property to which this experiment belongs. This
- * field is read-only.
+ * Internal ID for the web property to which this experiment belongs. This field is read-only.
*/
internalWebPropertyId?: string;
/**
@@ -944,58 +867,35 @@ export namespace analytics_v3 {
*/
kind?: string;
/**
- * An integer number in [3, 90]. Specifies the minimum length of the
- * experiment. Can be changed for a running experiment. This field may not
- * be changed for an experiments whose status is ENDED.
+ * An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
*/
minimumExperimentLengthInDays?: number;
/**
- * Experiment name. This field may not be changed for an experiment whose
- * status is ENDED. This field is required when creating an experiment.
+ * Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
*/
name?: string;
/**
- * The metric that the experiment is optimizing. Valid values:
- * "ga:goal(n)Completions", "ga:adsenseAdsClicks",
- * "ga:adsenseAdsViewed", "ga:adsenseRevenue",
- * "ga:bounces", "ga:pageviews",
- * "ga:sessionDuration", "ga:transactions",
- * "ga:transactionRevenue". This field is required if status is
- * "RUNNING" and servingFramework is one of "REDIRECT"
- * or "API".
+ * The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
*/
objectiveMetric?: string;
/**
- * Whether the objectiveMetric should be minimized or maximized. Possible
- * values: "MAXIMUM", "MINIMUM". Optional--defaults to
- * "MAXIMUM". Cannot be specified without objectiveMetric. Cannot
- * be modified when status is "RUNNING" or "ENDED".
+ * Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
*/
optimizationType?: string;
/**
- * Parent link for an experiment. Points to the view (profile) to which this
- * experiment belongs.
+ * Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
*/
parentLink?: {href?: string; type?: string};
/**
- * View (Profile) ID to which this experiment belongs. This field is
- * read-only.
+ * View (Profile) ID to which this experiment belongs. This field is read-only.
*/
profileId?: string;
/**
- * Why the experiment ended. Possible values: "STOPPED_BY_USER",
- * "WINNER_FOUND", "EXPERIMENT_EXPIRED",
- * "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED".
- * "ENDED_WITH_NO_WINNER" means that the experiment didn't
- * expire but no winner was projected to be found. If the experiment status
- * is changed via the API to ENDED this field is set to STOPPED_BY_USER.
- * This field is read-only.
+ * Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
*/
reasonExperimentEnded?: string;
/**
- * Boolean specifying whether variations URLS are rewritten to match those
- * of the original. This field may not be changed for an experiments whose
- * status is ENDED.
+ * Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
*/
rewriteVariationUrlsAsOriginal?: boolean;
/**
@@ -1003,41 +903,23 @@ export namespace analytics_v3 {
*/
selfLink?: string;
/**
- * The framework used to serve the experiment variations and evaluate the
- * results. One of: - REDIRECT: Google Analytics redirects traffic to
- * different variation pages, reports the chosen variation and evaluates the
- * results. - API: Google Analytics chooses and reports the variation to
- * serve and evaluates the results; the caller is responsible for serving
- * the selected variation. - EXTERNAL: The variations will be served
- * externally and the chosen variation reported to Google Analytics. The
- * caller is responsible for serving the selected variation and evaluating
- * the results.
+ * The framework used to serve the experiment variations and evaluate the results. One of: - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
*/
servingFramework?: string;
/**
- * The snippet of code to include on the control page(s). This field is
- * read-only.
+ * The snippet of code to include on the control page(s). This field is read-only.
*/
snippet?: string;
/**
- * The starting time of the experiment (the time the status changed from
- * READY_TO_RUN to RUNNING). This field is present only if the experiment
- * has started. This field is read-only.
+ * The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
*/
startTime?: string;
/**
- * Experiment status. Possible values: "DRAFT",
- * "READY_TO_RUN", "RUNNING", "ENDED".
- * Experiments can be created in the "DRAFT",
- * "READY_TO_RUN" or "RUNNING" state. This field is
- * required when creating an experiment.
+ * Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
*/
status?: string;
/**
- * A floating-point number in (0, 1]. Specifies the fraction of the traffic
- * that participates in the experiment. Can be changed for a running
- * experiment. This field may not be changed for an experiments whose status
- * is ENDED.
+ * A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
*/
trafficCoverage?: number;
/**
@@ -1045,10 +927,7 @@ export namespace analytics_v3 {
*/
updated?: string;
/**
- * Array of variations. The first variation in the array is the original.
- * The number of variations may not change once an experiment is in the
- * RUNNING state. At least two variations are required before status can be
- * set to RUNNING.
+ * Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
*/
variations?: Array<{
name?: string;
@@ -1058,26 +937,20 @@ export namespace analytics_v3 {
won?: boolean;
}>;
/**
- * Web property ID to which this experiment belongs. The web property ID is
- * of the form UA-XXXXX-YY. This field is read-only.
+ * Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
*/
webPropertyId?: string;
/**
- * A floating-point number in (0, 1). Specifies the necessary confidence
- * level to choose a winner. This field may not be changed for an
- * experiments whose status is ENDED.
+ * A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
*/
winnerConfidenceLevel?: number;
/**
- * Boolean specifying whether a winner has been found for this experiment.
- * This field is read-only.
+ * Boolean specifying whether a winner has been found for this experiment. This field is read-only.
*/
winnerFound?: boolean;
}
/**
- * An experiment collection lists Analytics experiments to which the user has
- * access. Each view (profile) can have a set of experiments. Each resource in
- * the Experiment collection corresponds to a single Analytics experiment.
+ * An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.
*/
export interface Schema$Experiments {
/**
@@ -1085,10 +958,7 @@ export namespace analytics_v3 {
*/
items?: Schema$Experiment[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -1104,13 +974,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * resources in the result.
+ * The total number of results for the query, regardless of the number of resources in the result.
*/
totalResults?: number;
/**
@@ -1173,8 +1041,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Parent link for this filter. Points to the account to which this filter
- * belongs.
+ * Parent link for this filter. Points to the account to which this filter belongs.
*/
parentLink?: {href?: string; type?: string};
/**
@@ -1192,8 +1059,7 @@ export namespace analytics_v3 {
*/
selfLink?: string;
/**
- * Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE,
- * UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
+ * Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
*/
type?: string;
/**
@@ -1218,42 +1084,11 @@ export namespace analytics_v3 {
*/
expressionValue?: string;
/**
- * Field to filter. Possible values: - Content and Traffic -
- * PAGE_REQUEST_URI, - PAGE_HOSTNAME, - PAGE_TITLE, - REFERRAL, -
- * COST_DATA_URI (Campaign target URL), - HIT_TYPE, -
- * INTERNAL_SEARCH_TERM, - INTERNAL_SEARCH_TYPE, -
- * SOURCE_PROPERTY_TRACKING_ID, - Campaign or AdGroup -
- * CAMPAIGN_SOURCE, - CAMPAIGN_MEDIUM, - CAMPAIGN_NAME, -
- * CAMPAIGN_AD_GROUP, - CAMPAIGN_TERM, - CAMPAIGN_CONTENT, -
- * CAMPAIGN_CODE, - CAMPAIGN_REFERRAL_PATH, - E-Commerce -
- * TRANSACTION_COUNTRY, - TRANSACTION_REGION, - TRANSACTION_CITY, -
- * TRANSACTION_AFFILIATION (Store or order location), - ITEM_NAME, -
- * ITEM_CODE, - ITEM_VARIATION, - TRANSACTION_ID, -
- * TRANSACTION_CURRENCY_CODE, - PRODUCT_ACTION_TYPE, - Audience/Users -
- * BROWSER, - BROWSER_VERSION, - BROWSER_SIZE, - PLATFORM, -
- * PLATFORM_VERSION, - LANGUAGE, - SCREEN_RESOLUTION, - SCREEN_COLORS, -
- * JAVA_ENABLED (Boolean Field), - FLASH_VERSION, - GEO_SPEED (Connection
- * speed), - VISITOR_TYPE, - GEO_ORGANIZATION (ISP organization), -
- * GEO_DOMAIN, - GEO_IP_ADDRESS, - GEO_IP_VERSION, - Location -
- * GEO_COUNTRY, - GEO_REGION, - GEO_CITY, - Event - EVENT_CATEGORY,
- * - EVENT_ACTION, - EVENT_LABEL, - Other - CUSTOM_FIELD_1, -
- * CUSTOM_FIELD_2, - USER_DEFINED_VALUE, - Application - APP_ID, -
- * APP_INSTALLER_ID, - APP_NAME, - APP_VERSION, - SCREEN, - IS_APP
- * (Boolean Field), - IS_FATAL_EXCEPTION (Boolean Field), -
- * EXCEPTION_DESCRIPTION, - Mobile device - IS_MOBILE (Boolean Field,
- * Deprecated. Use DEVICE_CATEGORY=mobile), - IS_TABLET (Boolean Field,
- * Deprecated. Use DEVICE_CATEGORY=tablet), - DEVICE_CATEGORY, -
- * MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), - MOBILE_HAS_NFC_SUPPORT
- * (Boolean Field), - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), -
- * MOBILE_HAS_WIFI_SUPPORT (Boolean Field), - MOBILE_BRAND_NAME, -
- * MOBILE_MODEL_NAME, - MOBILE_MARKETING_NAME, - MOBILE_POINTING_METHOD,
- * - Social - SOCIAL_NETWORK, - SOCIAL_ACTION, - SOCIAL_ACTION_TARGET,
- * - Custom dimension - CUSTOM_DIMENSION (See accompanying field index),
+ * Field to filter. Possible values: - Content and Traffic - PAGE_REQUEST_URI, - PAGE_HOSTNAME, - PAGE_TITLE, - REFERRAL, - COST_DATA_URI (Campaign target URL), - HIT_TYPE, - INTERNAL_SEARCH_TERM, - INTERNAL_SEARCH_TYPE, - SOURCE_PROPERTY_TRACKING_ID, - Campaign or AdGroup - CAMPAIGN_SOURCE, - CAMPAIGN_MEDIUM, - CAMPAIGN_NAME, - CAMPAIGN_AD_GROUP, - CAMPAIGN_TERM, - CAMPAIGN_CONTENT, - CAMPAIGN_CODE, - CAMPAIGN_REFERRAL_PATH, - E-Commerce - TRANSACTION_COUNTRY, - TRANSACTION_REGION, - TRANSACTION_CITY, - TRANSACTION_AFFILIATION (Store or order location), - ITEM_NAME, - ITEM_CODE, - ITEM_VARIATION, - TRANSACTION_ID, - TRANSACTION_CURRENCY_CODE, - PRODUCT_ACTION_TYPE, - Audience/Users - BROWSER, - BROWSER_VERSION, - BROWSER_SIZE, - PLATFORM, - PLATFORM_VERSION, - LANGUAGE, - SCREEN_RESOLUTION, - SCREEN_COLORS, - JAVA_ENABLED (Boolean Field), - FLASH_VERSION, - GEO_SPEED (Connection speed), - VISITOR_TYPE, - GEO_ORGANIZATION (ISP organization), - GEO_DOMAIN, - GEO_IP_ADDRESS, - GEO_IP_VERSION, - Location - GEO_COUNTRY, - GEO_REGION, - GEO_CITY, - Event - EVENT_CATEGORY, - EVENT_ACTION, - EVENT_LABEL, - Other - CUSTOM_FIELD_1, - CUSTOM_FIELD_2, - USER_DEFINED_VALUE, - Application - APP_ID, - APP_INSTALLER_ID, - APP_NAME, - APP_VERSION, - SCREEN, - IS_APP (Boolean Field), - IS_FATAL_EXCEPTION (Boolean Field), - EXCEPTION_DESCRIPTION, - Mobile device - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), - DEVICE_CATEGORY, - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), - MOBILE_HAS_NFC_SUPPORT (Boolean Field), - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), - MOBILE_BRAND_NAME, - MOBILE_MODEL_NAME, - MOBILE_MARKETING_NAME, - MOBILE_POINTING_METHOD, - Social - SOCIAL_NETWORK, - SOCIAL_ACTION, - SOCIAL_ACTION_TARGET, - Custom dimension - CUSTOM_DIMENSION (See accompanying field index),
*/
field?: string;
/**
- * The Index of the custom dimension. Set only if the field is a is
- * CUSTOM_DIMENSION.
+ * The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
*/
fieldIndex?: number;
/**
@@ -1261,10 +1096,7 @@ export namespace analytics_v3 {
*/
kind?: string;
/**
- * Match type for this filter. Possible values are BEGINS_WITH, EQUAL,
- * ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS,
- * PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all
- * other filters must use MATCHES.
+ * Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
*/
matchType?: string;
}
@@ -1294,8 +1126,7 @@ export namespace analytics_v3 {
name?: string;
}
/**
- * A filter collection lists filters created by users in an Analytics account.
- * Each resource in the collection corresponds to a filter.
+ * A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.
*/
export interface Schema$Filters {
/**
@@ -1303,10 +1134,7 @@ export namespace analytics_v3 {
*/
items?: Schema$Filter[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1,000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -1322,13 +1150,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -1341,8 +1167,7 @@ export namespace analytics_v3 {
*/
export interface Schema$GaData {
/**
- * Column headers that list dimension names followed by the metric names.
- * The order of dimensions and metrics is same as specified in the request.
+ * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
*/
columnHeaders?: Array<{
columnType?: string;
@@ -1366,10 +1191,7 @@ export namespace analytics_v3 {
*/
id?: string;
/**
- * The maximum number of rows the response can contain, regardless of the
- * actual number of rows returned. Its value ranges from 1 to 10,000 with a
- * value of 1000 by default, or otherwise specified by the max-results query
- * parameter.
+ * The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -1385,8 +1207,7 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * Information for the view (profile), for which the Analytics data was
- * requested.
+ * Information for the view (profile), for which the Analytics data was requested.
*/
profileInfo?: {
accountId?: string;
@@ -1413,9 +1234,7 @@ export namespace analytics_v3 {
'start-index'?: number;
};
/**
- * Analytics data rows, where each row contains a list of dimension values
- * followed by the metric values. The order of dimensions and metrics is
- * same as specified in the request.
+ * Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
*/
rows?: string[][];
/**
@@ -1431,14 +1250,11 @@ export namespace analytics_v3 {
*/
selfLink?: string;
/**
- * The total number of rows for the query, regardless of the number of rows
- * in the response.
+ * The total number of rows for the query, regardless of the number of rows in the response.
*/
totalResults?: number;
/**
- * Total values for the requested metrics over all the results, not just the
- * results returned in this response. The order of the metric totals is same
- * as the metric order specified in the request.
+ * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
*/
totalsForAllResults?: {[key: string]: string};
}
@@ -1488,8 +1304,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Parent link for a goal. Points to the view (profile) to which this goal
- * belongs.
+ * Parent link for a goal. Points to the view (profile) to which this goal belongs.
*/
parentLink?: {href?: string; type?: string};
/**
@@ -1501,8 +1316,7 @@ export namespace analytics_v3 {
*/
selfLink?: string;
/**
- * Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE,
- * VISIT_NUM_PAGES, AND EVENT.
+ * Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
*/
type?: string;
/**
@@ -1535,15 +1349,12 @@ export namespace analytics_v3 {
comparisonValue?: string;
};
/**
- * Web property ID to which this goal belongs. The web property ID is of the
- * form UA-XXXXX-YY.
+ * Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
*/
webPropertyId?: string;
}
/**
- * A goal collection lists Analytics goals to which the user has access. Each
- * view (profile) can have a set of goals. Each resource in the Goal
- * collection corresponds to a single Analytics goal.
+ * A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.
*/
export interface Schema$Goals {
/**
@@ -1551,10 +1362,7 @@ export namespace analytics_v3 {
*/
items?: Schema$Goal[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -1570,13 +1378,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * resources in the result.
+ * The total number of results for the query, regardless of the number of resources in the result.
*/
totalResults?: number;
/**
@@ -1606,17 +1412,11 @@ export namespace analytics_v3 {
*/
export interface Schema$IncludeConditions {
/**
- * The look-back window lets you specify a time frame for evaluating the
- * behavior that qualifies users for your audience. For example, if your
- * filters include users from Central Asia, and Transactions Greater than 2,
- * and you set the look-back window to 14 days, then any user from Central
- * Asia whose cumulative transactions exceed 2 during the last 14 days is
- * added to the audience.
+ * The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
*/
daysToLookBack?: number;
/**
- * Boolean indicating whether this segment is a smart list.
- * https://support.google.com/analytics/answer/4628577
+ * Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
*/
isSmartList?: boolean;
/**
@@ -1649,8 +1449,7 @@ export namespace analytics_v3 {
*/
id?: string;
/**
- * Internal ID for the web property to which this linked foreign account
- * belongs.
+ * Internal ID for the web property to which this linked foreign account belongs.
*/
internalWebPropertyId?: string;
/**
@@ -1658,8 +1457,7 @@ export namespace analytics_v3 {
*/
kind?: string;
/**
- * The foreign account ID. For example the an Google Ads `linkedAccountId`
- * has the following format XXX-XXX-XXXX.
+ * The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
*/
linkedAccountId?: string;
/**
@@ -1671,13 +1469,11 @@ export namespace analytics_v3 {
*/
status?: string;
/**
- * The type of the foreign account. For example, `ADWORDS_LINKS`,
- * `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
+ * The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
*/
type?: string;
/**
- * Web property ID of the form UA-XXXXX-YY to which this linked foreign
- * account belongs.
+ * Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
*/
webPropertyId?: string;
}
@@ -1686,8 +1482,7 @@ export namespace analytics_v3 {
*/
export interface Schema$McfData {
/**
- * Column headers that list dimension names followed by the metric names.
- * The order of dimensions and metrics is same as specified in the request.
+ * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
*/
columnHeaders?: Array<{
columnType?: string;
@@ -1703,10 +1498,7 @@ export namespace analytics_v3 {
*/
id?: string;
/**
- * The maximum number of rows the response can contain, regardless of the
- * actual number of rows returned. Its value ranges from 1 to 10,000 with a
- * value of 1000 by default, or otherwise specified by the max-results query
- * parameter.
+ * The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -1722,8 +1514,7 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * Information for the view (profile), for which the Analytics data was
- * requested.
+ * Information for the view (profile), for which the Analytics data was requested.
*/
profileInfo?: {
accountId?: string;
@@ -1750,9 +1541,7 @@ export namespace analytics_v3 {
'start-index'?: number;
};
/**
- * Analytics data rows, where each row contains a list of dimension values
- * followed by the metric values. The order of dimensions and metrics is
- * same as specified in the request.
+ * Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
*/
rows?: Array<
Array<{
@@ -1776,14 +1565,11 @@ export namespace analytics_v3 {
*/
selfLink?: string;
/**
- * The total number of rows for the query, regardless of the number of rows
- * in the response.
+ * The total number of rows for the query, regardless of the number of rows in the response.
*/
totalResults?: number;
/**
- * Total values for the requested metrics over all the results, not just the
- * results returned in this response. The order of the metric totals is same
- * as the metric order specified in the request.
+ * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
*/
totalsForAllResults?: {[key: string]: string};
}
@@ -1800,8 +1586,7 @@ export namespace analytics_v3 {
*/
botFilteringEnabled?: boolean;
/**
- * Child link for this view (profile). Points to the list of goals for this
- * view (profile).
+ * Child link for this view (profile). Points to the list of goals for this view (profile).
*/
childLink?: {href?: string; type?: string};
/**
@@ -1809,11 +1594,7 @@ export namespace analytics_v3 {
*/
created?: string;
/**
- * The currency type associated with this view (profile), defaults to USD.
- * The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK,
- * RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR,
- * CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP,
- * HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
+ * The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
*/
currency?: string;
/**
@@ -1825,9 +1606,7 @@ export namespace analytics_v3 {
*/
eCommerceTracking?: boolean;
/**
- * Indicates whether enhanced ecommerce tracking is enabled for this view
- * (profile). This property can only be enabled if ecommerce tracking is
- * enabled.
+ * Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
*/
enhancedECommerceTracking?: boolean;
/**
@@ -1851,8 +1630,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Parent link for this view (profile). Points to the web property to which
- * this view (profile) belongs.
+ * Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
*/
parentLink?: {href?: string; type?: string};
/**
@@ -1876,18 +1654,15 @@ export namespace analytics_v3 {
*/
starred?: boolean;
/**
- * Whether or not Analytics will strip search category parameters from the
- * URLs in your reports.
+ * Whether or not Analytics will strip search category parameters from the URLs in your reports.
*/
stripSiteSearchCategoryParameters?: boolean;
/**
- * Whether or not Analytics will strip search query parameters from the URLs
- * in your reports.
+ * Whether or not Analytics will strip search query parameters from the URLs in your reports.
*/
stripSiteSearchQueryParameters?: boolean;
/**
- * Time zone for which this view (profile) has been configured. Time zones
- * are identified by strings from the TZ database.
+ * Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
*/
timezone?: string;
/**
@@ -1899,8 +1674,7 @@ export namespace analytics_v3 {
*/
updated?: string;
/**
- * Web property ID of the form UA-XXXXX-YY to which this view (profile)
- * belongs.
+ * Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
*/
webPropertyId?: string;
/**
@@ -1929,17 +1703,7 @@ export namespace analytics_v3 {
*/
profileRef?: Schema$ProfileRef;
/**
- * The rank of this profile filter link relative to the other filters linked
- * to the same profile. For readonly (i.e., list and get) operations, the
- * rank always starts at 1. For write (i.e., create, update, or delete)
- * operations, you may specify a value between 0 and 255 inclusively, [0,
- * 255]. In order to insert a link at the end of the list, either don't
- * specify a rank or set a rank to a number greater than the largest rank in
- * the list. In order to insert a link to the beginning of the list specify
- * a rank that is less than or equal to 1. The new link will move all
- * existing filters with the same or lower rank down the list. After the
- * link is inserted/updated/deleted all profile filter links will be
- * renumbered starting at 1.
+ * The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
*/
rank?: number;
/**
@@ -1948,9 +1712,7 @@ export namespace analytics_v3 {
selfLink?: string;
}
/**
- * A profile filter link collection lists profile filter links between
- * profiles and filters. Each resource in the collection corresponds to a
- * profile filter link.
+ * A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.
*/
export interface Schema$ProfileFilterLinks {
/**
@@ -1958,10 +1720,7 @@ export namespace analytics_v3 {
*/
items?: Schema$ProfileFilterLink[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1,000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -1977,13 +1736,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -2020,15 +1777,12 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Web property ID of the form UA-XXXXX-YY to which this view (profile)
- * belongs.
+ * Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
*/
webPropertyId?: string;
}
/**
- * A view (profile) collection lists Analytics views (profiles) to which the
- * user has access. Each resource in the collection corresponds to a single
- * Analytics view (profile).
+ * A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).
*/
export interface Schema$Profiles {
/**
@@ -2036,10 +1790,7 @@ export namespace analytics_v3 {
*/
items?: Schema$Profile[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -2055,13 +1806,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -2070,8 +1819,7 @@ export namespace analytics_v3 {
username?: string;
}
/**
- * JSON template for an Analytics ProfileSummary. ProfileSummary returns basic
- * information (i.e., summary) for a profile.
+ * JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.
*/
export interface Schema$ProfileSummary {
/**
@@ -2100,8 +1848,7 @@ export namespace analytics_v3 {
*/
export interface Schema$RealtimeData {
/**
- * Column headers that list dimension names followed by the metric names.
- * The order of dimensions and metrics is same as specified in the request.
+ * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
*/
columnHeaders?: Array<{
columnType?: string;
@@ -2117,8 +1864,7 @@ export namespace analytics_v3 {
*/
kind?: string;
/**
- * Information for the view (profile), for which the real time data was
- * requested.
+ * Information for the view (profile), for which the real time data was requested.
*/
profileInfo?: {
accountId?: string;
@@ -2140,9 +1886,7 @@ export namespace analytics_v3 {
sort?: string[];
};
/**
- * Real time data rows, where each row contains a list of dimension values
- * followed by the metric values. The order of dimensions and metrics is
- * same as specified in the request.
+ * Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
*/
rows?: string[][];
/**
@@ -2150,14 +1894,11 @@ export namespace analytics_v3 {
*/
selfLink?: string;
/**
- * The total number of rows for the query, regardless of the number of rows
- * in the response.
+ * The total number of rows for the query, regardless of the number of rows in the response.
*/
totalResults?: number;
/**
- * Total values for the requested metrics over all the results, not just the
- * results returned in this response. The order of the metric totals is same
- * as the metric order specified in the request.
+ * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
*/
totalsForAllResults?: {[key: string]: string};
}
@@ -2170,8 +1911,7 @@ export namespace analytics_v3 {
*/
accountId?: string;
/**
- * The simple audience definition that will cause a user to be added to an
- * audience.
+ * The simple audience definition that will cause a user to be added to an audience.
*/
audienceDefinition?: {includeConditions?: Schema$IncludeConditions};
/**
@@ -2191,8 +1931,7 @@ export namespace analytics_v3 {
*/
id?: string;
/**
- * Internal ID for the web property to which this remarketing audience
- * belongs.
+ * Internal ID for the web property to which this remarketing audience belongs.
*/
internalWebPropertyId?: string;
/**
@@ -2200,8 +1939,7 @@ export namespace analytics_v3 {
*/
kind?: string;
/**
- * The linked ad accounts associated with this remarketing audience. A
- * remarketing audience can have only one linkedAdAccount currently.
+ * The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
*/
linkedAdAccounts?: Schema$LinkedForeignAccount[];
/**
@@ -2213,8 +1951,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * A state based audience definition that will cause a user to be added or
- * removed from an audience.
+ * A state based audience definition that will cause a user to be added or removed from an audience.
*/
stateBasedAudienceDefinition?: {
excludeConditions?: {exclusionDuration?: string; segment?: string};
@@ -2225,15 +1962,12 @@ export namespace analytics_v3 {
*/
updated?: string;
/**
- * Web property ID of the form UA-XXXXX-YY to which this remarketing
- * audience belongs.
+ * Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
*/
webPropertyId?: string;
}
/**
- * A remarketing audience collection lists Analytics remarketing audiences to
- * which the user has access. Each resource in the collection corresponds to a
- * single Analytics remarketing audience.
+ * A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience.
*/
export interface Schema$RemarketingAudiences {
/**
@@ -2241,10 +1975,7 @@ export namespace analytics_v3 {
*/
items?: Schema$RemarketingAudience[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -2260,13 +1991,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -2299,8 +2028,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Segment ID. Can be used with the 'segment' parameter in Core
- * Reporting API.
+ * Segment ID. Can be used with the 'segment' parameter in Core Reporting API.
*/
segmentId?: string;
/**
@@ -2308,8 +2036,7 @@ export namespace analytics_v3 {
*/
selfLink?: string;
/**
- * Type for a segment. Possible values are "BUILT_IN" or
- * "CUSTOM".
+ * Type for a segment. Possible values are "BUILT_IN" or "CUSTOM".
*/
type?: string;
/**
@@ -2318,8 +2045,7 @@ export namespace analytics_v3 {
updated?: string;
}
/**
- * An segment collection lists Analytics segments that the user has access to.
- * Each resource in the collection corresponds to a single Analytics segment.
+ * An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.
*/
export interface Schema$Segments {
/**
@@ -2327,10 +2053,7 @@ export namespace analytics_v3 {
*/
items?: Schema$Segment[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -2346,13 +2069,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -2381,10 +2102,7 @@ export namespace analytics_v3 {
*/
dimensions?: string;
/**
- * The type of download you need to use for the report data file. Possible
- * values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is
- * `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is
- * `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field.
+ * The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field.
*/
downloadType?: string;
/**
@@ -2428,8 +2146,7 @@ export namespace analytics_v3 {
*/
'start-date'?: string;
/**
- * Status of this unsampled report. Possible values are PENDING, COMPLETED,
- * or FAILED.
+ * Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.
*/
status?: string;
/**
@@ -2441,16 +2158,12 @@ export namespace analytics_v3 {
*/
updated?: string;
/**
- * Web property ID to which this unsampled report belongs. The web property
- * ID is of the form UA-XXXXX-YY.
+ * Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.
*/
webPropertyId?: string;
}
/**
- * An unsampled report collection lists Analytics unsampled reports to which
- * the user has access. Each view (profile) can have a set of unsampled
- * reports. Each resource in the unsampled report collection corresponds to a
- * single Analytics unsampled report.
+ * An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report.
*/
export interface Schema$UnsampledReports {
/**
@@ -2458,10 +2171,7 @@ export namespace analytics_v3 {
*/
items?: Schema$UnsampledReport[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -2477,13 +2187,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * resources in the result.
+ * The total number of results for the query, regardless of the number of resources in the result.
*/
totalResults?: number;
/**
@@ -2516,8 +2224,7 @@ export namespace analytics_v3 {
*/
kind?: string;
/**
- * Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING,
- * DELETED.
+ * Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
*/
status?: string;
/**
@@ -2526,9 +2233,7 @@ export namespace analytics_v3 {
uploadTime?: string;
}
/**
- * Upload collection lists Analytics uploads to which the user has access.
- * Each custom data source can have a set of uploads. Each resource in the
- * upload collection corresponds to a single Analytics data upload.
+ * Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.
*/
export interface Schema$Uploads {
/**
@@ -2536,10 +2241,7 @@ export namespace analytics_v3 {
*/
items?: Schema$Upload[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -2555,13 +2257,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * resources in the result.
+ * The total number of results for the query, regardless of the number of resources in the result.
*/
totalResults?: number;
}
@@ -2570,8 +2270,7 @@ export namespace analytics_v3 {
*/
export interface Schema$UserDeletionRequest {
/**
- * This marks the point in time for which all user data before should be
- * deleted
+ * This marks the point in time for which all user data before should be deleted
*/
deletionRequestTime?: string;
/**
@@ -2606,9 +2305,7 @@ export namespace analytics_v3 {
kind?: string;
}
/**
- * A web property collection lists Analytics web properties to which the user
- * has access. Each resource in the collection corresponds to a single
- * Analytics web property.
+ * A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.
*/
export interface Schema$Webproperties {
/**
@@ -2616,10 +2313,7 @@ export namespace analytics_v3 {
*/
items?: Schema$Webproperty[];
/**
- * The maximum number of resources the response can contain, regardless of
- * the actual number of resources returned. Its value ranges from 1 to 1000
- * with a value of 1000 by default, or otherwise specified by the
- * max-results query parameter.
+ * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
*/
itemsPerPage?: number;
/**
@@ -2635,13 +2329,11 @@ export namespace analytics_v3 {
*/
previousLink?: string;
/**
- * The starting index of the resources, which is 1 by default or otherwise
- * specified by the start-index query parameter.
+ * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
*/
startIndex?: number;
/**
- * The total number of results for the query, regardless of the number of
- * results in the response.
+ * The total number of results for the query, regardless of the number of results in the response.
*/
totalResults?: number;
/**
@@ -2658,8 +2350,7 @@ export namespace analytics_v3 {
*/
accountId?: string;
/**
- * Child link for this web property. Points to the list of views (profiles)
- * for this web property.
+ * Child link for this web property. Points to the list of views (profiles) for this web property.
*/
childLink?: {href?: string; type?: string};
/**
@@ -2667,16 +2358,11 @@ export namespace analytics_v3 {
*/
created?: string;
/**
- * Set to true to reset the retention period of the user identifier with
- * each new event from that user (thus setting the expiration date to
- * current time plus retention period). Set to false to delete data
- * associated with the user identifer automatically after the rentention
- * period. This property cannot be set on insert.
+ * Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifer automatically after the rentention period. This property cannot be set on insert.
*/
dataRetentionResetOnNewActivity?: boolean;
/**
- * The length of time for which user and event data is retained. This
- * property cannot be set on insert.
+ * The length of time for which user and event data is retained. This property cannot be set on insert.
*/
dataRetentionTtl?: string;
/**
@@ -2708,8 +2394,7 @@ export namespace analytics_v3 {
*/
name?: string;
/**
- * Parent link for this web property. Points to the account to which this
- * web property belongs.
+ * Parent link for this web property. Points to the account to which this web property belongs.
*/
parentLink?: {href?: string; type?: string};
/**
@@ -2767,8 +2452,7 @@ export namespace analytics_v3 {
name?: string;
}
/**
- * JSON template for an Analytics WebPropertySummary. WebPropertySummary
- * returns basic information (i.e., summary) for a web property.
+ * JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.
*/
export interface Schema$WebPropertySummary {
/**
@@ -2915,29 +2599,23 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * A comma-separated list of Analytics dimensions. E.g.,
- * 'ga:browser,ga:city'.
+ * A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
*/
dimensions?: string;
/**
- * End date for fetching Analytics data. Request can should specify an end
- * date formatted as YYYY-MM-DD, or as a relative date (e.g., today,
- * yesterday, or 7daysAgo). The default value is yesterday.
+ * End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.
*/
'end-date'?: string;
/**
- * A comma-separated list of dimension or metric filters to be applied to
- * Analytics data.
+ * A comma-separated list of dimension or metric filters to be applied to Analytics data.
*/
filters?: string;
/**
- * Unique table ID for retrieving Analytics data. Table ID is of the form
- * ga:XXXX, where XXXX is the Analytics view (profile) ID.
+ * Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
*/
ids?: string;
/**
- * The response will include empty rows if this parameter is set to true,
- * the default is true
+ * The response will include empty rows if this parameter is set to true, the default is true
*/
'include-empty-rows'?: boolean;
/**
@@ -2945,8 +2623,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * A comma-separated list of Analytics metrics. E.g.,
- * 'ga:sessions,ga:pageviews'. At least one metric must be specified.
+ * A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.
*/
metrics?: string;
/**
@@ -2962,19 +2639,15 @@ export namespace analytics_v3 {
*/
segment?: string;
/**
- * A comma-separated list of dimensions or metrics that determine the sort
- * order for Analytics data.
+ * A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
*/
sort?: string;
/**
- * Start date for fetching Analytics data. Requests can specify a start date
- * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday,
- * or 7daysAgo). The default value is 7daysAgo.
+ * Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
*/
'start-date'?: string;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -3073,24 +2746,19 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * A comma-separated list of Multi-Channel Funnels dimensions. E.g.,
- * 'mcf:source,mcf:medium'.
+ * A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
*/
dimensions?: string;
/**
- * End date for fetching Analytics data. Requests can specify a start date
- * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday,
- * or 7daysAgo). The default value is 7daysAgo.
+ * End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
*/
'end-date'?: string;
/**
- * A comma-separated list of dimension or metric filters to be applied to
- * the Analytics data.
+ * A comma-separated list of dimension or metric filters to be applied to the Analytics data.
*/
filters?: string;
/**
- * Unique table ID for retrieving Analytics data. Table ID is of the form
- * ga:XXXX, where XXXX is the Analytics view (profile) ID.
+ * Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
*/
ids?: string;
/**
@@ -3098,9 +2766,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * A comma-separated list of Multi-Channel Funnels metrics. E.g.,
- * 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must
- * be specified.
+ * A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.
*/
metrics?: string;
/**
@@ -3108,19 +2774,15 @@ export namespace analytics_v3 {
*/
samplingLevel?: string;
/**
- * A comma-separated list of dimensions or metrics that determine the sort
- * order for the Analytics data.
+ * A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
*/
sort?: string;
/**
- * Start date for fetching Analytics data. Requests can specify a start date
- * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday,
- * or 7daysAgo). The default value is 7daysAgo.
+ * Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.
*/
'start-date'?: string;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -3219,18 +2881,15 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * A comma-separated list of real time dimensions. E.g.,
- * 'rt:medium,rt:city'.
+ * A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
*/
dimensions?: string;
/**
- * A comma-separated list of dimension or metric filters to be applied to
- * real time data.
+ * A comma-separated list of dimension or metric filters to be applied to real time data.
*/
filters?: string;
/**
- * Unique table ID for retrieving real time data. Table ID is of the form
- * ga:XXXX, where XXXX is the Analytics view (profile) ID.
+ * Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.
*/
ids?: string;
/**
@@ -3238,13 +2897,11 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At
- * least one metric must be specified.
+ * A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.
*/
metrics?: string;
/**
- * A comma-separated list of dimensions or metrics that determine the sort
- * order for real time data.
+ * A comma-separated list of dimensions or metrics that determine the sort order for real time data.
*/
sort?: string;
}
@@ -3408,8 +3065,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first account to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -3422,8 +3078,7 @@ export namespace analytics_v3 {
/**
* analytics.management.accountSummaries.list
- * @desc Lists account summaries (lightweight tree comprised of
- * accounts/properties/profiles) to which the user has access.
+ * @desc Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.
* @alias analytics.management.accountSummaries.list
* @memberOf! ()
*
@@ -3504,13 +3159,11 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of account summaries to include in this response,
- * where the largest acceptable value is 1000.
+ * The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -3871,8 +3524,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first account-user link to retrieve. Use this parameter
- * as a pagination mechanism along with the max-results parameter.
+ * An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -4095,8 +3747,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * A 1-based index of the first custom data source to retrieve. Use this
- * parameter as a pagination mechanism along with the max-results parameter.
+ * A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
@@ -4342,8 +3993,7 @@ export namespace analytics_v3 {
/**
* analytics.management.customDimensions.patch
- * @desc Updates an existing custom dimension. This method supports patch
- * semantics.
+ * @desc Updates an existing custom dimension. This method supports patch semantics.
* @alias analytics.management.customDimensions.patch
* @memberOf! ()
*
@@ -4555,8 +4205,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
@@ -4580,8 +4229,7 @@ export namespace analytics_v3 {
*/
customDimensionId?: string;
/**
- * Force the update and ignore any warnings related to the custom dimension
- * being linked to a custom data source / data set.
+ * Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
*/
ignoreCustomDataSourceLinks?: boolean;
/**
@@ -4610,8 +4258,7 @@ export namespace analytics_v3 {
*/
customDimensionId?: string;
/**
- * Force the update and ignore any warnings related to the custom dimension
- * being linked to a custom data source / data set.
+ * Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
*/
ignoreCustomDataSourceLinks?: boolean;
/**
@@ -4862,8 +4509,7 @@ export namespace analytics_v3 {
/**
* analytics.management.customMetrics.patch
- * @desc Updates an existing custom metric. This method supports patch
- * semantics.
+ * @desc Updates an existing custom metric. This method supports patch semantics.
* @alias analytics.management.customMetrics.patch
* @memberOf! ()
*
@@ -5075,8 +4721,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
@@ -5100,8 +4745,7 @@ export namespace analytics_v3 {
*/
customMetricId?: string;
/**
- * Force the update and ignore any warnings related to the custom metric
- * being linked to a custom data source / data set.
+ * Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
*/
ignoreCustomDataSourceLinks?: boolean;
/**
@@ -5130,8 +4774,7 @@ export namespace analytics_v3 {
*/
customMetricId?: string;
/**
- * Force the update and ignore any warnings related to the custom metric
- * being linked to a custom data source / data set.
+ * Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
*/
ignoreCustomDataSourceLinks?: boolean;
/**
@@ -5470,8 +5113,7 @@ export namespace analytics_v3 {
/**
* analytics.management.experiments.patch
- * @desc Update an existing experiment. This method supports patch
- * semantics.
+ * @desc Update an existing experiment. This method supports patch semantics.
* @alias analytics.management.experiments.patch
* @memberOf! ()
*
@@ -5729,8 +5371,7 @@ export namespace analytics_v3 {
*/
profileId?: string;
/**
- * An index of the first experiment to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
@@ -6308,8 +5949,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -6798,8 +6438,7 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Account ID to retrieve goals for. Can either be a specific account ID or
- * '~all', which refers to all the accounts that user has access to.
+ * Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
*/
accountId?: string;
/**
@@ -6807,20 +6446,15 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * View (Profile) ID to retrieve goals for. Can either be a specific view
- * (profile) ID or '~all', which refers to all the views (profiles) that
- * user has access to.
+ * View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.
*/
profileId?: string;
/**
- * An index of the first goal to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
- * Web property ID to retrieve goals for. Can either be a specific web
- * property ID or '~all', which refers to all the web properties that user
- * has access to.
+ * Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
*/
webPropertyId?: string;
}
@@ -7198,8 +6832,7 @@ export namespace analytics_v3 {
/**
* analytics.management.profileFilterLinks.patch
- * @desc Update an existing profile filter link. This method supports patch
- * semantics.
+ * @desc Update an existing profile filter link. This method supports patch semantics.
* @alias analytics.management.profileFilterLinks.patch
* @memberOf! ()
*
@@ -7443,19 +7076,15 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * Profile ID to retrieve filter links for. Can either be a specific profile
- * ID or '~all', which refers to all the profiles that user has access to.
+ * Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.
*/
profileId?: string;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
- * Web property Id for profile filter links for. Can either be a specific
- * web property ID or '~all', which refers to all the web properties that
- * user has access to.
+ * Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
*/
webPropertyId?: string;
}
@@ -7823,8 +7452,7 @@ export namespace analytics_v3 {
/**
* analytics.management.profiles.patch
- * @desc Updates an existing view (profile). This method supports patch
- * semantics.
+ * @desc Updates an existing view (profile). This method supports patch semantics.
* @alias analytics.management.profiles.patch
* @memberOf! ()
*
@@ -8042,9 +7670,7 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Account ID for the view (profiles) to retrieve. Can either be a specific
- * account ID or '~all', which refers to all the accounts to which the user
- * has access.
+ * Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.
*/
accountId?: string;
/**
@@ -8052,14 +7678,11 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
- * Web property ID for the views (profiles) to retrieve. Can either be a
- * specific web property ID or '~all', which refers to all the web
- * properties to which the user has access.
+ * Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.
*/
webPropertyId?: string;
}
@@ -8352,8 +7975,7 @@ export namespace analytics_v3 {
/**
* analytics.management.profileUserLinks.update
- * @desc Updates permissions for an existing user on the given view
- * (profile).
+ * @desc Updates permissions for an existing user on the given view (profile).
* @alias analytics.management.profileUserLinks.update
* @memberOf! ()
*
@@ -8495,20 +8117,15 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * View (Profile) ID to retrieve the profile-user links for. Can either be a
- * specific profile ID or '~all', which refers to all the profiles that user
- * has access to.
+ * View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.
*/
profileId?: string;
/**
- * An index of the first profile-user link to retrieve. Use this parameter
- * as a pagination mechanism along with the max-results parameter.
+ * An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
- * Web Property ID which the given view (profile) belongs to. Can either be
- * a specific web property ID or '~all', which refers to all the web
- * properties that user has access to.
+ * Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
*/
webPropertyId?: string;
}
@@ -8856,8 +8473,7 @@ export namespace analytics_v3 {
/**
* analytics.management.remarketingAudience.patch
- * @desc Updates an existing remarketing audience. This method supports
- * patch semantics.
+ * @desc Updates an existing remarketing audience. This method supports patch semantics.
* @alias analytics.management.remarketingAudience.patch
* @memberOf! ()
*
@@ -9087,8 +8703,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
@@ -9243,8 +8858,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first segment to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -9664,8 +9278,7 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Account ID to retrieve unsampled reports for. Must be a specific account
- * ID, ~all is not supported.
+ * Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.
*/
accountId?: string;
/**
@@ -9673,18 +9286,15 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * View (Profile) ID to retrieve unsampled reports for. Must be a specific
- * view (profile) ID, ~all is not supported.
+ * View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.
*/
profileId?: string;
/**
- * An index of the first unsampled report to retrieve. Use this parameter as
- * a pagination mechanism along with the max-results parameter.
+ * An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
- * Web property ID to retrieve unsampled reports for. Must be a specific web
- * property ID, ~all is not supported.
+ * Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.
*/
webPropertyId?: string;
}
@@ -10082,8 +9692,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * A 1-based index of the first upload to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
@@ -10210,9 +9819,7 @@ export namespace analytics_v3 {
/**
* analytics.management.webproperties.insert
- * @desc Create a new property if the account has fewer than 20 properties.
- * Web properties are visible in the Google Analytics interface only if they
- * have at least one profile.
+ * @desc Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.
* @alias analytics.management.webproperties.insert
* @memberOf! ()
*
@@ -10363,8 +9970,7 @@ export namespace analytics_v3 {
/**
* analytics.management.webproperties.patch
- * @desc Updates an existing web property. This method supports patch
- * semantics.
+ * @desc Updates an existing web property. This method supports patch semantics.
* @alias analytics.management.webproperties.patch
* @memberOf! ()
*
@@ -10556,9 +10162,7 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Account ID to retrieve web properties for. Can either be a specific
- * account ID or '~all', which refers to all the accounts that user has
- * access to.
+ * Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
*/
accountId?: string;
/**
@@ -10566,8 +10170,7 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first entity to retrieve. Use this parameter as a
- * pagination mechanism along with the max-results parameter.
+ * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
}
@@ -10700,8 +10303,7 @@ export namespace analytics_v3 {
/**
* analytics.management.webPropertyAdWordsLinks.get
- * @desc Returns a web property-Google Ads link to which the user has
- * access.
+ * @desc Returns a web property-Google Ads link to which the user has access.
* @alias analytics.management.webPropertyAdWordsLinks.get
* @memberOf! ()
*
@@ -10934,8 +10536,7 @@ export namespace analytics_v3 {
/**
* analytics.management.webPropertyAdWordsLinks.patch
- * @desc Updates an existing webProperty-Google Ads link. This method
- * supports patch semantics.
+ * @desc Updates an existing webProperty-Google Ads link. This method supports patch semantics.
* @alias analytics.management.webPropertyAdWordsLinks.patch
* @memberOf! ()
*
@@ -11169,13 +10770,11 @@ export namespace analytics_v3 {
*/
accountId?: string;
/**
- * The maximum number of webProperty-Google Ads links to include in this
- * response.
+ * The maximum number of webProperty-Google Ads links to include in this response.
*/
'max-results'?: number;
/**
- * An index of the first webProperty-Google Ads link to retrieve. Use this
- * parameter as a pagination mechanism along with the max-results parameter.
+ * An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
@@ -11602,14 +11201,11 @@ export namespace analytics_v3 {
*/
'max-results'?: number;
/**
- * An index of the first webProperty-user link to retrieve. Use this
- * parameter as a pagination mechanism along with the max-results parameter.
+ * An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
*/
'start-index'?: number;
/**
- * Web Property ID for the webProperty-user links to retrieve. Can either be
- * a specific web property ID or '~all', which refers to all the web
- * properties that user has access to.
+ * Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.
*/
webPropertyId?: string;
}
@@ -11734,8 +11330,7 @@ export namespace analytics_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core
- * Reporting API
+ * Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API
*/
reportType?: string;
}
diff --git a/src/apis/analyticsreporting/package.json b/src/apis/analyticsreporting/package.json
index e30ccb8cad2..8d13d19fd57 100644
--- a/src/apis/analyticsreporting/package.json
+++ b/src/apis/analyticsreporting/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/analyticsreporting/v4.ts b/src/apis/analyticsreporting/v4.ts
index 0f29979353c..d7e38d37e40 100644
--- a/src/apis/analyticsreporting/v4.ts
+++ b/src/apis/analyticsreporting/v4.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace analyticsreporting_v4 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace analyticsreporting_v4 {
*/
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.
+ * 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;
/**
@@ -113,7 +109,10 @@ export namespace analyticsreporting_v4 {
userActivity: Resource$Useractivity;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.reports = new Resource$Reports(this.context);
this.userActivity = new Resource$Useractivity(this.context);
@@ -121,14 +120,7 @@ export namespace analyticsreporting_v4 {
}
/**
- * 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 {
/**
@@ -144,15 +136,11 @@ export namespace analyticsreporting_v4 {
*/
appview?: Schema$ScreenviewData;
/**
- * For manual campaign tracking, it is the value of the utm_campaign
- * campaign tracking parameter. For AdWords autotagging, it is the name(s)
- * of the online ad campaign(s) you use for the property. If you use
- * neither, its value is (not set).
+ * For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set).
*/
campaign?: string;
/**
- * 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;
/**
@@ -164,13 +152,11 @@ export namespace analyticsreporting_v4 {
*/
ecommerce?: Schema$EcommerceData;
/**
- * This field contains all the details pertaining to an event and will be
- * set if `activity_type` equals `EVENT`.
+ * This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`.
*/
event?: Schema$EventData;
/**
- * This field contains a list of all the goals that were reached in this
- * activity when `activity_type` equals `GOAL`.
+ * This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`.
*/
goals?: Schema$GoalSetData;
/**
@@ -178,13 +164,7 @@ export namespace analyticsreporting_v4 {
*/
hostname?: string;
/**
- * For manual campaign tracking, it is the value of the utm_term campaign
- * tracking parameter. For AdWords traffic, it contains the best matching
- * targeting criteria. For the display network, where multiple targeting
- * criteria could have caused the ad to show up, it returns the best
- * matching targeting criteria as selected by Ads. This could be
- * display_keyword, site placement, boomuserlist, user_interest, age, or
- * gender. Otherwise its value is (not set).
+ * For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).
*/
keyword?: string;
/**
@@ -192,68 +172,37 @@ export namespace analyticsreporting_v4 {
*/
landingPagePath?: string;
/**
- * The type of referrals. For manual campaign tracking, it is the value of
- * the utm_medium campaign tracking parameter. For AdWords autotagging, it
- * is cpc. If users came from a search engine detected by Google Analytics,
- * it is organic. If the referrer is not a search engine, it is referral. If
- * users came directly to the property and document.referrer is empty, its
- * value is (none).
+ * The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none).
*/
medium?: string;
/**
- * This will be set if `activity_type` equals `PAGEVIEW`. This field
- * contains all the details about the visitor and the page that was visited.
+ * This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited.
*/
pageview?: Schema$PageviewData;
/**
- * The source of referrals. For manual campaign tracking, it is the value of
- * the utm_source campaign tracking parameter. For AdWords autotagging, it
- * is google. If you use neither, it is the domain of the source (e.g.,
- * document.referrer) referring the users. It may also contain a port
- * address. If users arrived without a referrer, its value is (direct).
+ * The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct).
*/
source?: string;
}
/**
- * Defines a cohort. A cohort is a group of users who share a common
- * characteristic. For example, all users with the same acquisition date
- * belong to the same cohort.
+ * Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.
*/
export interface Schema$Cohort {
/**
- * This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users
- * whose first visit date is between start date and end date defined in the
- * DateRange. The date ranges should be aligned for cohort requests. If the
- * request contains `ga:cohortNthDay` it should be exactly one day long, if
- * `ga:cohortNthWeek` it should be aligned to the week boundary (starting at
- * Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range
- * should be aligned to the month (starting at the first and ending on the
- * last day of the month). For LTV requests there are no such restrictions.
- * You do not need to supply a date range for the
- * `reportsRequest.dateRanges` field.
+ * This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange. The date ranges should be aligned for cohort requests. If the request contains `ga:cohortNthDay` it should be exactly one day long, if `ga:cohortNthWeek` it should be aligned to the week boundary (starting at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range should be aligned to the month (starting at the first and ending on the last day of the month). For LTV requests there are no such restrictions. You do not need to supply a date range for the `reportsRequest.dateRanges` field.
*/
dateRange?: Schema$DateRange;
/**
- * A unique name for the cohort. If not defined name will be auto-generated
- * with values cohort_[1234...].
+ * A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].
*/
name?: string;
/**
- * Type of the cohort. The only supported type as of now is
- * `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as
- * `FIRST_VISIT_DATE` type cohort.
+ * Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type cohort.
*/
type?: string;
}
/**
- * 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 {
/**
@@ -261,26 +210,7 @@ export 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;
}
@@ -306,15 +236,12 @@ export namespace analyticsreporting_v4 {
*/
index?: number;
/**
- * Value of the custom dimension. Default value (i.e. empty string)
- * indicates clearing sesion/visitor scope custom dimension value.
+ * Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value.
*/
value?: string;
}
/**
- * A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The
- * start and end dates are specified in
- * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
+ * A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
*/
export interface Schema$DateRange {
/**
@@ -327,8 +254,7 @@ export namespace analyticsreporting_v4 {
startDate?: string;
}
/**
- * Used to return a list of metrics for a single DateRange / dimension
- * combination
+ * Used to return a list of metrics for a single DateRange / dimension combination
*/
export interface Schema$DateRangeValues {
/**
@@ -341,37 +267,11 @@ export namespace analyticsreporting_v4 {
values?: string[];
}
/**
- * [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[];
/**
@@ -392,15 +292,11 @@ export namespace analyticsreporting_v4 {
*/
dimensionName?: string;
/**
- * Strings or regular expression to match against. Only the first value of
- * the list is used for comparison unless the operator is `IN_LIST`. If
- * `IN_LIST` operator, then the entire list is used to filter the dimensions
- * as explained in the description of the `IN_LIST` operator.
+ * Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` operator, then the entire list is used to filter the dimensions as explained in the description of the `IN_LIST` operator.
*/
expressions?: string[];
/**
- * Logical `NOT` operator. If this boolean is set to true, then the matching
- * dimension values will be excluded in the report. The default is false.
+ * Logical `NOT` operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false.
*/
not?: boolean;
/**
@@ -409,24 +305,20 @@ export namespace analyticsreporting_v4 {
operator?: string;
}
/**
- * A group of dimension filters. Set the operator value to specify how the
- * filters are logically combined.
+ * A group of dimension filters. Set the operator value to specify how the filters are logically combined.
*/
export interface Schema$DimensionFilterClause {
/**
- * The repeated set of filters. They are logically combined based on the
- * operator specified.
+ * The repeated set of filters. They are logically combined based on the operator specified.
*/
filters?: Schema$DimensionFilter[];
/**
- * The operator for combining multiple dimension filters. If unspecified, it
- * is treated as an `OR`.
+ * The operator for combining multiple dimension filters. If unspecified, it is treated as an `OR`.
*/
operator?: string;
}
/**
- * Dynamic segment definition for defining the segment within the request. A
- * segment can select users, sessions or both.
+ * Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.
*/
export interface Schema$DynamicSegment {
/**
@@ -493,31 +385,20 @@ export namespace analyticsreporting_v4 {
*/
export interface Schema$GetReportsRequest {
/**
- * Requests, each request will have a separate response. There can be a
- * maximum of 5 requests. All requests should have the same `dateRanges`,
- * `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.
+ * Requests, each request will have a separate response. There can be a maximum of 5 requests. All requests should have the same `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.
*/
reportRequests?: Schema$ReportRequest[];
/**
- * Enables [resource based
- * quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4),
- * (defaults to `False`). If this field is set to `True` the per view
- * (profile) quotas are governed by the computational cost of the request.
- * Note that using cost based quotas will higher enable sampling rates. (10
- * Million for `SMALL`, 100M for `LARGE`. See the [limits and quotas
- * documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4)
- * for details.
+ * Enables [resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4), (defaults to `False`). If this field is set to `True` the per view (profile) quotas are governed by the computational cost of the request. Note that using cost based quotas will higher enable sampling rates. (10 Million for `SMALL`, 100M for `LARGE`. See the [limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details.
*/
useResourceQuotas?: boolean;
}
/**
- * The main response class which holds the reports from the Reporting API
- * `batchGet` call.
+ * The main response class which holds the reports from the Reporting API `batchGet` call.
*/
export interface Schema$GetReportsResponse {
/**
- * The amount of resource quota tokens deducted to execute the query.
- * Includes all responses.
+ * The amount of resource quota tokens deducted to execute the query. Includes all responses.
*/
queryCost?: number;
/**
@@ -576,33 +457,19 @@ export namespace analyticsreporting_v4 {
goals?: Schema$GoalData[];
}
/**
- * [Metrics](https://support.google.com/analytics/answer/1033861) are the
- * quantitative measurements. For example, the metric `ga:users` indicates the
- * total number of users for the requested time period.
+ * [Metrics](https://support.google.com/analytics/answer/1033861) are the quantitative measurements. For example, the metric `ga:users` indicates the total number of users for the requested time period.
*/
export interface Schema$Metric {
/**
- * An alias for the metric expression is an alternate name for the
- * expression. The alias can be used for filtering and sorting. This field
- * is optional and is useful if the expression is not a single metric but a
- * complex expression which cannot be used in filtering and sorting. The
- * alias is also used in the response column header.
+ * An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header.
*/
alias?: string;
/**
- * A metric expression in the request. An expression is constructed from one
- * or more metrics and numbers. Accepted operators include: Plus (+), Minus
- * (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
- * Positive cardinal numbers (0-9), can include decimals and is limited to
- * 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
- * metric expression is just a single metric name like `ga:users`. Adding
- * mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result
- * in unexpected results.
+ * A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the metric expression is just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results.
*/
expression?: string;
/**
- * Specifies how the metric expression should be formatted, for example
- * `INTEGER`.
+ * Specifies how the metric expression should be formatted, for example `INTEGER`.
*/
formattingType?: string;
}
@@ -615,36 +482,28 @@ export namespace analyticsreporting_v4 {
*/
comparisonValue?: string;
/**
- * The metric that will be filtered on. A metricFilter must contain a metric
- * name. A metric name can be an alias earlier defined as a metric or it can
- * also be a metric expression.
+ * The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression.
*/
metricName?: string;
/**
- * Logical `NOT` operator. If this boolean is set to true, then the matching
- * metric values will be excluded in the report. The default is false.
+ * Logical `NOT` operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false.
*/
not?: boolean;
/**
- * Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue,
- * the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the
- * metric is missing and would ignore the comparisonValue.
+ * Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is missing and would ignore the comparisonValue.
*/
operator?: string;
}
/**
- * Represents a group of metric filters. Set the operator value to specify how
- * the filters are logically combined.
+ * Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.
*/
export interface Schema$MetricFilterClause {
/**
- * The repeated set of filters. They are logically combined based on the
- * operator specified.
+ * The repeated set of filters. They are logically combined based on the operator specified.
*/
filters?: Schema$MetricFilter[];
/**
- * The operator for combining multiple metric filters. If unspecified, it is
- * treated as an `OR`.
+ * The operator for combining multiple metric filters. If unspecified, it is treated as an `OR`.
*/
operator?: string;
}
@@ -679,9 +538,7 @@ export namespace analyticsreporting_v4 {
*/
export interface Schema$OrderBy {
/**
- * The field which to sort by. The default sort order is ascending. Example:
- * `ga:browser`. Note, that you can only specify one field for sort here.
- * For example, `ga:browser, ga:city` is not valid.
+ * The field which to sort by. The default sort order is ascending. Example: `ga:browser`. Note, that you can only specify one field for sort here. For example, `ga:browser, ga:city` is not valid.
*/
fieldName?: string;
/**
@@ -694,8 +551,7 @@ export namespace analyticsreporting_v4 {
sortOrder?: string;
}
/**
- * A list of segment filters in the `OR` group are combined with the logical
- * OR operator.
+ * A list of segment filters in the `OR` group are combined with the logical OR operator.
*/
export interface Schema$OrFiltersForSegment {
/**
@@ -717,51 +573,27 @@ export namespace analyticsreporting_v4 {
pageTitle?: string;
}
/**
- * The Pivot describes the pivot section in the request. The Pivot helps
- * rearrange the information in the table for certain reports by pivoting your
- * data on a second dimension.
+ * The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension.
*/
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[];
/**
- * A list of dimensions to show as pivot columns. A Pivot can have a maximum
- * of 4 dimensions. Pivot dimensions are part of the restriction on the
- * total number of dimensions allowed in the request.
+ * A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request.
*/
dimensions?: Schema$Dimension[];
/**
- * Specifies the maximum number of groups to return. The default value is
- * 10, also the maximum value is 1,000.
+ * Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000.
*/
maxGroupCount?: number;
/**
- * The pivot metrics. Pivot metrics are part of the restriction on total
- * number of metrics allowed in the request.
+ * The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.
*/
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;
}
@@ -779,8 +611,7 @@ export namespace analyticsreporting_v4 {
totalPivotGroupsCount?: number;
}
/**
- * The headers for the each of the metric column corresponding to the metrics
- * requested in the pivots section of the response.
+ * The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.
*/
export interface Schema$PivotHeaderEntry {
/**
@@ -814,8 +645,7 @@ export namespace analyticsreporting_v4 {
*/
itemRevenue?: number;
/**
- * The product name, supplied by the e-commerce tracking application, for
- * the purchased items.
+ * The product name, supplied by the e-commerce tracking application, for the purchased items.
*/
productName?: string;
/**
@@ -849,26 +679,19 @@ export namespace analyticsreporting_v4 {
*/
export interface Schema$ReportData {
/**
- * The last time the data in the report was refreshed. All the hits received
- * before this timestamp are included in the calculation of the report.
+ * The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report.
*/
dataLastRefreshed?: string;
/**
- * Indicates if response to this request is golden or not. Data is golden
- * when the exact same request will not produce any new results if asked at
- * a later point in time.
+ * Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time.
*/
isDataGolden?: boolean;
/**
- * Minimum and maximum values seen over all matching rows. These are both
- * empty when `hideValueRanges` in the request is false, or when rowCount is
- * zero.
+ * Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero.
*/
maximums?: Schema$DateRangeValues[];
/**
- * Minimum and maximum values seen over all matching rows. These are both
- * empty when `hideValueRanges` in the request is false, or when rowCount is
- * zero.
+ * Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero.
*/
minimums?: Schema$DateRangeValues[];
/**
@@ -880,31 +703,15 @@ export namespace analyticsreporting_v4 {
*/
rows?: Schema$ReportRow[];
/**
- * If the results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
- * returns the total number of samples read, one entry per date range. If
- * the results are not sampled this field will not be defined. See
- * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
- * for details.
+ * If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
*/
samplesReadCounts?: string[];
/**
- * If the results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
- * returns the total number of samples present, one entry per date range. If
- * the results are not sampled this field will not be defined. See
- * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
- * for details.
+ * If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
*/
samplingSpaceSizes?: string[];
/**
- * 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[];
}
@@ -913,30 +720,15 @@ export namespace analyticsreporting_v4 {
*/
export interface Schema$ReportRequest {
/**
- * Cohort group associated with this request. If there is a cohort group in
- * the request the `ga:cohort` dimension must be present. Every
- * [ReportRequest](#ReportRequest) within a `batchGet` method must contain
- * the same `cohortGroup` definition.
+ * Cohort group associated with this request. If there is a cohort group in the request the `ga:cohort` dimension must be present. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `cohortGroup` definition.
*/
cohortGroup?: Schema$CohortGroup;
/**
- * Date ranges in the request. The request can have a maximum of 2 date
- * ranges. The response will contain a set of metric values for each
- * combination of the dimensions for each date range in the request. So, if
- * there are two date ranges, there will be two set of metric values, one
- * for the original date range and one for the second date range. The
- * `reportRequest.dateRanges` field should not be specified for cohorts or
- * Lifetime value requests. If a date range is not provided, the default
- * date range is (startDate: current date - 7 days, endDate: current date -
- * 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method
- * must contain the same `dateRanges` definition.
+ * Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The `reportRequest.dateRanges` field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `dateRanges` definition.
*/
dateRanges?: Schema$DateRange[];
/**
- * The dimension filter clauses for filtering Dimension Values. They are
- * logically combined with the `AND` operator. Note that filtering occurs
- * before any dimensions are aggregated, so that the returned metrics
- * represent the total for only the relevant dimensions.
+ * The dimension filter clauses for filtering Dimension Values. They are logically combined with the `AND` operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions.
*/
dimensionFilterClauses?: Schema$DimensionFilterClause[];
/**
@@ -944,65 +736,39 @@ export namespace analyticsreporting_v4 {
*/
dimensions?: Schema$Dimension[];
/**
- * Dimension or metric filters that restrict the data returned for your
- * request. To use the `filtersExpression`, supply a dimension or metric on
- * which to filter, followed by the filter expression. For example, the
- * following expression selects `ga:browser` dimension which starts with
- * Firefox; `ga:browser=~^Firefox`. For more information on dimensions and
- * metric filters, see [Filters
- * reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
+ * Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
*/
filtersExpression?: string;
/**
- * If set to true, hides the total of all metrics for all the matching rows,
- * for every date range. The default false and will return the totals.
+ * If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
*/
hideTotals?: boolean;
/**
- * If set to true, hides the minimum and maximum across all matching rows.
- * The default is false and the value ranges are returned.
+ * If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.
*/
hideValueRanges?: boolean;
/**
- * If set to false, the response does not include rows if all the retrieved
- * metrics are equal to zero. The default is false which will exclude these
- * rows.
+ * If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.
*/
includeEmptyRows?: boolean;
/**
- * 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[];
/**
- * The metrics requested. Requests must specify at least one metric.
- * Requests can have a total of 10 metrics.
+ * The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.
*/
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;
/**
- * A continuation token to get the next page of the results. Adding this to
- * the request will return the rows after the pageToken. The pageToken
- * should be the value returned in the nextPageToken parameter in the
- * response to the GetReports request.
+ * A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request.
*/
pageToken?: string;
/**
@@ -1010,28 +776,15 @@ export 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;
/**
- * Segment the data returned for the request. A segment definition helps
- * look at a subset of the segment request. A request can contain up to four
- * segments. Every [ReportRequest](#ReportRequest) within a `batchGet`
- * method must contain the same `segments` definition. Requests with
- * segments must have the `ga:segment` dimension.
+ * Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension.
*/
segments?: Schema$Segment[];
/**
- * The Analytics [view
- * ID](https://support.google.com/analytics/answer/1009618) from which to
- * retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet`
- * method must contain the same `viewId`.
+ * The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `viewId`.
*/
viewId?: string;
}
@@ -1049,8 +802,7 @@ export namespace analyticsreporting_v4 {
metrics?: Schema$DateRangeValues[];
}
/**
- * The resource quota tokens remaining for the property after the request is
- * completed.
+ * The resource quota tokens remaining for the property after the request is completed.
*/
export interface Schema$ResourceQuotasRemaining {
/**
@@ -1068,8 +820,7 @@ export namespace analyticsreporting_v4 {
*/
appName?: string;
/**
- * Mobile manufacturer or branded name. Eg: "Google",
- * "Apple" etc.
+ * Mobile manufacturer or branded name. Eg: "Google", "Apple" etc.
*/
mobileDeviceBranding?: string;
/**
@@ -1082,49 +833,31 @@ export namespace analyticsreporting_v4 {
screenName?: string;
}
/**
- * The request to fetch User Report from Reporting API `userActivity:get`
- * call.
+ * The request to fetch User Report from Reporting API `userActivity:get` call.
*/
export interface Schema$SearchUserActivityRequest {
/**
- * Set of all activity types being requested. Only acvities matching these
- * types will be returned in the response. If empty, all activies will be
- * returned.
+ * Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned.
*/
activityTypes?: string[];
/**
- * Date range for which to retrieve the user activity. If a date range is
- * not provided, the default date range is (startDate: current date - 7
- * days, endDate: current date - 1 day).
+ * Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day).
*/
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;
/**
- * A continuation token to get the next page of the results. Adding this to
- * the request will return the rows after the pageToken. The pageToken
- * should be the value returned in the nextPageToken parameter in the
- * response to the [SearchUserActivityRequest](#SearchUserActivityRequest)
- * request.
+ * A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the [SearchUserActivityRequest](#SearchUserActivityRequest) request.
*/
pageToken?: string;
/**
- * Required. Unique user Id to query for. Every
- * [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this
- * field.
+ * Required. Unique user Id to query for. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this field.
*/
user?: Schema$User;
/**
- * Required. The Analytics [view
- * ID](https://support.google.com/analytics/answer/1009618) from which to
- * retrieve data. Every
- * [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the
- * `viewId`.
+ * Required. The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the `viewId`.
*/
viewId?: string;
}
@@ -1133,17 +866,11 @@ export namespace analyticsreporting_v4 {
*/
export interface Schema$SearchUserActivityResponse {
/**
- * This token should be passed to
- * [SearchUserActivityRequest](#SearchUserActivityRequest) to retrieve the
- * next page.
+ * This token should be passed to [SearchUserActivityRequest](#SearchUserActivityRequest) to retrieve the next page.
*/
nextPageToken?: string;
/**
- * This field represents the [sampling
- * rate](https://support.google.com/analytics/answer/2637192) for the given
- * request and is a number between 0.0 to 1.0. See [developer
- * guide](/analytics/devguides/reporting/core/v4/basics#sampling) for
- * details.
+ * This field represents the [sampling rate](https://support.google.com/analytics/answer/2637192) for the given request and is a number between 0.0 to 1.0. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
*/
sampleRate?: number;
/**
@@ -1156,9 +883,7 @@ export namespace analyticsreporting_v4 {
totalRows?: number;
}
/**
- * The segment definition, if the report needs to be segmented. A Segment is a
- * subset of the Analytics data. For example, of the entire set of users, one
- * Segment might be users from a particular country or city.
+ * The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city.
*/
export interface Schema$Segment {
/**
@@ -1171,13 +896,11 @@ export namespace analyticsreporting_v4 {
segmentId?: string;
}
/**
- * SegmentDefinition defines the segment to be a set of SegmentFilters which
- * are combined together with a logical `AND` operation.
+ * SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical `AND` operation.
*/
export interface Schema$SegmentDefinition {
/**
- * A segment is defined by a set of segment filters which are combined
- * together with a logical `AND` operation.
+ * A segment is defined by a set of segment filters which are combined together with a logical `AND` operation.
*/
segmentFilters?: Schema$SegmentFilter[];
}
@@ -1211,39 +934,24 @@ export namespace analyticsreporting_v4 {
operator?: string;
}
/**
- * SegmentFilter defines the segment to be either a simple or a sequence
- * segment. A simple segment condition contains dimension and metric
- * conditions to select the sessions or users. A sequence segment condition
- * can be used to select users or sessions based on sequential conditions.
+ * SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.
*/
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;
/**
- * Sequence conditions consist of one or more steps, where each step is
- * defined by one or more dimension/metric conditions. Multiple steps can be
- * combined with special sequence operators.
+ * Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.
*/
sequenceSegment?: Schema$SequenceSegment;
/**
- * A Simple segment conditions consist of one or more dimension/metric
- * conditions that can be combined
+ * A Simple segment conditions consist of one or more dimension/metric conditions that can be combined
*/
simpleSegment?: Schema$SimpleSegment;
}
/**
- * Filter Clause to be used in a segment definition, can be wither a metric or
- * a dimension filter.
+ * Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter.
*/
export interface Schema$SegmentFilterClause {
/**
@@ -1264,8 +972,7 @@ export namespace analyticsreporting_v4 {
*/
export interface Schema$SegmentMetricFilter {
/**
- * The value to compare against. If the operator is `BETWEEN`, this value is
- * treated as minimum comparison value.
+ * The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.
*/
comparisonValue?: string;
/**
@@ -1273,20 +980,15 @@ export namespace analyticsreporting_v4 {
*/
maxComparisonValue?: string;
/**
- * The metric that will be filtered on. A `metricFilter` must contain a
- * metric name.
+ * The metric that will be filtered on. A `metricFilter` must contain a metric name.
*/
metricName?: string;
/**
- * Specifies is the operation to perform to compare the metric. The default
- * is `EQUAL`.
+ * Specifies is the operation to perform to compare the metric. The default is `EQUAL`.
*/
operator?: string;
/**
- * 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;
}
@@ -1295,25 +997,20 @@ export namespace analyticsreporting_v4 {
*/
export interface Schema$SegmentSequenceStep {
/**
- * Specifies if the step immediately precedes or can be any time before the
- * next step.
+ * Specifies if the step immediately precedes or can be any time before the next step.
*/
matchType?: string;
/**
- * A sequence is specified with a list of Or grouped filters which are
- * combined with `AND` operator.
+ * A sequence is specified with a list of Or grouped filters which are combined with `AND` operator.
*/
orFiltersForSegment?: Schema$OrFiltersForSegment[];
}
/**
- * Sequence conditions consist of one or more steps, where each step is
- * defined by one or more dimension/metric conditions. Multiple steps can be
- * combined with special sequence operators.
+ * Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.
*/
export interface Schema$SequenceSegment {
/**
- * If set, first step condition must match the first hit of the visitor (in
- * the date range).
+ * If set, first step condition must match the first hit of the visitor (in the date range).
*/
firstStepShouldMatchFirstHit?: boolean;
/**
@@ -1322,24 +1019,20 @@ export namespace analyticsreporting_v4 {
segmentSequenceSteps?: Schema$SegmentSequenceStep[];
}
/**
- * A Simple segment conditions consist of one or more dimension/metric
- * conditions that can be combined.
+ * A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.
*/
export interface Schema$SimpleSegment {
/**
- * A list of segment filters groups which are combined with logical `AND`
- * operator.
+ * A list of segment filters groups which are combined with logical `AND` operator.
*/
orFiltersForSegment?: Schema$OrFiltersForSegment[];
}
/**
- * Represents details collected when the visitor performs a transaction on the
- * page.
+ * Represents details collected when the visitor performs a transaction on the page.
*/
export interface Schema$TransactionData {
/**
- * The transaction ID, supplied by the e-commerce tracking method, for the
- * purchase in the shopping cart.
+ * The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart.
*/
transactionId?: string;
/**
@@ -1360,8 +1053,7 @@ export namespace analyticsreporting_v4 {
*/
export interface Schema$User {
/**
- * Type of the user in the request. The field `userId` is associated with
- * this type.
+ * Type of the user in the request. The field `userId` is associated with this type.
*/
type?: string;
/**
@@ -1370,8 +1062,7 @@ export namespace analyticsreporting_v4 {
userId?: string;
}
/**
- * This represents a user session performed on a specific device at a certain
- * time over a period of time.
+ * This represents a user session performed on a specific device at a certain time over a period of time.
*/
export interface Schema$UserActivitySession {
/**
@@ -1379,10 +1070,7 @@ export 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;
/**
@@ -1390,8 +1078,7 @@ export namespace analyticsreporting_v4 {
*/
deviceCategory?: string;
/**
- * Platform on which the activity happened: "android",
- * "ios" etc.
+ * Platform on which the activity happened: "android", "ios" etc.
*/
platform?: string;
/**
diff --git a/src/apis/androiddeviceprovisioning/package.json b/src/apis/androiddeviceprovisioning/package.json
index c882db7399d..58cd296bb3d 100644
--- a/src/apis/androiddeviceprovisioning/package.json
+++ b/src/apis/androiddeviceprovisioning/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts
index 08538a71767..a12c84d0662 100644
--- a/src/apis/androiddeviceprovisioning/v1.ts
+++ b/src/apis/androiddeviceprovisioning/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* Android Device Provisioning Partner API
*
- * Automates Android zero-touch enrollment for device resellers, customers,
- * and EMMs.
+ * Automates Android zero-touch enrollment for device resellers, customers, and EMMs.
*
* @example
* const {google} = require('googleapis');
@@ -115,7 +110,10 @@ export namespace androiddeviceprovisioning_v1 {
partners: Resource$Partners;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.customers = new Resource$Customers(this.context);
this.operations = new Resource$Operations(this.context);
@@ -153,15 +151,12 @@ export namespace androiddeviceprovisioning_v1 {
*/
deviceId?: string;
/**
- * The resource name of the device in the format
- * `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
+ * The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
*/
deviceName?: string;
}
/**
- * Request to claim devices asynchronously in batch. Claiming a device adds
- * the device to zero-touch enrollment and shows the device in the
- * customer's view of the portal.
+ * Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal.
*/
export interface Schema$ClaimDevicesRequest {
/**
@@ -170,13 +165,11 @@ export namespace androiddeviceprovisioning_v1 {
claims?: Schema$PartnerClaim[];
}
/**
- * A reseller, vendor, or customer in the zero-touch reseller and customer
- * APIs.
+ * A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
*/
export interface Schema$Company {
/**
- * Input only. Optional. Email address of customer's users in the admin
- * role. Each email address must be associated with a Google Account.
+ * Input only. Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.
*/
adminEmails?: string[];
/**
@@ -184,45 +177,28 @@ export namespace androiddeviceprovisioning_v1 {
*/
companyId?: string;
/**
- * Required. The name of the company. For example _XYZ Corp_. Displayed to
- * the company's employees in the zero-touch enrollment portal.
+ * Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.
*/
companyName?: string;
/**
- * Output only. The API resource name of the company. The resource name is
- * one of the following formats: *
- * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` *
- * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` *
- * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]`
- * Assigned by the server.
+ * Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
*/
name?: string;
/**
- * Input only. Email address of customer's users in the owner role. At
- * least one `owner_email` is required. Each email address must be
- * associated with a Google Account. Owners share the same access as admins
- * but can also add, delete, and edit your organization's portal users.
+ * Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.
*/
ownerEmails?: string[];
/**
- * Output only. Whether any user from the company has accepted the latest
- * Terms of Service (ToS). See TermsStatus.
+ * Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
*/
termsStatus?: string;
}
/**
- * A configuration collects the provisioning options for Android devices. Each
- * configuration combines the following: * The EMM device policy controller
- * (DPC) installed on the devices. * EMM policies enforced on the devices. *
- * Metadata displayed on the device to help users during setup. Customers can
- * add as many configurations as they need. However, zero-touch enrollment
- * works best when a customer sets a default configuration that's applied
- * to any new devices the organization purchases.
+ * A configuration collects the provisioning options for Android devices. Each configuration combines the following: * The EMM device policy controller (DPC) installed on the devices. * EMM policies enforced on the devices. * Metadata displayed on the device to help users during setup. Customers can add as many configurations as they need. However, zero-touch enrollment works best when a customer sets a default configuration that's applied to any new devices the organization purchases.
*/
export interface Schema$Configuration {
/**
- * Required. The name of the organization. Zero-touch enrollment shows this
- * organization name to device users during device provisioning.
+ * Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning.
*/
companyName?: string;
/**
@@ -230,29 +206,19 @@ export namespace androiddeviceprovisioning_v1 {
*/
configurationId?: string;
/**
- * Required. A short name that describes the configuration's purpose.
- * For example, _Sales team_ or _Temporary employees_. The zero-touch
- * enrollment portal displays this name to IT admins.
+ * Required. A short name that describes the configuration's purpose. For example, _Sales team_ or _Temporary employees_. The zero-touch enrollment portal displays this name to IT admins.
*/
configurationName?: string;
/**
- * Required. The email address that device users can contact to get help.
- * Zero-touch enrollment shows this email address to device users before
- * device provisioning. The value is validated on input.
+ * Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input.
*/
contactEmail?: string;
/**
- * Required. The telephone number that device users can call, using another
- * device, to get help. Zero-touch enrollment shows this number to device
- * users before device provisioning. Accepts numerals, spaces, the plus
- * sign, hyphens, and parentheses.
+ * Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses.
*/
contactPhone?: string;
/**
- * A message, containing one or two sentences, to help device users get help
- * or give them more details about what’s happening to their device.
- * Zero-touch enrollment shows this message before the device is
- * provisioned.
+ * A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned.
*/
customMessage?: string;
/**
@@ -260,23 +226,15 @@ export namespace androiddeviceprovisioning_v1 {
*/
dpcExtras?: string;
/**
- * Required. The resource name of the selected DPC (device policy
- * controller) in the format `customers/[CUSTOMER_ID]/dpcs/x. To list the
- * supported DPCs, call `customers.dpcs.list`.
+ * Required. The resource name of the selected DPC (device policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/x. To list the supported DPCs, call `customers.dpcs.list`.
*/
dpcResourcePath?: string;
/**
- * Required. Whether this is the default configuration that zero-touch
- * enrollment applies to any new devices the organization purchases in the
- * future. Only one customer configuration can be the default. Setting this
- * value to `true`, changes the previous default configuration's
- * `isDefault` value to `false`.
+ * Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to `true`, changes the previous default configuration's `isDefault` value to `false`.
*/
isDefault?: boolean;
/**
- * Output only. The API resource name in the format
- * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
- * the server.
+ * Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.
*/
name?: string;
}
@@ -285,10 +243,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
export interface Schema$CreateCustomerRequest {
/**
- * Required. The company data to populate the new customer. Must contain a
- * value for `companyName` and at least one `owner_email` that's
- * associated with a Google Account. The values for `companyId` and `name`
- * must be empty.
+ * Required. The company data to populate the new customer. Must contain a value for `companyName` and at least one `owner_email` that's associated with a Google Account. The values for `companyId` and `name` must be empty.
*/
customer?: Schema$Company;
}
@@ -297,8 +252,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
export interface Schema$CustomerApplyConfigurationRequest {
/**
- * Required. The configuration applied to the device in the format
- * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
+ * Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
*/
configuration?: string;
/**
@@ -324,8 +278,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
customers?: Schema$Company[];
/**
- * A token used to access the next page of results. Omitted if no further
- * results are available.
+ * A token used to access the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string;
}
@@ -338,8 +291,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
devices?: Schema$Device[];
/**
- * A token used to access the next page of results. Omitted if no further
- * results are available.
+ * A token used to access the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string;
}
@@ -348,8 +300,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
export interface Schema$CustomerListDpcsResponse {
/**
- * The list of DPCs available to the customer that support zero-touch
- * enrollment.
+ * The list of DPCs available to the customer that support zero-touch enrollment.
*/
dpcs?: Schema$Dpc[];
}
@@ -376,11 +327,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
export interface Schema$Device {
/**
- * Output only. The provisioning claims for a device. Devices claimed for
- * zero-touch enrollment have a claim with the type
- * `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or
- * `partners.devices.unclaimAsync` to remove the device from zero-touch
- * enrollment.
+ * Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
*/
claims?: Schema$DeviceClaim[];
/**
@@ -392,26 +339,20 @@ export namespace androiddeviceprovisioning_v1 {
*/
deviceId?: string;
/**
- * The hardware IDs that identify a manufactured device. To learn more, read
- * [Identifiers](/zero-touch/guides/identifiers).
+ * The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](/zero-touch/guides/identifiers).
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
- * The metadata attached to the device. Structured as key-value pairs. To
- * learn more, read [Device metadata](/zero-touch/guides/metadata).
+ * The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](/zero-touch/guides/metadata).
*/
deviceMetadata?: Schema$DeviceMetadata;
/**
- * Output only. The API resource name in the format
- * `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+ * Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
*/
name?: string;
}
/**
- * A record of a device claimed by a reseller for a customer. Devices claimed
- * for zero-touch enrollment have a claim with the type
- * `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for
- * customers](/zero-touch/guides/how-it-works#claim).
+ * A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
*/
export interface Schema$DeviceClaim {
/**
@@ -427,20 +368,16 @@ export namespace androiddeviceprovisioning_v1 {
*/
sectionType?: string;
/**
- * The timestamp when the device will exit ‘vacation mode’. This value is
- * present iff the device is in 'vacation mode'.
+ * The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
*/
vacationModeExpireTime?: string;
/**
- * The timestamp when the device was put into ‘vacation mode’. This value is
- * present iff the device is in 'vacation mode'.
+ * The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
*/
vacationModeStartTime?: string;
}
/**
- * Encapsulates hardware and product IDs to identify a manufactured device. To
- * understand requirements on identifier sets, read
- * [Identifiers](/zero-touch/guides/identifiers).
+ * Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](/zero-touch/guides/identifiers).
*/
export interface Schema$DeviceIdentifier {
/**
@@ -448,10 +385,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
imei?: string;
/**
- * The device manufacturer’s name. Matches the device's built-in value
- * returned from `android.os.Build.MANUFACTURER`. Allowed values are listed
- * in
- * [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
+ * The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
*/
manufacturer?: string;
/**
@@ -459,20 +393,16 @@ export namespace androiddeviceprovisioning_v1 {
*/
meid?: string;
/**
- * The device model's name. Matches the device's built-in value
- * returned from `android.os.Build.MODEL`. Allowed values are listed in
- * [models](/zero-touch/resources/manufacturer-names#model-names).
+ * The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
*/
model?: string;
/**
- * The manufacturer's serial number for the device. This value might not
- * be unique across different device models.
+ * The manufacturer's serial number for the device. This value might not be unique across different device models.
*/
serialNumber?: string;
}
/**
- * Metadata entries that can be attached to a `Device`. To learn more, read
- * [Device metadata](/zero-touch/guides/metadata).
+ * Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](/zero-touch/guides/metadata).
*/
export interface Schema$DeviceMetadata {
/**
@@ -481,13 +411,7 @@ export namespace androiddeviceprovisioning_v1 {
entries?: {[key: string]: string};
}
/**
- * A `DeviceReference` is an API abstraction that lets you supply a _device_
- * argument to a method using one of the following identifier types: * A
- * numeric API resource ID. * Real-world hardware IDs, such as IMEI number,
- * belonging to the manufactured device. Methods that operate on devices
- * take a `DeviceReference` as a parameter type because it's more flexible
- * for the caller. To learn more about device identifiers, read
- * [Identifiers](/zero-touch/guides/identifiers).
+ * A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](/zero-touch/guides/identifiers).
*/
export interface Schema$DeviceReference {
/**
@@ -500,16 +424,11 @@ export namespace androiddeviceprovisioning_v1 {
deviceIdentifier?: Schema$DeviceIdentifier;
}
/**
- * Tracks the status of a long-running operation to asynchronously update a
- * batch of reseller metadata attached to devices. To learn more, read
- * [Long‑running batch
- * operations](/zero-touch/guides/how-it-works#operations).
+ * Tracks the status of a long-running operation to asynchronously update a batch of reseller metadata attached to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
*/
export interface Schema$DevicesLongRunningOperationMetadata {
/**
- * The number of metadata updates in the operation. This might be different
- * from the number of updates in the request if the API can't parse some
- * of the updates.
+ * The number of metadata updates in the operation. This might be different from the number of updates in the request if the API can't parse some of the updates.
*/
devicesCount?: number;
/**
@@ -517,64 +436,42 @@ export namespace androiddeviceprovisioning_v1 {
*/
processingStatus?: string;
/**
- * The processing progress of the operation. Measured as a number from 0 to
- * 100. A value of 10O doesnt always mean the operation completed—check for
- * the inclusion of a `done` field.
+ * The processing progress of the operation. Measured as a number from 0 to 100. A value of 10O doesnt always mean the operation completed—check for the inclusion of a `done` field.
*/
progress?: number;
}
/**
- * Tracks the status of a long-running operation to claim, unclaim, or attach
- * metadata to devices. To learn more, read [Long‑running batch
- * operations](/zero-touch/guides/how-it-works#operations).
+ * Tracks the status of a long-running operation to claim, unclaim, or attach metadata to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
*/
export interface Schema$DevicesLongRunningOperationResponse {
/**
- * The processing status for each device in the operation. One
- * `PerDeviceStatus` per device. The list order matches the items in the
- * original request.
+ * The processing status for each device in the operation. One `PerDeviceStatus` per device. The list order matches the items in the original request.
*/
perDeviceStatus?: Schema$OperationPerDevice[];
/**
- * A summary of how many items in the operation the server processed
- * successfully. Updated as the operation progresses.
+ * A summary of how many items in the operation the server processed successfully. Updated as the operation progresses.
*/
successCount?: number;
}
/**
- * An EMM's DPC ([device policy
- * controller](http://developer.android.com/work/dpc/build-dpc.html)).
- * Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a
- * device to maintain the customer's mobile policies. All the DPCs listed
- * by the API support zero-touch enrollment and are available in Google Play.
+ * An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a device to maintain the customer's mobile policies. All the DPCs listed by the API support zero-touch enrollment and are available in Google Play.
*/
export interface Schema$Dpc {
/**
- * Output only. The title of the DPC app in Google Play. For example,
- * _Google Apps Device Policy_. Useful in an application's user
- * interface.
+ * Output only. The title of the DPC app in Google Play. For example, _Google Apps Device Policy_. Useful in an application's user interface.
*/
dpcName?: string;
/**
- * Output only. The API resource name in the format
- * `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To
- * maintain a reference to a DPC across customer accounts, persist and match
- * the last path component (`DPC_ID`).
+ * Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across customer accounts, persist and match the last path component (`DPC_ID`).
*/
name?: string;
/**
- * Output only. The DPC's Android application ID that looks like a Java
- * package name. Zero-touch enrollment installs the DPC app onto a device
- * using this identifier.
+ * Output only. The DPC's Android application ID that looks like a Java package name. Zero-touch enrollment installs the DPC app onto a device using this identifier.
*/
packageName?: string;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
@@ -586,8 +483,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
deviceIdentifier?: Schema$DeviceIdentifier;
/**
- * Required. The maximum number of devices to show in a page of results.
- * Must be between 1 and 100 inclusive.
+ * Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
*/
limit?: string;
/**
@@ -604,8 +500,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
devices?: Schema$Device[];
/**
- * A token used to access the next page of results. Omitted if no further
- * results are available.
+ * A token used to access the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string;
/**
@@ -622,8 +517,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
customerId?: string[];
/**
- * Required. The maximum number of devices to show in a page of results.
- * Must be between 1 and 100 inclusive.
+ * Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
*/
limit?: string;
/**
@@ -644,8 +538,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
devices?: Schema$Device[];
/**
- * A token used to access the next page of results. Omitted if no further
- * results are available.
+ * A token used to access the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string;
/**
@@ -662,8 +555,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
customers?: Schema$Company[];
/**
- * A token to retrieve the next page of results. Omitted if no further
- * results are available.
+ * A token to retrieve the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string;
/**
@@ -680,8 +572,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
customers?: Schema$Company[];
/**
- * A token to retrieve the next page of results. Omitted if no further
- * results are available.
+ * A token to retrieve the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string;
/**
@@ -694,8 +585,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
export interface Schema$ListVendorsResponse {
/**
- * A token to retrieve the next page of results. Omitted if no further
- * results are available.
+ * A token to retrieve the next page of results. Omitted if no further results are available.
*/
nextPageToken?: string;
/**
@@ -703,51 +593,37 @@ export namespace androiddeviceprovisioning_v1 {
*/
totalSize?: number;
/**
- * List of vendors of the reseller partner. Fields `name`, `companyId` and
- * `companyName` are populated to the Company object.
+ * List of vendors of the reseller partner. Fields `name`, `companyId` and `companyName` are populated to the Company object.
*/
vendors?: Schema$Company[];
}
/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
+ * This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
- * If the value is `false`, it means the operation is still in progress. If
- * `true`, the operation is completed, and either `error` or `response` is
- * available.
+ * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean;
/**
- * This field will always be not set if the operation is created by
- * `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case,
- * error information for each device is set in
- * `response.perDeviceStatus.result.status`.
+ * This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
*/
error?: Schema$Status;
/**
- * This field will contain a `DevicesLongRunningOperationMetadata` object if
- * the operation is created by `claimAsync`, `unclaimAsync`, or
- * `updateMetadataAsync`.
+ * This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
*/
metadata?: {[key: string]: any};
/**
- * The server-assigned name, which is only unique within the same service
- * that originally returns it. If you use the default HTTP mapping, the
- * `name` should have the format of `operations/some/unique/name`.
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
*/
name?: string;
/**
- * This field will contain a `DevicesLongRunningOperationResponse` object if
- * the operation is created by `claimAsync`, `unclaimAsync`, or
- * `updateMetadataAsync`.
+ * This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
*/
response?: {[key: string]: any};
}
/**
- * A task for each device in the operation. Corresponds to each device change
- * in the request.
+ * A task for each device in the operation. Corresponds to each device change in the request.
*/
export interface Schema$OperationPerDevice {
/**
@@ -805,8 +681,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
sectionType?: string;
/**
- * The duration of the vacation unlock starting from when the request is
- * processed. (1 day is treated as 24 hours)
+ * The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
*/
vacationModeDays?: number;
/**
@@ -836,40 +711,7 @@ export namespace androiddeviceprovisioning_v1 {
status?: string;
}
/**
- * The `Status` type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by [gRPC](https://github.com/grpc). The error model is designed to be:
- * - Simple to use and understand for most users - Flexible enough to meet
- * unexpected needs # Overview The `Status` message contains three pieces of
- * data: error code, error message, and error details. The error code should
- * be an enum value of google.rpc.Code, but it may accept additional error
- * codes if needed. The error message should be a developer-facing English
- * message that helps developers *understand* and *resolve* the error. If a
- * localized user-facing error message is needed, put the localized message in
- * the error details or localize it in the client. The optional error details
- * may contain arbitrary information about the error. There is a predefined
- * set of error detail types in the package `google.rpc` that can be used for
- * common error conditions. # Language mapping The `Status` message is the
- * logical representation of the error model, but it is not necessarily the
- * actual wire format. When the `Status` message is exposed in different
- * client libraries and different wire protocols, it can be mapped
- * differently. For example, it will likely be mapped to some exceptions in
- * Java, but more likely mapped to some error codes in C. # Other uses The
- * error model and the `Status` message can be used in a variety of
- * environments, either with or without APIs, to provide a consistent
- * developer experience across different environments. Example uses of this
- * error model include: - Partial errors. If a service needs to return
- * partial errors to the client, it may embed the `Status` in the normal
- * response to indicate the partial errors. - Workflow errors. A typical
- * workflow has multiple steps. Each step may have a `Status` message for
- * error reporting. - Batch operations. If a client uses batch request and
- * batch response, the `Status` message should be used directly inside
- * batch response, one for each error sub-response. - Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the `Status` message. - Logging. If some API errors are stored in
- * logs, the message `Status` could be used directly after any stripping
- * needed for security/privacy reasons.
+ * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -877,14 +719,11 @@ export namespace androiddeviceprovisioning_v1 {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set
- * of message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
@@ -905,8 +744,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
sectionType?: string;
/**
- * The duration of the vacation unlock starting from when the request is
- * processed. (1 day is treated as 24 hours)
+ * The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
*/
vacationModeDays?: number;
/**
@@ -1060,8 +898,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of customers to show in a page of results. A number
- * between 1 and 100 (inclusive).
+ * The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive).
*/
pageSize?: number;
/**
@@ -1078,8 +915,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.customers.configurations.create
- * @desc Creates a new configuration. Once created, a customer can apply the
- * configuration to devices.
+ * @desc Creates a new configuration. Once created, a customer can apply the configuration to devices.
* @alias androiddeviceprovisioning.customers.configurations.create
* @memberOf! ()
*
@@ -1155,8 +991,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.customers.configurations.delete
- * @desc Deletes an unused configuration. The API call fails if the customer
- * has devices with the configuration applied.
+ * @desc Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.
* @alias androiddeviceprovisioning.customers.configurations.delete
* @memberOf! ()
*
@@ -1463,8 +1298,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The customer that manages the configuration. An API resource
- * name in the format `customers/[CUSTOMER_ID]`.
+ * Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
@@ -1481,9 +1315,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The configuration to delete. An API resource name in the format
- * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the
- * configuration is applied to any devices, the API call fails.
+ * Required. The configuration to delete. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the configuration is applied to any devices, the API call fails.
*/
name?: string;
}
@@ -1495,8 +1327,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The configuration to get. An API resource name in the format
- * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
+ * Required. The configuration to get. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
*/
name?: string;
}
@@ -1508,8 +1339,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The customer that manages the listed configurations. An API
- * resource name in the format `customers/[CUSTOMER_ID]`.
+ * Required. The customer that manages the listed configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
}
@@ -1521,16 +1351,11 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Output only. The API resource name in the format
- * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
- * the server.
+ * Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.
*/
name?: string;
/**
- * Required. The field mask applied to the target `Configuration` before
- * updating the fields. To learn more about using field masks, read
- * [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask)
- * in the Protocol Buffers documentation.
+ * Required. The field mask applied to the target `Configuration` before updating the fields. To learn more about using field masks, read [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers documentation.
*/
updateMask?: string;
@@ -1548,10 +1373,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.customers.devices.applyConfiguration
- * @desc Applies a Configuration to the device to register the device for
- * zero-touch enrollment. After applying a configuration to a device, the
- * device automatically provisions itself on first boot, or next factory
- * reset.
+ * @desc Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.
* @alias androiddeviceprovisioning.customers.devices.applyConfiguration
* @memberOf! ()
*
@@ -1852,9 +1674,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.customers.devices.unclaim
- * @desc Unclaims a device from a customer and removes it from zero-touch
- * enrollment. After removing a device, a customer must contact their
- * reseller to register the device into zero-touch enrollment again.
+ * @desc Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again.
* @alias androiddeviceprovisioning.customers.devices.unclaim
* @memberOf! ()
*
@@ -1935,8 +1755,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The customer managing the device. An API resource name in the
- * format `customers/[CUSTOMER_ID]`.
+ * Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
@@ -1953,8 +1772,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The device to get. An API resource name in the format
- * `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.
+ * Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.
*/
name?: string;
}
@@ -1966,8 +1784,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of devices to show in a page of results. Must be
- * between 1 and 100 inclusive.
+ * The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
*/
pageSize?: string;
/**
@@ -1975,8 +1792,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
pageToken?: string;
/**
- * Required. The customer managing the devices. An API resource name in the
- * format `customers/[CUSTOMER_ID]`.
+ * Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
}
@@ -1988,8 +1804,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The customer managing the device in the format
- * `customers/[CUSTOMER_ID]`.
+ * Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
@@ -2006,8 +1821,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The customer managing the device. An API resource name in the
- * format `customers/[CUSTOMER_ID]`.
+ * Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
@@ -2025,8 +1839,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.customers.dpcs.list
- * @desc Lists the DPCs (device policy controllers) that support zero-touch
- * enrollment.
+ * @desc Lists the DPCs (device policy controllers) that support zero-touch enrollment.
* @alias androiddeviceprovisioning.customers.dpcs.list
* @memberOf! ()
*
@@ -2107,8 +1920,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The customer that can use the DPCs in configurations. An API
- * resource name in the format `customers/[CUSTOMER_ID]`.
+ * Required. The customer that can use the DPCs in configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.
*/
parent?: string;
}
@@ -2121,9 +1933,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.operations.get
- * @desc Gets the latest state of a long-running operation. Clients can use
- * this method to poll the operation result at intervals as recommended by
- * the API service.
+ * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias androiddeviceprovisioning.operations.get
* @memberOf! ()
*
@@ -2226,11 +2036,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.partners.customers.create
- * @desc Creates a customer for zero-touch enrollment. After the method
- * returns successfully, admin and owner roles can manage devices and EMM
- * configs by calling API methods or using their zero-touch enrollment
- * portal. The customer receives an email that welcomes them to zero-touch
- * enrollment and explains how to sign into the portal.
+ * @desc Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.
* @alias androiddeviceprovisioning.partners.customers.create
* @memberOf! ()
*
@@ -2304,9 +2110,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.partners.customers.list
- * @desc Lists the customers that are enrolled to the reseller identified by
- * the `partnerId` argument. This list includes customers that the reseller
- * created and customers that enrolled themselves using the portal.
+ * @desc Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.
* @alias androiddeviceprovisioning.partners.customers.list
* @memberOf! ()
*
@@ -2392,8 +2196,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The parent resource ID in the format `partners/[PARTNER_ID]`
- * that identifies the reseller.
+ * Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller.
*/
parent?: string;
@@ -2410,8 +2213,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The maximum number of results to be returned. If not specified or 0, all
- * the records are returned.
+ * The maximum number of results to be returned. If not specified or 0, all the records are returned.
*/
pageSize?: number;
/**
@@ -2432,9 +2234,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.partners.devices.claim
- * @desc Claims a device for a customer and adds it to zero-touch
- * enrollment. If the device is already claimed by another customer, the
- * call returns an error.
+ * @desc Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.
* @alias androiddeviceprovisioning.partners.devices.claim
* @memberOf! ()
*
@@ -2510,9 +2310,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.partners.devices.claimAsync
- * @desc Claims a batch of devices for a customer asynchronously. Adds the
- * devices to zero-touch enrollment. To learn more, read [Long‑running batch
- * operations](/zero-touch/guides/how-it-works#operations).
+ * @desc Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
* @alias androiddeviceprovisioning.partners.devices.claimAsync
* @memberOf! ()
*
@@ -2679,10 +2477,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.partners.devices.findByOwner
- * @desc Finds devices claimed for customers. The results only contain
- * devices registered to the reseller that's identified by the `partnerId`
- * argument. The customer's devices purchased from other resellers don't
- * appear in the results.
+ * @desc Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results.
* @alias androiddeviceprovisioning.partners.devices.findByOwner
* @memberOf! ()
*
@@ -2911,8 +2706,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.partners.devices.unclaim
- * @desc Unclaims a device from a customer and removes it from zero-touch
- * enrollment.
+ * @desc Unclaims a device from a customer and removes it from zero-touch enrollment.
* @alias androiddeviceprovisioning.partners.devices.unclaim
* @memberOf! ()
*
@@ -2985,9 +2779,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.partners.devices.unclaimAsync
- * @desc Unclaims a batch of devices for a customer asynchronously. Removes
- * the devices from zero-touch enrollment. To learn more, read [Long‑running
- * batch operations](/zero-touch/guides/how-it-works#operations).
+ * @desc Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
* @alias androiddeviceprovisioning.partners.devices.unclaimAsync
* @memberOf! ()
*
@@ -3062,10 +2854,7 @@ export namespace androiddeviceprovisioning_v1 {
/**
* androiddeviceprovisioning.partners.devices.updateMetadataAsync
- * @desc Updates the reseller metadata attached to a batch of devices. This
- * method updates devices asynchronously and returns an `Operation` that can
- * be used to track progress. Read [Long‑running batch
- * operations](/zero-touch/guides/how-it-works#operations).
+ * @desc Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
* @alias androiddeviceprovisioning.partners.devices.updateMetadataAsync
* @memberOf! ()
*
@@ -3215,8 +3004,7 @@ export namespace androiddeviceprovisioning_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The device API resource name in the format
- * `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
+ * Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
*/
name?: string;
}
@@ -3232,8 +3020,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
deviceId?: string;
/**
- * Required. The owner of the newly set metadata. Set this to the partner
- * ID.
+ * Required. The owner of the newly set metadata. Set this to the partner ID.
*/
metadataOwnerId?: string;
@@ -3508,8 +3295,7 @@ export namespace androiddeviceprovisioning_v1 {
*/
pageToken?: string;
/**
- * Required. The resource name in the format
- * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`.
+ * Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`.
*/
parent?: string;
}
diff --git a/src/apis/androidenterprise/package.json b/src/apis/androidenterprise/package.json
index 09662807920..8698868c4a9 100644
--- a/src/apis/androidenterprise/package.json
+++ b/src/apis/androidenterprise/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts
index 261374aa07f..731133e05ab 100644
--- a/src/apis/androidenterprise/v1.ts
+++ b/src/apis/androidenterprise/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace androidenterprise_v1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace androidenterprise_v1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -110,7 +107,10 @@ export namespace androidenterprise_v1 {
webapps: Resource$Webapps;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.devices = new Resource$Devices(this.context);
this.enterprises = new Resource$Enterprises(this.context);
@@ -138,8 +138,7 @@ export namespace androidenterprise_v1 {
}
/**
- * This represents an enterprise admin who can manage the enterprise in the
- * managed Google Play store.
+ * This represents an enterprise admin who can manage the enterprise in the managed Google Play store.
*/
export interface Schema$Administrator {
/**
@@ -152,8 +151,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$AdministratorWebToken {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#administratorWebToken".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebToken".
*/
kind?: string;
/**
@@ -162,14 +160,11 @@ export namespace androidenterprise_v1 {
token?: string;
}
/**
- * Specification for a token used to generate iframes. The token specifies
- * what data the admin is allowed to modify and the URI the iframe is allowed
- * to communiate with.
+ * Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with.
*/
export interface Schema$AdministratorWebTokenSpec {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#administratorWebTokenSpec".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebTokenSpec".
*/
kind?: string;
/**
@@ -177,8 +172,7 @@ export namespace androidenterprise_v1 {
*/
managedConfigurations?: Schema$AdministratorWebTokenSpecManagedConfigurations;
/**
- * The URI of the parent frame hosting the iframe. To prevent XSS, the
- * iframe may not be hosted at other URIs. This URI must be https.
+ * The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https.
*/
parent?: string;
/**
@@ -237,13 +231,11 @@ export namespace androidenterprise_v1 {
enabled?: boolean;
}
/**
- * Represents the list of app restrictions available to be pre-configured for
- * the product.
+ * Represents the list of app restrictions available to be pre-configured for the product.
*/
export interface Schema$AppRestrictionsSchema {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#appRestrictionsSchema".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema".
*/
kind?: string;
/**
@@ -252,54 +244,40 @@ export namespace androidenterprise_v1 {
restrictions?: Schema$AppRestrictionsSchemaRestriction[];
}
/**
- * An event generated when a new app version is uploaded to Google Play and
- * its app restrictions schema changed. To fetch the app restrictions schema
- * for an app, use Products.getAppRestrictionsSchema on the EMM API.
+ * An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API.
*/
export interface Schema$AppRestrictionsSchemaChangeEvent {
/**
- * The id of the product (e.g. "app:com.google.android.gm") for
- * which the app restriction schema changed. This field will always be
- * present.
+ * The id of the product (e.g. "app:com.google.android.gm") for which the app restriction schema changed. This field will always be present.
*/
productId?: string;
}
/**
- * A restriction in the App Restriction Schema represents a piece of
- * configuration that may be pre-applied.
+ * A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.
*/
export interface Schema$AppRestrictionsSchemaRestriction {
/**
- * The default value of the restriction. bundle and bundleArray restrictions
- * never have a default value.
+ * The default value of the restriction. bundle and bundleArray restrictions never have a default value.
*/
defaultValue?: Schema$AppRestrictionsSchemaRestrictionRestrictionValue;
/**
- * A longer description of the restriction, giving more detail of what it
- * affects.
+ * A longer description of the restriction, giving more detail of what it affects.
*/
description?: string;
/**
- * For choice or multiselect restrictions, the list of possible entries'
- * human-readable names.
+ * For choice or multiselect restrictions, the list of possible entries' human-readable names.
*/
entry?: string[];
/**
- * For choice or multiselect restrictions, the list of possible entries'
- * machine-readable values. These values should be used in the
- * configuration, either as a single string value for a choice restriction
- * or in a stringArray for a multiselect restriction.
+ * For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction.
*/
entryValue?: string[];
/**
- * The unique key that the product uses to identify the restriction, e.g.
- * "com.google.android.gm.fieldname".
+ * The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname".
*/
key?: string;
/**
- * For bundle or bundleArray restrictions, the list of nested restrictions.
- * A bundle restriction is always nested within a bundleArray restriction,
- * and a bundleArray restriction is at most two levels deep.
+ * For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep.
*/
nestedRestriction?: Schema$AppRestrictionsSchemaRestriction[];
/**
@@ -328,13 +306,11 @@ export namespace androidenterprise_v1 {
*/
valueInteger?: number;
/**
- * The list of string values - this will only be present if type is
- * multiselect.
+ * The list of string values - this will only be present if type is multiselect.
*/
valueMultiselect?: string[];
/**
- * The string value - this will be present for types string, choice and
- * hidden.
+ * The string value - this will be present for types string, choice and hidden.
*/
valueString?: string;
}
@@ -343,26 +319,20 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ApprovalUrlInfo {
/**
- * A URL that displays a product's permissions and that can also be used
- * to approve the product with the Products.approve call.
+ * A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call.
*/
approvalUrl?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#approvalUrlInfo".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#approvalUrlInfo".
*/
kind?: string;
}
/**
- * An event generated when a new version of an app is uploaded to Google Play.
- * Notifications are sent for new public versions only: alpha, beta, or canary
- * versions do not generate this event. To fetch up-to-date version history
- * for an app, use Products.Get on the EMM API.
+ * An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API.
*/
export interface Schema$AppUpdateEvent {
/**
- * The id of the product (e.g. "app:com.google.android.gm") that
- * was updated. This field will always be present.
+ * The id of the product (e.g. "app:com.google.android.gm") that was updated. This field will always be present.
*/
productId?: string;
}
@@ -379,9 +349,7 @@ export namespace androidenterprise_v1 {
*/
track?: string;
/**
- * Track ids that the app version is published in. Replaces the track field
- * (deprecated), but doesn't include the production track (see
- * isProduction instead).
+ * Track ids that the app version is published in. Replaces the track field (deprecated), but doesn't include the production track (see isProduction instead).
*/
trackId?: string[];
/**
@@ -389,32 +357,25 @@ export namespace androidenterprise_v1 {
*/
versionCode?: number;
/**
- * The string used in the Play store by the app developer to identify the
- * version. The string is not necessarily unique or localized (for example,
- * the string could be "1.4").
+ * The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4").
*/
versionString?: string;
}
/**
- * An AuthenticationToken is used by the EMM's device policy client on a
- * device to provision the given EMM-managed user on that device.
+ * An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.
*/
export interface Schema$AuthenticationToken {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#authenticationToken".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken".
*/
kind?: string;
/**
- * The authentication token to be passed to the device policy client on the
- * device where it can be used to provision the account for which this token
- * was generated.
+ * The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated.
*/
token?: string;
}
/**
- * The auto-install constraint. Defines a set of restrictions for
- * installation. At least one of the fields must be set.
+ * The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.
*/
export interface Schema$AutoInstallConstraint {
/**
@@ -432,8 +393,7 @@ export namespace androidenterprise_v1 {
}
export interface Schema$AutoInstallPolicy {
/**
- * The constraints for auto-installing the app. You can specify a maximum of
- * one constraint.
+ * The constraints for auto-installing the app. You can specify a maximum of one constraint.
*/
autoInstallConstraint?: Schema$AutoInstallConstraint[];
/**
@@ -441,27 +401,20 @@ export namespace androidenterprise_v1 {
*/
autoInstallMode?: string;
/**
- * The priority of the install, as an unsigned integer. A lower number means
- * higher priority.
+ * The priority of the install, as an unsigned integer. A lower number means higher priority.
*/
autoInstallPriority?: number;
/**
- * The minimum version of the app. If a lower version of the app is
- * installed, then the app will be auto-updated according to the
- * auto-install constraints, instead of waiting for the regular auto-update.
+ * The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update.
*/
minimumVersionCode?: number;
}
/**
- * A configuration variables resource contains the managed configuration
- * settings ID to be applied to a single user, as well as the variable set
- * that is attributed to the user. The variable set will be used to replace
- * placeholders in the managed configuration settings.
+ * A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings.
*/
export interface Schema$ConfigurationVariables {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#configurationVariables".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
*/
kind?: string;
/**
@@ -474,32 +427,19 @@ export namespace androidenterprise_v1 {
variableSet?: Schema$VariableSet[];
}
/**
- * A Devices resource represents a mobile device managed by the EMM and
- * belonging to a specific enterprise user.
+ * A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
*/
export interface Schema$Device {
/**
- * The Google Play Services Android ID for the device encoded as a lowercase
- * hex string. For example, "123456789abcdef0".
+ * The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0".
*/
androidId?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#device".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
*/
kind?: string;
/**
- * Identifies the extent to which the device is controlled by a managed
- * Google Play EMM in various deployment configurations. Possible values
- * include: - "managedDevice", a device that has the EMM's
- * device policy controller (DPC) as the device owner. -
- * "managedProfile", a device that has a profile managed by the
- * DPC (DPC is profile owner) in addition to a separate, personal profile
- * that is unavailable to the DPC. - "containerApp", no longer
- * used (deprecated). - "unmanagedProfile", a device that has
- * been allowed (by the domain's admin, using the Admin Console to
- * enable the privilege) to use managed Google Play, but the profile is
- * itself not owned by a DPC.
+ * Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC.
*/
managementType?: string;
/**
@@ -516,48 +456,29 @@ export namespace androidenterprise_v1 {
*/
device?: Schema$Device[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#devicesListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse".
*/
kind?: string;
}
/**
- * The state of a user's device, as accessed by the getState and setState
- * methods on device resources.
+ * The state of a user's device, as accessed by the getState and setState methods on device resources.
*/
export interface Schema$DeviceState {
/**
- * The state of the Google account on the device. "enabled"
- * indicates that the Google account on the device can be used to access
- * Google services (including Google Play), while "disabled" means
- * that it cannot. A new device is initially in the "disabled"
- * state.
+ * The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
*/
accountState?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#deviceState".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
*/
kind?: string;
}
/**
- * An Enterprises resource represents the binding between an EMM and a
- * specific organization. That binding can be instantiated in one of two
- * different ways using this API as follows: - For Google managed domain
- * customers, the process involves using Enterprises.enroll and
- * Enterprises.setAccount (in conjunction with artifacts obtained from the
- * Admin console and the Google API Console) and submitted to the EMM through
- * a more-or-less manual process. - For managed Google Play Accounts
- * customers, the process involves using Enterprises.generateSignupUrl and
- * Enterprises.completeSignup in conjunction with the managed Google Play
- * sign-up UI (Google-provided mechanism) to create the binding without manual
- * steps. As an EMM, you can support either or both approaches in your EMM
- * console. See Create an Enterprise for details.
+ * An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
*/
export interface Schema$Enterprise {
/**
- * Admins of the enterprise. This is only supported for enterprises created
- * via the EMM-initiated flow.
+ * Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
*/
administrator?: Schema$Administrator[];
/**
@@ -565,8 +486,7 @@ export namespace androidenterprise_v1 {
*/
id?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#enterprise".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
*/
kind?: string;
/**
@@ -579,8 +499,7 @@ export namespace androidenterprise_v1 {
primaryDomain?: string;
}
/**
- * A service account that can be used to authenticate as the enterprise to API
- * calls that require such authentication.
+ * A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
*/
export interface Schema$EnterpriseAccount {
/**
@@ -588,8 +507,7 @@ export namespace androidenterprise_v1 {
*/
accountEmail?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#enterpriseAccount".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
*/
kind?: string;
}
@@ -602,8 +520,7 @@ export namespace androidenterprise_v1 {
*/
enterprise?: Schema$Enterprise[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#enterprisesListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse".
*/
kind?: string;
}
@@ -613,47 +530,24 @@ export namespace androidenterprise_v1 {
*/
messageId?: string;
/**
- * The name of the Cloud Pub/Sub topic to which notifications for this
- * enterprise's enrolled account will be sent.
+ * The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent.
*/
topicName?: string;
}
/**
- * The presence of an Entitlements resource indicates that a user has the
- * right to use a particular app. Entitlements are user specific, not device
- * specific. This allows a user with an entitlement to an app to install the
- * app on all their devices. It's also possible for a user to hold an
- * entitlement to an app without installing the app on any device. The API
- * can be used to create an entitlement. As an option, you can also use the
- * API to trigger the installation of an app on all a user's managed
- * devices at the same time the entitlement is created. If the app is free,
- * creating the entitlement also creates a group license for that app. For
- * paid apps, creating the entitlement consumes one license, and that license
- * remains consumed until the entitlement is removed. If the enterprise
- * hasn't purchased enough licenses, then no entitlement is created and
- * the installation fails. An entitlement is also not created for an app if
- * the app requires permissions that the enterprise hasn't accepted. If
- * an entitlement is deleted, the app may be uninstalled from a user's
- * device. As a best practice, uninstall the app by calling Installs.delete()
- * before deleting the entitlement. Entitlements for apps that a user pays
- * for on an unmanaged profile have "userPurchase" as the
- * entitlement reason. These entitlements cannot be removed via the API.
+ * The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.
*/
export interface Schema$Entitlement {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#entitlement".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
*/
kind?: string;
/**
- * The ID of the product that the entitlement is for. For example,
- * "app:com.google.android.gm".
+ * The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
*/
productId?: string;
/**
- * The reason for the entitlement. For example, "free" for free
- * apps. This property is temporary: it will be replaced by the acquisition
- * kind field of group licenses.
+ * The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
*/
reason?: string;
}
@@ -662,82 +556,44 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$EntitlementsListResponse {
/**
- * An entitlement of a user to a product (e.g. an app). For example, a free
- * app that they have installed, or a paid app that they have been allocated
- * a license to.
+ * An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to.
*/
entitlement?: Schema$Entitlement[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#entitlementsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlementsListResponse".
*/
kind?: string;
}
/**
- * Group license objects allow you to keep track of licenses (called
- * entitlements) for both free and paid apps. For a free app, a group license
- * is created when an enterprise admin first approves the product in Google
- * Play or when the first entitlement for the product is created for a user
- * via the API. For a paid app, a group license object is only created when an
- * enterprise admin purchases the product in Google Play for the first time.
- * Use the API to query group licenses. A Grouplicenses resource includes the
- * total number of licenses purchased (paid apps only) and the total number of
- * licenses currently in use. In other words, the total number of Entitlements
- * that exist for the product. Only one group license object is created per
- * product and group license objects are never deleted. If a product is
- * unapproved, its group license remains. This allows enterprise admins to
- * keep track of any remaining entitlements for the product.
+ * Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product.
*/
export interface Schema$GroupLicense {
/**
- * How this group license was acquired. "bulkPurchase" means that
- * this Grouplicenses resource was created because the enterprise purchased
- * licenses for this product; otherwise, the value is "free" (for
- * free products).
+ * How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products).
*/
acquisitionKind?: string;
/**
- * Whether the product to which this group license relates is currently
- * approved by the enterprise. Products are approved when a group license is
- * first created, but this approval may be revoked by an enterprise admin
- * via Google Play. Unapproved products will not be visible to end users in
- * collections, and new entitlements to them should not normally be created.
+ * Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created.
*/
approval?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#groupLicense".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".
*/
kind?: string;
/**
- * The total number of provisioned licenses for this product. Returned by
- * read operations, but ignored in write operations.
+ * The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.
*/
numProvisioned?: number;
/**
- * The number of purchased licenses (possibly in multiple purchases). If
- * this field is omitted, then there is no limit on the number of licenses
- * that can be provisioned (for example, if the acquisition kind is
- * "free").
+ * The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is "free").
*/
numPurchased?: number;
/**
- * The permission approval status of the product. This field is only set if
- * the product is approved. Possible states are: -
- * "currentApproved", the current set of permissions is approved,
- * but additional permissions will require the administrator to reapprove
- * the product (If the product was approved without specifying the approved
- * permissions setting, then this is the default behavior.), -
- * "needsReapproval", the product has unapproved permissions. No
- * additional product licenses can be assigned until the product is
- * reapproved, - "allCurrentAndFutureApproved", the current
- * permissions are approved and any future permission updates will be
- * automatically approved without administrator review.
+ * The permission approval status of the product. This field is only set if the product is approved. Possible states are: - "currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.), - "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, - "allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review.
*/
permissions?: string;
/**
- * The ID of the product that the license is for. For example,
- * "app:com.google.android.gm".
+ * The ID of the product that the license is for. For example, "app:com.google.android.gm".
*/
productId?: string;
}
@@ -750,8 +606,7 @@ export namespace androidenterprise_v1 {
*/
groupLicense?: Schema$GroupLicense[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#groupLicensesListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicensesListResponse".
*/
kind?: string;
}
@@ -760,8 +615,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$GroupLicenseUsersListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#groupLicenseUsersListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicenseUsersListResponse".
*/
kind?: string;
/**
@@ -770,46 +624,23 @@ export namespace androidenterprise_v1 {
user?: Schema$User[];
}
/**
- * The existence of an Installs resource indicates that an app is installed on
- * a particular device (or that an install is pending). The API can be used
- * to create an install resource using the update method. This triggers the
- * actual install of the app on the device. If the user does not already have
- * an entitlement for the app, then an attempt is made to create one. If this
- * fails (for example, because the app is not free and there is no available
- * license), then the creation of the install fails. The API can also be used
- * to update an installed app. If the update method is used on an existing
- * install, then the app will be updated to the latest available version. Note
- * that it is not possible to force the installation of a specific version of
- * an app: the version code is read-only. If a user installs an app
- * themselves (as permitted by the enterprise), then again an install resource
- * and possibly an entitlement resource are automatically created. The API
- * can also be used to delete an install resource, which triggers the removal
- * of the app from the device. Note that deleting an install does not
- * automatically remove the corresponding entitlement, even if there are no
- * remaining installs. The install resource will also be deleted if the user
- * uninstalls the app themselves.
+ * The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
*/
export interface Schema$Install {
/**
- * Install state. The state "installPending" means that an install
- * request has recently been made and download to the device is in progress.
- * The state "installed" means that the app has been installed.
- * This field is read-only.
+ * Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
*/
installState?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#install".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
*/
kind?: string;
/**
- * The ID of the product that the install is for. For example,
- * "app:com.google.android.gm".
+ * The ID of the product that the install is for. For example, "app:com.google.android.gm".
*/
productId?: string;
/**
- * The version of the installed product. Guaranteed to be set only if the
- * install state is "installed".
+ * The version of the installed product. Guaranteed to be set only if the install state is "installed".
*/
versionCode?: number;
}
@@ -826,14 +657,11 @@ export namespace androidenterprise_v1 {
*/
failureDetails?: string;
/**
- * The reason for the installation failure. This field will always be
- * present.
+ * The reason for the installation failure. This field will always be present.
*/
failureReason?: string;
/**
- * The id of the product (e.g. "app:com.google.android.gm") for
- * which the install failure event occured. This field will always be
- * present.
+ * The id of the product (e.g. "app:com.google.android.gm") for which the install failure event occured. This field will always be present.
*/
productId?: string;
/**
@@ -846,13 +674,11 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$InstallsListResponse {
/**
- * An installation of an app for a user on a specific device. The existence
- * of an install implies that the user must have an entitlement to the app.
+ * An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app.
*/
install?: Schema$Install[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#installsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse".
*/
kind?: string;
}
@@ -870,35 +696,28 @@ export namespace androidenterprise_v1 {
text?: string;
}
/**
- * Maintenance window for managed Google Play Accounts. This allows Play store
- * to update the apps on the foreground in the designated window.
+ * Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window.
*/
export interface Schema$MaintenanceWindow {
/**
- * Duration of the maintenance window, in milliseconds. The duration must be
- * between 30 minutes and 24 hours (inclusive).
+ * Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).
*/
durationMs?: string;
/**
- * Start time of the maintenance window, in milliseconds after midnight on
- * the device. Windows can span midnight.
+ * Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.
*/
startTimeAfterMidnightMs?: string;
}
/**
- * A managed configuration resource contains the set of managed properties
- * defined by the app developer in the app's managed configurations
- * schema, as well as any configuration variables defined for the user.
+ * A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.
*/
export interface Schema$ManagedConfiguration {
/**
- * Contains the ID of the managed configuration profile and the set of
- * configuration variables (if any) defined for the user.
+ * Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
*/
configurationVariables?: Schema$ConfigurationVariables;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#managedConfiguration".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
*/
kind?: string;
/**
@@ -906,8 +725,7 @@ export namespace androidenterprise_v1 {
*/
managedProperty?: Schema$ManagedProperty[];
/**
- * The ID of the product that the managed configuration is for, e.g.
- * "app:com.google.android.gm".
+ * The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
*/
productId?: string;
}
@@ -916,8 +734,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ManagedConfigurationsForDeviceListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#managedConfigurationsForDeviceListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForDeviceListResponse".
*/
kind?: string;
/**
@@ -930,8 +747,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ManagedConfigurationsForUserListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#managedConfigurationsForUserListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForUserListResponse".
*/
kind?: string;
/**
@@ -940,20 +756,15 @@ export namespace androidenterprise_v1 {
managedConfigurationForUser?: Schema$ManagedConfiguration[];
}
/**
- * A managed configurations settings resource contains the set of managed
- * properties that have been configured for an Android app to be applied to a
- * set of users. The app's developer would have defined configurable
- * properties in the managed configurations schema.
+ * A managed configurations settings resource contains the set of managed properties that have been configured for an Android app to be applied to a set of users. The app's developer would have defined configurable properties in the managed configurations schema.
*/
export interface Schema$ManagedConfigurationsSettings {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#managedConfigurationsSettings".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsSettings".
*/
kind?: string;
/**
- * The last updated time of the managed configuration settings in
- * milliseconds since 1970-01-01T00:00:00Z.
+ * The last updated time of the managed configuration settings in milliseconds since 1970-01-01T00:00:00Z.
*/
lastUpdatedTimestampMillis?: string;
/**
@@ -974,21 +785,16 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ManagedConfigurationsSettingsListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#managedConfigurationsSettingsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsSettingsListResponse".
*/
kind?: string;
/**
- * A managed configurations settings for an app that may be assigned to a
- * group of users in an enterprise.
+ * A managed configurations settings for an app that may be assigned to a group of users in an enterprise.
*/
managedConfigurationsSettings?: Schema$ManagedConfigurationsSettings[];
}
/**
- * A managed property of a managed configuration. The property must match one
- * of the properties in the app restrictions schema of the product. Exactly
- * one of the value fields must be populated, and it must match the
- * property's type in the app restrictions schema.
+ * A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
*/
export interface Schema$ManagedProperty {
/**
@@ -996,33 +802,27 @@ export namespace androidenterprise_v1 {
*/
key?: string;
/**
- * The boolean value - this will only be present if type of the property is
- * bool.
+ * The boolean value - this will only be present if type of the property is bool.
*/
valueBool?: boolean;
/**
- * The bundle of managed properties - this will only be present if type of
- * the property is bundle.
+ * The bundle of managed properties - this will only be present if type of the property is bundle.
*/
valueBundle?: Schema$ManagedPropertyBundle;
/**
- * The list of bundles of properties - this will only be present if type of
- * the property is bundle_array.
+ * The list of bundles of properties - this will only be present if type of the property is bundle_array.
*/
valueBundleArray?: Schema$ManagedPropertyBundle[];
/**
- * The integer value - this will only be present if type of the property is
- * integer.
+ * The integer value - this will only be present if type of the property is integer.
*/
valueInteger?: number;
/**
- * The string value - this will only be present if type of the property is
- * string, choice or hidden.
+ * The string value - this will only be present if type of the property is string, choice or hidden.
*/
valueString?: string;
/**
- * The list of string values - this will only be present if type of the
- * property is multiselect.
+ * The list of string values - this will only be present if type of the property is multiselect.
*/
valueStringArray?: string[];
}
@@ -1048,11 +848,7 @@ export namespace androidenterprise_v1 {
*/
dpcPackageName?: string;
/**
- * Identifies the extent to which the device is controlled by an Android EMM
- * in various deployment configurations. Possible values include: -
- * "managedDevice", a device where the DPC is set as device owner,
- * - "managedProfile", a device where the DPC is set as profile
- * owner.
+ * Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations. Possible values include: - "managedDevice", a device where the DPC is set as device owner, - "managedProfile", a device where the DPC is set as profile owner.
*/
managementType?: string;
/**
@@ -1065,20 +861,15 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$NewPermissionsEvent {
/**
- * The set of permissions that the enterprise admin has already approved for
- * this application. Use Permissions.Get on the EMM API to retrieve details
- * about these permissions.
+ * The set of permissions that the enterprise admin has already approved for this application. Use Permissions.Get on the EMM API to retrieve details about these permissions.
*/
approvedPermissions?: string[];
/**
- * The id of the product (e.g. "app:com.google.android.gm") for
- * which new permissions were added. This field will always be present.
+ * The id of the product (e.g. "app:com.google.android.gm") for which new permissions were added. This field will always be present.
*/
productId?: string;
/**
- * The set of permissions that the app is currently requesting. Use
- * Permissions.Get on the EMM API to retrieve details about these
- * permissions.
+ * The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions.
*/
requestedPermissions?: string[];
}
@@ -1095,8 +886,7 @@ export namespace androidenterprise_v1 {
*/
appUpdateEvent?: Schema$AppUpdateEvent;
/**
- * The ID of the enterprise for which the notification is sent. This will
- * always be present.
+ * The ID of the enterprise for which the notification is sent. This will always be present.
*/
enterpriseId?: string;
/**
@@ -1124,20 +914,16 @@ export namespace androidenterprise_v1 {
*/
productAvailabilityChangeEvent?: Schema$ProductAvailabilityChangeEvent;
/**
- * The time when the notification was published in milliseconds since
- * 1970-01-01T00:00:00Z. This will always be present.
+ * The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present.
*/
timestampMillis?: string;
}
/**
- * A resource returned by the PullNotificationSet API, which contains a
- * collection of notifications for enterprises associated with the service
- * account authenticated for the request.
+ * A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request.
*/
export interface Schema$NotificationSet {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#notificationSet".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#notificationSet".
*/
kind?: string;
/**
@@ -1145,9 +931,7 @@ export namespace androidenterprise_v1 {
*/
notification?: Schema$Notification[];
/**
- * The notification set ID, required to mark the notification as received
- * with the Enterprises.AcknowledgeNotification API. This will be omitted if
- * no notifications are present.
+ * The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present.
*/
notificationSetId?: string;
}
@@ -1157,23 +941,15 @@ export namespace androidenterprise_v1 {
totalResults?: number;
}
/**
- * A Permissions resource represents some extra capability, to be granted to
- * an Android app, which requires explicit consent. An enterprise admin must
- * consent to these permissions on behalf of their users before an entitlement
- * for the app can be created. The permissions collection is read-only. The
- * information provided for each permission (localized name and description)
- * is intended to be used in the MDM user interface when obtaining consent
- * from the enterprise.
+ * A Permissions resource represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created. The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise.
*/
export interface Schema$Permission {
/**
- * A longer description of the Permissions resource, giving more details of
- * what it affects.
+ * A longer description of the Permissions resource, giving more details of what it affects.
*/
description?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#permission".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#permission".
*/
kind?: string;
/**
@@ -1190,28 +966,15 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$Policy {
/**
- * The auto-update policy for apps installed on the device.
- * "choiceToTheUser" allows the device's user to configure the
- * app update policy. "always" enables auto updates.
- * "never" disables auto updates. "wifiOnly" enables
- * auto updates only when the device is connected to wifi.
+ * The auto-update policy for apps installed on the device. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi.
*/
autoUpdatePolicy?: string;
/**
- * The maintenance window defining when apps running in the foreground
- * should be updated.
+ * The maintenance window defining when apps running in the foreground should be updated.
*/
maintenanceWindow?: Schema$MaintenanceWindow;
/**
- * The availability granted to the device for the specified products.
- * "all" gives the device access to all products, regardless of
- * approval status. "all" does not enable automatic visibility of
- * "alpha" or "beta" tracks. "whitelist"
- * grants the device access the products specified in productPolicy[]. Only
- * products that are approved or products that were previously approved
- * (products with revoked approval) by the enterprise can be whitelisted. If
- * no value is provided, the availability set at the user level is applied
- * by default.
+ * The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default.
*/
productAvailabilityPolicy?: string;
/**
@@ -1220,13 +983,7 @@ export namespace androidenterprise_v1 {
productPolicy?: Schema$ProductPolicy[];
}
/**
- * A Products resource represents an app in the Google Play store that is
- * available to at least some users in the enterprise. (Some apps are
- * restricted to a single enterprise, and no information about them is made
- * available outside that enterprise.) The information provided for each
- * product (localized name, icon, link to the full Google Play details page)
- * is intended to allow a basic representation of the product within an EMM
- * user interface.
+ * A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.
*/
export interface Schema$Product {
/**
@@ -1266,28 +1023,19 @@ export namespace androidenterprise_v1 {
*/
detailsUrl?: string;
/**
- * How and to whom the package is made available. The value
- * publicGoogleHosted means that the package is available through the Play
- * store and not restricted to a specific enterprise. The value
- * privateGoogleHosted means that the package is a private app (restricted
- * to an enterprise) but hosted by Google. The value privateSelfHosted means
- * that the package is a private app (restricted to an enterprise) and is
- * privately hosted.
+ * How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.
*/
distributionChannel?: string;
/**
- * A link to an image that can be used as an icon for the product. This
- * image is suitable for use at up to 512px x 512px.
+ * A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.
*/
iconUrl?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#product".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product".
*/
kind?: string;
/**
- * The approximate time (within 7 days) the app was last published,
- * expressed in milliseconds since epoch.
+ * The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch.
*/
lastUpdatedTimestampMillis?: string;
/**
@@ -1299,14 +1047,11 @@ export namespace androidenterprise_v1 {
*/
permissions?: Schema$ProductPermission[];
/**
- * A string of the form app:<package name>. For example,
- * app:com.google.android.gm represents the Gmail app.
+ * A string of the form app:<package name>. For example, app:com.google.android.gm represents the Gmail app.
*/
productId?: string;
/**
- * Whether this product is free, free with in-app purchases, or paid. If the
- * pricing is unknown, this means the product is not generally available
- * anymore (even though it might still be available to people who own it).
+ * Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it).
*/
productPricing?: string;
/**
@@ -1326,8 +1071,7 @@ export namespace androidenterprise_v1 {
*/
signingCertificate?: Schema$ProductSigningCertificate;
/**
- * A link to a smaller image that can be used as an icon for the product.
- * This image is suitable for use at up to 128px x 128px.
+ * A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px.
*/
smallIconUrl?: string;
/**
@@ -1335,8 +1079,7 @@ export namespace androidenterprise_v1 {
*/
title?: string;
/**
- * A link to the managed Google Play details page for the product, for use
- * by an Enterprise admin.
+ * A link to the managed Google Play details page for the product, for use by an Enterprise admin.
*/
workDetailsUrl?: string;
}
@@ -1345,13 +1088,11 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ProductApprovalEvent {
/**
- * Whether the product was approved or unapproved. This field will always be
- * present.
+ * Whether the product was approved or unapproved. This field will always be present.
*/
approved?: string;
/**
- * The id of the product (e.g. "app:com.google.android.gm") for
- * which the approval status has changed. This field will always be present.
+ * The id of the product (e.g. "app:com.google.android.gm") for which the approval status has changed. This field will always be present.
*/
productId?: string;
}
@@ -1364,17 +1105,12 @@ export namespace androidenterprise_v1 {
*/
availabilityStatus?: string;
/**
- * The id of the product (e.g. "app:com.google.android.gm") for
- * which the product availability changed. This field will always be
- * present.
+ * The id of the product (e.g. "app:com.google.android.gm") for which the product availability changed. This field will always be present.
*/
productId?: string;
}
/**
- * A product permissions resource represents the set of permissions required
- * by a specific app and whether or not they have been accepted by an
- * enterprise admin. The API can be used to read the set of permissions, and
- * also to update the set to indicate that permissions have been accepted.
+ * A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
*/
export interface Schema$ProductPermission {
/**
@@ -1387,13 +1123,11 @@ export namespace androidenterprise_v1 {
state?: string;
}
/**
- * Information about the permissions required by a specific app and whether
- * they have been accepted by the enterprise.
+ * Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
*/
export interface Schema$ProductPermissions {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#productPermissions".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
*/
kind?: string;
/**
@@ -1401,8 +1135,7 @@ export namespace androidenterprise_v1 {
*/
permission?: Schema$ProductPermission[];
/**
- * The ID of the app that the permissions relate to, e.g.
- * "app:com.google.android.gm".
+ * The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
*/
productId?: string;
}
@@ -1419,14 +1152,11 @@ export namespace androidenterprise_v1 {
*/
managedConfiguration?: Schema$ManagedConfiguration;
/**
- * The ID of the product. For example,
- * "app:com.google.android.gm".
+ * The ID of the product. For example, "app:com.google.android.gm".
*/
productId?: string;
/**
- * Grants the device visibility to the specified product release track(s),
- * identified by trackIds. The list of release tracks of a product can be
- * obtained by calling Products.Get.
+ * Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get.
*/
trackIds?: string[];
/**
@@ -1436,21 +1166,11 @@ export namespace androidenterprise_v1 {
}
export interface Schema$ProductsApproveRequest {
/**
- * The approval URL that was shown to the user. Only the permissions shown
- * to the user with that URL will be accepted, which may not be the
- * product's entire set of permissions. For example, the URL may only
- * display new permissions from an update after the product was approved, or
- * not include new permissions if the product was updated since the URL was
- * generated.
+ * The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated.
*/
approvalUrlInfo?: Schema$ApprovalUrlInfo;
/**
- * Sets how new permission requests for the product are handled.
- * "allPermissions" automatically approves all current and future
- * permissions for the product. "currentPermissionsOnly" approves
- * the current set of permissions for the product, but any future
- * permissions added through updates will require manual reapproval. If not
- * specified, only the current set of permissions will be approved.
+ * Sets how new permission requests for the product are handled. "allPermissions" automatically approves all current and future permissions for the product. "currentPermissionsOnly" approves the current set of permissions for the product, but any future permissions added through updates will require manual reapproval. If not specified, only the current set of permissions will be approved.
*/
approvedPermissions?: string;
}
@@ -1459,8 +1179,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ProductSet {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#productSet".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
*/
kind?: string;
/**
@@ -1468,50 +1187,23 @@ export namespace androidenterprise_v1 {
*/
productId?: string[];
/**
- * The interpretation of this product set. "unknown" should never
- * be sent and is ignored if received. "whitelist" means that the
- * user is entitled to access the product set. "includeAll" means
- * that all products are accessible, including products that are approved,
- * products with revoked approval, and products that have never been
- * approved. "allApproved" means that the user is entitled to
- * access all products that are approved for the enterprise. If the value is
- * "allApproved" or "includeAll", the productId field is
- * ignored. If no value is provided, it is interpreted as
- * "whitelist" for backwards compatibility. Further
- * "allApproved" or "includeAll" does not enable
- * automatic visibility of "alpha" or "beta" tracks for
- * Android app. Use ProductVisibility to enable "alpha" or
- * "beta" tracks per user.
+ * The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user.
*/
productSetBehavior?: string;
/**
- * Additional list of product IDs making up the product set. Unlike the
- * productID array, in this list It's possible to specify which tracks
- * (alpha, beta, production) of a product are visible to the user. See
- * ProductVisibility and its fields for more information. Specifying the
- * same product ID both here and in the productId array is not allowed and
- * it will result in an error.
+ * Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.
*/
productVisibility?: Schema$ProductVisibility[];
}
export interface Schema$ProductsGenerateApprovalUrlResponse {
/**
- * A URL that can be rendered in an iframe to display the permissions (if
- * any) of a product. This URL can be used to approve the product only once
- * and only within 24 hours of being generated, using the Products.approve
- * call. If the product is currently unapproved and has no permissions, this
- * URL will point to an empty page. If the product is currently approved, a
- * URL will only be generated if that product has added permissions since it
- * was last approved, and the URL will only display those new permissions
- * that have not yet been accepted.
+ * A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.
*/
url?: string;
}
export interface Schema$ProductSigningCertificate {
/**
- * The base64 urlsafe encoded SHA1 hash of the certificate. (This field is
- * deprecated in favor of SHA2-256. It should not be used and may be removed
- * at any time.)
+ * The base64 urlsafe encoded SHA1 hash of the certificate. (This field is deprecated in favor of SHA2-256. It should not be used and may be removed at any time.)
*/
certificateHashSha1?: string;
/**
@@ -1524,8 +1216,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ProductsListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#productsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productsListResponse".
*/
kind?: string;
/**
@@ -1533,8 +1224,7 @@ export namespace androidenterprise_v1 {
*/
pageInfo?: Schema$PageInfo;
/**
- * Information about a product (e.g. an app) in the Google Play store, for
- * display to an enterprise admin.
+ * Information about a product (e.g. an app) in the Google Play store, for display to an enterprise admin.
*/
product?: Schema$Product[];
/**
@@ -1547,13 +1237,11 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ProductVisibility {
/**
- * The product ID to make visible to the user. Required for each item in the
- * productVisibility list.
+ * The product ID to make visible to the user. Required for each item in the productVisibility list.
*/
productId?: string;
/**
- * Grants the user visibility to the specified product track(s), identified
- * by trackIds.
+ * Grants the user visibility to the specified product track(s), identified by trackIds.
*/
trackIds?: string[];
/**
@@ -1562,8 +1250,7 @@ export namespace androidenterprise_v1 {
tracks?: string[];
}
/**
- * A service account identity, including the name and credentials that can be
- * used to authenticate as the service account.
+ * A service account identity, including the name and credentials that can be used to authenticate as the service account.
*/
export interface Schema$ServiceAccount {
/**
@@ -1571,13 +1258,11 @@ export namespace androidenterprise_v1 {
*/
key?: Schema$ServiceAccountKey;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#serviceAccount".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccount".
*/
kind?: string;
/**
- * The account name of the service account, in the form of an email address.
- * Assigned by the server.
+ * The account name of the service account, in the form of an email address. Assigned by the server.
*/
name?: string;
}
@@ -1586,26 +1271,19 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$ServiceAccountKey {
/**
- * The body of the private key credentials file, in string format. This is
- * only populated when the ServiceAccountKey is created, and is not stored
- * by Google.
+ * The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
*/
data?: string;
/**
- * An opaque, unique identifier for this ServiceAccountKey. Assigned by the
- * server.
+ * An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
*/
id?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#serviceAccountKey".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey".
*/
kind?: string;
/**
- * Public key data for the credentials file. This is an X.509 cert. If you
- * are using the googleCredentials key type, this is identical to the cert
- * that can be retrieved by using the X.509 cert url inside of the
- * credentials file.
+ * Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.
*/
publicData?: string;
/**
@@ -1620,84 +1298,61 @@ export namespace androidenterprise_v1 {
serviceAccountKey?: Schema$ServiceAccountKey[];
}
/**
- * A resource returned by the GenerateSignupUrl API, which contains the Signup
- * URL and Completion Token.
+ * A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token.
*/
export interface Schema$SignupInfo {
/**
- * An opaque token that will be required, along with the Enterprise Token,
- * for obtaining the enterprise resource from CompleteSignup.
+ * An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup.
*/
completionToken?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#signupInfo".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#signupInfo".
*/
kind?: string;
/**
- * A URL under which the Admin can sign up for an enterprise. The page
- * pointed to cannot be rendered in an iframe.
+ * A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe.
*/
url?: string;
}
/**
- * Definition of a managed Google Play store cluster, a list of products
- * displayed as part of a store page.
+ * Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
*/
export interface Schema$StoreCluster {
/**
- * Unique ID of this cluster. Assigned by the server. Immutable once
- * assigned.
+ * Unique ID of this cluster. Assigned by the server. Immutable once assigned.
*/
id?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#storeCluster".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
*/
kind?: string;
/**
- * Ordered list of localized strings giving the name of this page. The text
- * displayed is the one that best matches the user locale, or the first
- * entry if there is no good match. There needs to be at least one entry.
+ * Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
*/
name?: Schema$LocalizedText[];
/**
- * String (US-ASCII only) used to determine order of this cluster within the
- * parent page's elements. Page elements are sorted in lexicographic
- * order of this field. Duplicated values are allowed, but ordering between
- * elements with duplicate order is undefined. The value of this field is
- * never visible to a user, it is used solely for the purpose of defining an
- * ordering. Maximum length is 256 characters.
+ * String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
*/
orderInPage?: string;
/**
- * List of products in the order they are displayed in the cluster. There
- * should not be duplicates within a cluster.
+ * List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
*/
productId?: string[];
}
/**
- * General setting for the managed Google Play store layout, currently only
- * specifying the page to display the first time the store is opened.
+ * General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.
*/
export interface Schema$StoreLayout {
/**
- * The ID of the store page to be used as the homepage. The homepage is the
- * first page shown in the managed Google Play Store. Not specifying a
- * homepage is equivalent to setting the store layout type to
- * "basic".
+ * The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type to "basic".
*/
homepageId?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#storeLayout".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
*/
kind?: string;
/**
- * The store layout type. By default, this value is set to "basic"
- * if the homepageId field is not set, and to "custom" otherwise.
- * If set to "basic", the layout will consist of all approved apps
- * that have been whitelisted for the user.
+ * The store layout type. By default, this value is set to "basic" if the homepageId field is not set, and to "custom" otherwise. If set to "basic", the layout will consist of all approved apps that have been whitelisted for the user.
*/
storeLayoutType?: string;
}
@@ -1710,8 +1365,7 @@ export namespace androidenterprise_v1 {
*/
cluster?: Schema$StoreCluster[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#storeLayoutClustersListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse".
*/
kind?: string;
}
@@ -1720,8 +1374,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$StoreLayoutPagesListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#storeLayoutPagesListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutPagesListResponse".
*/
kind?: string;
/**
@@ -1730,9 +1383,7 @@ export namespace androidenterprise_v1 {
page?: Schema$StorePage[];
}
/**
- * Definition of a managed Google Play store page, made of a localized name
- * and links to other pages. A page also contains clusters defined as a
- * subcollection.
+ * Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
*/
export interface Schema$StorePage {
/**
@@ -1740,21 +1391,15 @@ export namespace androidenterprise_v1 {
*/
id?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#storePage".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
*/
kind?: string;
/**
- * Ordered list of pages a user should be able to reach from this page. The
- * list can't include this page. It is recommended that the basic pages
- * are created first, before adding the links between pages. The API
- * doesn't verify that the pages exist or the pages are reachable.
+ * Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages. The API doesn't verify that the pages exist or the pages are reachable.
*/
link?: string[];
/**
- * Ordered list of localized strings giving the name of this page. The text
- * displayed is the one that best matches the user locale, or the first
- * entry if there is no good match. There needs to be at least one entry.
+ * Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
*/
name?: Schema$LocalizedText[];
}
@@ -1767,50 +1412,28 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$TrackInfo {
/**
- * A modifiable name for a track. This is the visible name in the play
- * developer console.
+ * A modifiable name for a track. This is the visible name in the play developer console.
*/
trackAlias?: string;
/**
- * Unmodifiable, unique track identifier. This identifier is the
- * releaseTrackId in the url of the play developer console page that
- * displays the track information.
+ * Unmodifiable, unique track identifier. This identifier is the releaseTrackId in the url of the play developer console page that displays the track information.
*/
trackId?: string;
}
/**
- * A Users resource represents an account associated with an enterprise. The
- * account may be specific to a device or to an individual user (who can then
- * use the account across multiple devices). The account may provide access to
- * managed Google Play only, or to other Google services, depending on the
- * identity model: - The Google managed domain identity model requires
- * synchronization to Google account sources (via primaryEmail). - The
- * managed Google Play Accounts identity model provides a dynamic means for
- * enterprises to create user or device accounts as needed. These accounts
- * provide access to managed Google Play.
+ * A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
*/
export interface Schema$User {
/**
- * A unique identifier you create for this user, such as "user342"
- * or "asset#44418". Do not use personally identifiable
- * information (PII) for this property. Must always be set for EMM-managed
- * users. Not set for Google-managed users.
+ * A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
*/
accountIdentifier?: string;
/**
- * The type of account that this user represents. A userAccount can be
- * installed on multiple devices, but a deviceAccount is specific to a
- * single device. An EMM-managed user (emmManaged) can be either type
- * (userAccount, deviceAccount), but a Google-managed user (googleManaged)
- * is always a userAccount.
+ * The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
*/
accountType?: string;
/**
- * The name that will appear in user interfaces. Setting this property is
- * optional when creating EMM-managed users. If you do set this property,
- * use something generic about the organization (such as "Example,
- * Inc.") or your name (as EMM). Not used for Google-managed user
- * accounts.
+ * The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
*/
displayName?: string;
/**
@@ -1818,20 +1441,15 @@ export namespace androidenterprise_v1 {
*/
id?: string;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#user".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
*/
kind?: string;
/**
- * The entity that manages the user. With googleManaged users, the source of
- * truth is Google so EMMs have to make sure a Google Account exists for the
- * user. With emmManaged users, the EMM is in charge.
+ * The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
*/
managementType?: string;
/**
- * The user's primary email address, for example,
- * "jsmith@example.com". Will always be set for Google managed
- * users and not set for EMM managed users.
+ * The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
*/
primaryEmail?: string;
}
@@ -1840,8 +1458,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$UsersListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#usersListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
*/
kind?: string;
/**
@@ -1850,20 +1467,15 @@ export namespace androidenterprise_v1 {
user?: Schema$User[];
}
/**
- * A UserToken is used by a user when setting up a managed device or profile
- * with their managed Google Play account on a device. When the user enters
- * their email address and token (activation code) the appropriate EMM app can
- * be automatically downloaded.
+ * A UserToken is used by a user when setting up a managed device or profile with their managed Google Play account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded.
*/
export interface Schema$UserToken {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#userToken".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken".
*/
kind?: string;
/**
- * The token (activation code) to be entered by the user. This consists of a
- * sequence of decimal digits. Note that the leading digit may be 0.
+ * The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0.
*/
token?: string;
/**
@@ -1872,15 +1484,11 @@ export namespace androidenterprise_v1 {
userId?: string;
}
/**
- * A variable set is a key-value pair of EMM-provided placeholders and its
- * corresponding value, which is attributed to a user. For example, $FIRSTNAME
- * could be a placeholder, and its value could be Alice. Placeholders should
- * start with a '$' sign and should be alphanumeric only.
+ * A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.
*/
export interface Schema$VariableSet {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#variableSet".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
*/
kind?: string;
/**
@@ -1893,26 +1501,15 @@ export namespace androidenterprise_v1 {
userValue?: string;
}
/**
- * A WebApps resource represents a web app created for an enterprise. Web apps
- * are published to managed Google Play and can be distributed like other
- * Android apps. On a user's device, a web app opens its specified URL.
+ * A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL.
*/
export interface Schema$WebApp {
/**
- * The display mode of the web app. Possible values include: -
- * "minimalUi", the device's status bar, navigation bar, the
- * app's URL, and a refresh button are visible when the app is open. For
- * HTTP URLs, you can only select this option. - "standalone", the
- * device's status bar and navigation bar are visible when the app is
- * open. - "fullScreen", the app opens in full screen mode, hiding
- * the device's status and navigation bars. All browser UI elements,
- * page URL, system status bar and back button are not visible, and the web
- * app takes up the entirety of the available display area.
+ * The display mode of the web app. Possible values include: - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - "standalone", the device's status bar and navigation bar are visible when the app is open. - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area.
*/
displayMode?: string;
/**
- * A list of icons representing this website. If absent, a default icon (for
- * create) or the current icon (for update) will be used.
+ * A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
*/
icons?: Schema$WebAppIcon[];
/**
@@ -1920,25 +1517,19 @@ export namespace androidenterprise_v1 {
*/
isPublished?: boolean;
/**
- * The start URL, i.e. the URL that should load when the user opens the
- * application.
+ * The start URL, i.e. the URL that should load when the user opens the application.
*/
startUrl?: string;
/**
- * The title of the web app as displayed to the user (e.g., amongst a list
- * of other applications, or as a label for an icon).
+ * The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
*/
title?: string;
/**
- * The current version of the app. Note that the version can automatically
- * increase during the lifetime of the web app, while Google does internal
- * housekeeping to keep the web app up-to-date.
+ * The current version of the app. Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
*/
versionCode?: string;
/**
- * The ID of the application. A string of the form "app:<package
- * name>" where the package name always starts with the prefix
- * "com.google.enterprise.webapp." followed by a random id.
+ * The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id.
*/
webAppId?: string;
}
@@ -1947,10 +1538,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$WebAppIcon {
/**
- * The actual bytes of the image in a base64url encoded string (c.f.
- * RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe
- * Alphabet"). - The image type can be png or jpg. - The image should
- * ideally be square. - The image should ideally have a size of 512x512.
+ * The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512.
*/
imageData?: string;
}
@@ -1959,8 +1547,7 @@ export namespace androidenterprise_v1 {
*/
export interface Schema$WebAppsListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidenterprise#webAppsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#webAppsListResponse".
*/
kind?: string;
/**
@@ -2050,11 +1637,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.devices.getState
- * @desc Retrieves whether a device's access to Google services is enabled
- * or disabled. The device state takes effect only if enforcing EMM policies
- * on Android devices is enabled in the Google Admin Console. Otherwise, the
- * device state is ignored and all devices are allowed access to Google
- * services. This is only supported for Google-managed users.
+ * @desc Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
* @alias androidenterprise.devices.getState
* @memberOf! ()
*
@@ -2278,11 +1861,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.devices.setState
- * @desc Sets whether a device's access to Google services is enabled or
- * disabled. The device state takes effect only if enforcing EMM policies on
- * Android devices is enabled in the Google Admin Console. Otherwise, the
- * device state is ignored and all devices are allowed access to Google
- * services. This is only supported for Google-managed users.
+ * @desc Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
* @alias androidenterprise.devices.setState
* @memberOf! ()
*
@@ -2500,9 +2079,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * Mask that identifies which fields to update. If not set, all modifiable
- * fields will be modified. When set in a query parameter, this field
- * should be specified as updateMask=,,...
+ * Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,...
*/
updateMask?: string;
/**
@@ -2554,9 +2131,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * Mask that identifies which fields to update. If not set, all modifiable
- * fields will be modified. When set in a query parameter, this field
- * should be specified as updateMask=,,...
+ * Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,...
*/
updateMask?: string;
/**
@@ -2578,9 +2153,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.acknowledgeNotificationSet
- * @desc Acknowledges notifications that were received from
- * Enterprises.PullNotificationSet to prevent subsequent calls from
- * returning the same notifications.
+ * @desc Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
* @alias androidenterprise.enterprises.acknowledgeNotificationSet
* @memberOf! ()
*
@@ -2652,9 +2225,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.completeSignup
- * @desc Completes the signup flow, by specifying the Completion token and
- * Enterprise token. This request must not be called multiple times for a
- * given Enterprise Token.
+ * @desc Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.
* @alias androidenterprise.enterprises.completeSignup
* @memberOf! ()
*
@@ -2728,10 +2299,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.createWebToken
- * @desc Returns a unique token to access an embeddable UI. To generate a
- * web UI, pass the generated token into the managed Google Play javascript
- * API. Each token may only be used to start one UI session. See the
- * javascript API documentation for further information.
+ * @desc Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.
* @alias androidenterprise.enterprises.createWebToken
* @memberOf! ()
*
@@ -3030,17 +2598,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.getServiceAccount
- * @desc Returns a service account and credentials. The service account can
- * be bound to the enterprise by calling setAccount. The service account is
- * unique to this enterprise and EMM, and will be deleted if the enterprise
- * is unbound. The credentials contain private key data and are not stored
- * server-side. This method can only be called after calling
- * Enterprises.Enroll or Enterprises.CompleteSignup, and before
- * Enterprises.SetAccount; at other times it will return an error.
- * Subsequent calls after the first will generate a new, unique set of
- * credentials, and invalidate the previously generated credentials. Once
- * the service account is bound to the enterprise, it can be managed using
- * the serviceAccountKeys resource.
+ * @desc Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.
* @alias androidenterprise.enterprises.getServiceAccount
* @memberOf! ()
*
@@ -3117,9 +2675,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.getStoreLayout
- * @desc Returns the store layout for the enterprise. If the store layout
- * has not been set, returns "basic" as the store layout type and no
- * homepage.
+ * @desc Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.
* @alias androidenterprise.enterprises.getStoreLayout
* @memberOf! ()
*
@@ -3193,11 +2749,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.list
- * @desc Looks up an enterprise by domain name. This is only supported for
- * enterprises created via the Google-initiated creation flow. Lookup of the
- * id is not needed for enterprises created via the EMM-initiated flow since
- * the EMM learns the enterprise ID in the callback specified in the
- * Enterprises.generateSignupUrl call.
+ * @desc Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.
* @alias androidenterprise.enterprises.list
* @memberOf! ()
*
@@ -3272,20 +2824,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.pullNotificationSet
- * @desc Pulls and returns a notification set for the enterprises associated
- * with the service account authenticated for the request. The notification
- * set may be empty if no notification are pending. A notification set
- * returned needs to be acknowledged within 20 seconds by calling
- * Enterprises.AcknowledgeNotificationSet, unless the notification set is
- * empty. Notifications that are not acknowledged within the 20 seconds will
- * eventually be included again in the response to another
- * PullNotificationSet request, and those that are never acknowledged will
- * ultimately be deleted according to the Google Cloud Platform Pub/Sub
- * system policy. Multiple requests might be performed concurrently to
- * retrieve notifications, in which case the pending notifications (if any)
- * will be split among each caller, if any are pending. If no notifications
- * are present, an empty notification list is returned. Subsequent requests
- * may return more notifications once they become available.
+ * @desc Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.
* @alias androidenterprise.enterprises.pullNotificationSet
* @memberOf! ()
*
@@ -3360,8 +2899,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.sendTestPushNotification
- * @desc Sends a test notification to validate the EMM integration with the
- * Google Cloud Pub/Sub service for this enterprise.
+ * @desc Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
* @alias androidenterprise.enterprises.sendTestPushNotification
* @memberOf! ()
*
@@ -3460,8 +2998,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.setAccount
- * @desc Sets the account that will be used to authenticate to the API as
- * the enterprise.
+ * @desc Sets the account that will be used to authenticate to the API as the enterprise.
* @alias androidenterprise.enterprises.setAccount
* @memberOf! ()
*
@@ -3536,14 +3073,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.enterprises.setStoreLayout
- * @desc Sets the store layout for the enterprise. By default,
- * storeLayoutType is set to "basic" and the basic store layout is enabled.
- * The basic layout only contains apps approved by the admin, and that have
- * been added to the available product set for a user (using the
- * setAvailableProductSet call). Apps on the page are sorted in order of
- * their product ID value. If you create a custom store layout (by setting
- * storeLayoutType = "custom" and setting a homepage), the basic store
- * layout is disabled.
+ * @desc Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled.
* @alias androidenterprise.enterprises.setStoreLayout
* @memberOf! ()
*
@@ -3697,8 +3227,7 @@ export namespace androidenterprise_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The notification set ID as returned by Enterprises.PullNotificationSet.
- * This must be provided.
+ * The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.
*/
notificationSetId?: string;
}
@@ -3760,13 +3289,7 @@ export namespace androidenterprise_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The callback URL to which the Admin will be redirected after successfully
- * creating an enterprise. Before redirecting there the system will add a
- * single query parameter to this URL named "enterpriseToken" which will
- * contain an opaque token to be used for the CompleteSignup request. Beware
- * that this means that the URL will be parsed, the parameter added and then
- * a new URL formatted, i.e. there may be some minor formatting changes and,
- * more importantly, the URL must be well-formed so that it can be parsed.
+ * The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.
*/
callbackUrl?: string;
}
@@ -3828,13 +3351,7 @@ export namespace androidenterprise_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The request mode for pulling notifications. Specifying
- * waitForNotifications will cause the request to block and wait until one
- * or more notifications are present, or return an empty notification list
- * if no notifications are present after some time. Speciying
- * returnImmediately will cause the request to immediately return the
- * pending notifications, or an empty list if no notifications are present.
- * If omitted, defaults to waitForNotifications.
+ * The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
*/
requestMode?: string;
}
@@ -4131,8 +3648,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.entitlements.patch
- * @desc Adds or updates an entitlement to an app for a user. This method
- * supports patch semantics.
+ * @desc Adds or updates an entitlement to an app for a user. This method supports patch semantics.
* @alias androidenterprise.entitlements.patch
* @memberOf! ()
*
@@ -4299,8 +3815,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the entitlement (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
*/
entitlementId?: string;
/**
@@ -4319,8 +3834,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the entitlement (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
*/
entitlementId?: string;
/**
@@ -4356,15 +3870,11 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the entitlement (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
*/
entitlementId?: string;
/**
- * Set to true to also install the product on all the user's devices where
- * possible. Failure to install on one or more devices will not prevent this
- * operation from returning successfully, as long as the entitlement was
- * successfully assigned to the user.
+ * Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
*/
install?: boolean;
/**
@@ -4389,15 +3899,11 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the entitlement (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
*/
entitlementId?: string;
/**
- * Set to true to also install the product on all the user's devices where
- * possible. Failure to install on one or more devices will not prevent this
- * operation from returning successfully, as long as the entitlement was
- * successfully assigned to the user.
+ * Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
*/
install?: boolean;
/**
@@ -4494,8 +4000,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.grouplicenses.list
- * @desc Retrieves IDs of all products for which the enterprise has a group
- * license.
+ * @desc Retrieves IDs of all products for which the enterprise has a group license.
* @alias androidenterprise.grouplicenses.list
* @memberOf! ()
*
@@ -4587,8 +4092,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the product the group license is for, e.g.
- * "app:com.google.android.gm".
+ * The ID of the product the group license is for, e.g. "app:com.google.android.gm".
*/
groupLicenseId?: string;
}
@@ -4613,8 +4117,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.grouplicenseusers.list
- * @desc Retrieves the IDs of the users who have been granted entitlements
- * under the license.
+ * @desc Retrieves the IDs of the users who have been granted entitlements under the license.
* @alias androidenterprise.grouplicenseusers.list
* @memberOf! ()
*
@@ -4709,8 +4212,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the product the group license is for, e.g.
- * "app:com.google.android.gm".
+ * The ID of the product the group license is for, e.g. "app:com.google.android.gm".
*/
groupLicenseId?: string;
}
@@ -4723,9 +4225,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.installs.delete
- * @desc Requests to remove an app from a device. A call to get or list will
- * still show the app as installed on the device until it is actually
- * removed.
+ * @desc Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.
* @alias androidenterprise.installs.delete
* @memberOf! ()
*
@@ -4873,8 +4373,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.installs.list
- * @desc Retrieves the details of all apps installed on the specified
- * device.
+ * @desc Retrieves the details of all apps installed on the specified device.
* @alias androidenterprise.installs.list
* @memberOf! ()
*
@@ -4951,9 +4450,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.installs.patch
- * @desc Requests to install the latest version of an app to a device. If
- * the app is already installed, then it is updated to the latest version if
- * necessary. This method supports patch semantics.
+ * @desc Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. This method supports patch semantics.
* @alias androidenterprise.installs.patch
* @memberOf! ()
*
@@ -5028,9 +4525,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.installs.update
- * @desc Requests to install the latest version of an app to a device. If
- * the app is already installed, then it is updated to the latest version if
- * necessary.
+ * @desc Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.
* @alias androidenterprise.installs.update
* @memberOf! ()
*
@@ -5119,8 +4614,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the product represented by the install, e.g.
- * "app:com.google.android.gm".
+ * The ID of the product represented by the install, e.g. "app:com.google.android.gm".
*/
installId?: string;
/**
@@ -5143,8 +4637,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the product represented by the install, e.g.
- * "app:com.google.android.gm".
+ * The ID of the product represented by the install, e.g. "app:com.google.android.gm".
*/
installId?: string;
/**
@@ -5186,8 +4679,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the product represented by the install, e.g.
- * "app:com.google.android.gm".
+ * The ID of the product represented by the install, e.g. "app:com.google.android.gm".
*/
installId?: string;
/**
@@ -5215,8 +4707,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the product represented by the install, e.g.
- * "app:com.google.android.gm".
+ * The ID of the product represented by the install, e.g. "app:com.google.android.gm".
*/
installId?: string;
/**
@@ -5238,8 +4729,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsfordevice.delete
- * @desc Removes a per-device managed configuration for an app for the
- * specified device.
+ * @desc Removes a per-device managed configuration for an app for the specified device.
* @alias androidenterprise.managedconfigurationsfordevice.delete
* @memberOf! ()
*
@@ -5413,8 +4903,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsfordevice.list
- * @desc Lists all the per-device managed configurations for the specified
- * device. Only the ID is set.
+ * @desc Lists all the per-device managed configurations for the specified device. Only the ID is set.
* @alias androidenterprise.managedconfigurationsfordevice.list
* @memberOf! ()
*
@@ -5513,8 +5002,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsfordevice.patch
- * @desc Adds or updates a per-device managed configuration for an app for
- * the specified device. This method supports patch semantics.
+ * @desc Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.
* @alias androidenterprise.managedconfigurationsfordevice.patch
* @memberOf! ()
*
@@ -5604,8 +5092,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsfordevice.update
- * @desc Adds or updates a per-device managed configuration for an app for
- * the specified device.
+ * @desc Adds or updates a per-device managed configuration for an app for the specified device.
* @alias androidenterprise.managedconfigurationsfordevice.update
* @memberOf! ()
*
@@ -5710,8 +5197,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the managed configuration (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
*/
managedConfigurationForDeviceId?: string;
/**
@@ -5735,8 +5221,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the managed configuration (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
*/
managedConfigurationForDeviceId?: string;
/**
@@ -5780,8 +5265,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the managed configuration (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
*/
managedConfigurationForDeviceId?: string;
/**
@@ -5810,8 +5294,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the managed configuration (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
*/
managedConfigurationForDeviceId?: string;
/**
@@ -5833,8 +5316,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsforuser.delete
- * @desc Removes a per-user managed configuration for an app for the
- * specified user.
+ * @desc Removes a per-user managed configuration for an app for the specified user.
* @alias androidenterprise.managedconfigurationsforuser.delete
* @memberOf! ()
*
@@ -5912,8 +5394,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsforuser.get
- * @desc Retrieves details of a per-user managed configuration for an app
- * for the specified user.
+ * @desc Retrieves details of a per-user managed configuration for an app for the specified user.
* @alias androidenterprise.managedconfigurationsforuser.get
* @memberOf! ()
*
@@ -5995,8 +5476,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsforuser.list
- * @desc Lists all the per-user managed configurations for the specified
- * user. Only the ID is set.
+ * @desc Lists all the per-user managed configurations for the specified user. Only the ID is set.
* @alias androidenterprise.managedconfigurationsforuser.list
* @memberOf! ()
*
@@ -6088,12 +5568,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsforuser.patch
- * @desc Adds or updates the managed configuration settings for an app for
- * the specified user. If you support the Managed configurations iframe, you
- * can apply managed configurations to a user by specifying an mcmId and its
- * associated configuration variables (if any) in the request.
- * Alternatively, all EMMs can apply managed configurations by passing a
- * list of managed properties. This method supports patch semantics.
+ * @desc Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. This method supports patch semantics.
* @alias androidenterprise.managedconfigurationsforuser.patch
* @memberOf! ()
*
@@ -6176,12 +5651,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationsforuser.update
- * @desc Adds or updates the managed configuration settings for an app for
- * the specified user. If you support the Managed configurations iframe, you
- * can apply managed configurations to a user by specifying an mcmId and its
- * associated configuration variables (if any) in the request.
- * Alternatively, all EMMs can apply managed configurations by passing a
- * list of managed properties.
+ * @desc Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.
* @alias androidenterprise.managedconfigurationsforuser.update
* @memberOf! ()
*
@@ -6275,8 +5745,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the managed configuration (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
*/
managedConfigurationForUserId?: string;
/**
@@ -6296,8 +5765,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the managed configuration (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
*/
managedConfigurationForUserId?: string;
/**
@@ -6333,8 +5801,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the managed configuration (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
*/
managedConfigurationForUserId?: string;
/**
@@ -6359,8 +5826,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the managed configuration (a product ID), e.g.
- * "app:com.google.android.gm".
+ * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm".
*/
managedConfigurationForUserId?: string;
/**
@@ -6382,8 +5848,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.managedconfigurationssettings.list
- * @desc Lists all the managed configurations settings for the specified
- * app. Only the ID and the name is set.
+ * @desc Lists all the managed configurations settings for the specified app. Only the ID and the name is set.
* @alias androidenterprise.managedconfigurationssettings.list
* @memberOf! ()
*
@@ -6492,8 +5957,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The ID of the product for which the managed configurations settings
- * applies to.
+ * The ID of the product for which the managed configurations settings applies to.
*/
productId?: string;
}
@@ -6506,8 +5970,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.permissions.get
- * @desc Retrieves details of an Android app permission for display to an
- * enterprise admin.
+ * @desc Retrieves details of an Android app permission for display to an enterprise admin.
* @alias androidenterprise.permissions.get
* @memberOf! ()
*
@@ -6603,11 +6066,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.products.approve
- * @desc Approves the specified product and the relevant app permissions, if
- * any. The maximum number of products that you can approve per enterprise
- * customer is 1,000. To learn how to use managed Google Play to design and
- * create a store layout to display approved products to your users, see
- * Store Layout Design.
+ * @desc Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design.
* @alias androidenterprise.products.approve
* @memberOf! ()
*
@@ -6680,14 +6139,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.products.generateApprovalUrl
- * @desc Generates a URL that can be rendered in an iframe to display the
- * permissions (if any) of a product. An enterprise admin must view these
- * permissions and accept them on behalf of their organization in order to
- * approve that product. Admins should accept the displayed permissions by
- * interacting with a separate UI element in the EMM console, which in turn
- * should trigger the use of this URL as the approvalUrlInfo.approvalUrl
- * property in a Products.approve call to approve the product. This URL can
- * only be used to display permissions for up to 1 day.
+ * @desc Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.
* @alias androidenterprise.products.generateApprovalUrl
* @memberOf! ()
*
@@ -6847,12 +6299,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.products.getAppRestrictionsSchema
- * @desc Retrieves the schema that defines the configurable properties for
- * this product. All products have a schema, but this schema may be empty if
- * no managed configurations have been defined. This schema can be used to
- * populate a UI that allows an admin to configure the product. To apply a
- * managed configuration based on the schema obtained using this API, see
- * Managed Configurations through Play.
+ * @desc Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.
* @alias androidenterprise.products.getAppRestrictionsSchema
* @memberOf! ()
*
@@ -7009,8 +6456,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.products.list
- * @desc Finds approved products that match a query, or all approved
- * products if there is no query.
+ * @desc Finds approved products that match a query, or all approved products if there is no query.
* @alias androidenterprise.products.list
* @memberOf! ()
*
@@ -7090,8 +6536,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.products.unapprove
- * @desc Unapproves the specified product (and the relevant app permissions,
- * if any)
+ * @desc Unapproves the specified product (and the relevant app permissions, if any)
* @alias androidenterprise.products.unapprove
* @memberOf! ()
*
@@ -7195,8 +6640,7 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The BCP 47 language code used for permission names and descriptions in
- * the returned iframe, for instance "en-US".
+ * The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US".
*/
languageCode?: string;
/**
@@ -7266,9 +6710,7 @@ export namespace androidenterprise_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Specifies whether to search among all products (false) or among only
- * products that have been approved (true). Only "true" is supported, and
- * should be specified.
+ * Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified.
*/
approved?: boolean;
/**
@@ -7276,29 +6718,19 @@ export namespace androidenterprise_v1 {
*/
enterpriseId?: string;
/**
- * The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
- * Results are returned in the language best matching the preferred
- * language.
+ * The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language.
*/
language?: string;
/**
- * Specifies the maximum number of products that can be returned per
- * request. If not specified, uses a default value of 100, which is also the
- * maximum retrievable within a single response.
+ * Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response.
*/
maxResults?: number;
/**
- * The search query as typed in the Google Play store search box. If
- * omitted, all approved apps will be returned (using the pagination
- * parameters), including apps that are not available in the store (e.g.
- * unpublished apps).
+ * The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps).
*/
query?: string;
/**
- * A pagination token is contained in a request's response when there are
- * more products. The token can be used in a subsequent request to obtain
- * more products, and so forth. This parameter cannot be used in the initial
- * request.
+ * A pagination token is contained in a request's response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request.
*/
token?: string;
}
@@ -7327,11 +6759,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.serviceaccountkeys.delete
- * @desc Removes and invalidates the specified credentials for the service
- * account associated with this enterprise. The calling service account must
- * have been retrieved by calling Enterprises.GetServiceAccount and must
- * have been set as the enterprise service account by calling
- * Enterprises.SetAccount.
+ * @desc Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
* @alias androidenterprise.serviceaccountkeys.delete
* @memberOf! ()
*
@@ -7404,11 +6832,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.serviceaccountkeys.insert
- * @desc Generates new credentials for the service account associated with
- * this enterprise. The calling service account must have been retrieved by
- * calling Enterprises.GetServiceAccount and must have been set as the
- * enterprise service account by calling Enterprises.SetAccount. Only the
- * type of the key should be populated in the resource to be inserted.
+ * @desc Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. Only the type of the key should be populated in the resource to be inserted.
* @alias androidenterprise.serviceaccountkeys.insert
* @memberOf! ()
*
@@ -7483,11 +6907,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.serviceaccountkeys.list
- * @desc Lists all active credentials for the service account associated
- * with this enterprise. Only the ID and key type are returned. The calling
- * service account must have been retrieved by calling
- * Enterprises.GetServiceAccount and must have been set as the enterprise
- * service account by calling Enterprises.SetAccount.
+ * @desc Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
* @alias androidenterprise.serviceaccountkeys.list
* @memberOf! ()
*
@@ -8528,8 +7948,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.storelayoutpages.patch
- * @desc Updates the content of a store page. This method supports patch
- * semantics.
+ * @desc Updates the content of a store page. This method supports patch semantics.
* @alias androidenterprise.storelayoutpages.patch
* @memberOf! ()
*
@@ -8864,11 +8283,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.generateAuthenticationToken
- * @desc Generates an authentication token which the device policy client
- * can use to provision the given EMM-managed user account on a device. The
- * generated token is single-use and expires after a few minutes. You can
- * provision a maximum of 10 devices per user. This call only works with
- * EMM-managed accounts.
+ * @desc Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.
* @alias androidenterprise.users.generateAuthenticationToken
* @memberOf! ()
*
@@ -8945,9 +8360,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.generateToken
- * @desc Generates a token (activation code) to allow this user to configure
- * their managed account in the Android Setup Wizard. Revokes any previously
- * generated token. This call only works with Google managed accounts.
+ * @desc Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token. This call only works with Google managed accounts.
* @alias androidenterprise.users.generateToken
* @memberOf! ()
*
@@ -9171,11 +8584,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.insert
- * @desc Creates a new EMM-managed user. The Users resource passed in the
- * body of the request should include an accountIdentifier and an
- * accountType. If a corresponding user already exists with the same account
- * identifier, the user will be updated with the resource. In this case only
- * the displayName field can be changed.
+ * @desc Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.
* @alias androidenterprise.users.insert
* @memberOf! ()
*
@@ -9246,10 +8655,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.list
- * @desc Looks up a user by primary email address. This is only supported
- * for Google-managed users. Lookup of the id is not needed for EMM-managed
- * users because the id is already returned in the result of the
- * Users.insert call.
+ * @desc Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.
* @alias androidenterprise.users.list
* @memberOf! ()
*
@@ -9322,11 +8728,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.patch
- * @desc Updates the details of an EMM-managed user. Can be used with
- * EMM-managed users only (not Google managed users). Pass the new details
- * in the Users resource in the request body. Only the displayName field can
- * be changed. Other fields must either be unset or have the currently
- * active value. This method supports patch semantics.
+ * @desc Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics.
* @alias androidenterprise.users.patch
* @memberOf! ()
*
@@ -9399,9 +8801,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.revokeDeviceAccess
- * @desc Revokes access to all devices currently provisioned to the user.
- * The user will no longer be able to use the managed Play store on any of
- * their managed devices. This call only works with EMM-managed accounts.
+ * @desc Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.
* @alias androidenterprise.users.revokeDeviceAccess
* @memberOf! ()
*
@@ -9474,8 +8874,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.revokeToken
- * @desc Revokes a previously generated token (activation code) for the
- * user.
+ * @desc Revokes a previously generated token (activation code) for the user.
* @alias androidenterprise.users.revokeToken
* @memberOf! ()
*
@@ -9548,10 +8947,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.setAvailableProductSet
- * @desc Modifies the set of products that a user is entitled to access
- * (referred to as whitelisted products). Only products that are approved or
- * products that were previously approved (products with revoked approval)
- * can be whitelisted.
+ * @desc Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.
* @alias androidenterprise.users.setAvailableProductSet
* @memberOf! ()
*
@@ -9629,11 +9025,7 @@ export namespace androidenterprise_v1 {
/**
* androidenterprise.users.update
- * @desc Updates the details of an EMM-managed user. Can be used with
- * EMM-managed users only (not Google managed users). Pass the new details
- * in the Users resource in the request body. Only the displayName field can
- * be changed. Other fields must either be unset or have the currently
- * active value.
+ * @desc Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.
* @alias androidenterprise.users.update
* @memberOf! ()
*
diff --git a/src/apis/androidmanagement/package.json b/src/apis/androidmanagement/package.json
index 8011059d951..f3446642e08 100644
--- a/src/apis/androidmanagement/package.json
+++ b/src/apis/androidmanagement/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts
index 4ea89049f48..b26f7b0eb0d 100644
--- a/src/apis/androidmanagement/v1.ts
+++ b/src/apis/androidmanagement/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace androidmanagement_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace androidmanagement_v1 {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace androidmanagement_v1 {
/**
* Android Management API
*
- * The Android Management API provides remote enterprise management of Android
- * devices and apps.
+ * The Android Management API provides remote enterprise management of Android devices and apps.
*
* @example
* const {google} = require('googleapis');
@@ -114,7 +109,10 @@ export namespace androidmanagement_v1 {
signupUrls: Resource$Signupurls;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.enterprises = new Resource$Enterprises(this.context);
this.signupUrls = new Resource$Signupurls(this.context);
@@ -135,15 +133,11 @@ export namespace androidmanagement_v1 {
packageName?: string;
}
/**
- * A compliance rule condition which is satisfied if the Android Framework API
- * level on the device doesn't meet a minimum requirement. There can only
- * be one rule with this type of condition per policy.
+ * A compliance rule condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement. There can only be one rule with this type of condition per policy.
*/
export interface Schema$ApiLevelCondition {
/**
- * The minimum desired Android Framework API level. If the device
- * doesn't meet the minimum requirement, this condition is satisfied.
- * Must be greater than zero.
+ * The minimum desired Android Framework API level. If the device doesn't meet the minimum requirement, this condition is satisfied. Must be greater than zero.
*/
minApiLevel?: number;
}
@@ -156,8 +150,7 @@ export namespace androidmanagement_v1 {
*/
managedProperties?: Schema$ManagedProperty[];
/**
- * The name of the app in the form
- * enterprises/{enterpriseId}/applications/{package_name}.
+ * The name of the app in the form enterprises/{enterpriseId}/applications/{package_name}.
*/
name?: string;
/**
@@ -187,8 +180,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$ApplicationPermission {
/**
- * A longer description of the permission, providing more detail on what it
- * affects. Localized.
+ * A longer description of the permission, providing more detail on what it affects. Localized.
*/
description?: string;
/**
@@ -205,10 +197,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$ApplicationPolicy {
/**
- * The default policy for all permissions requested by the app. If
- * specified, this overrides the policy-level default_permission_policy
- * which applies to all apps. It does not override the permission_grants
- * which applies to all apps.
+ * The default policy for all permissions requested by the app. If specified, this overrides the policy-level default_permission_policy which applies to all apps. It does not override the permission_grants which applies to all apps.
*/
defaultPermissionPolicy?: string;
/**
@@ -216,8 +205,7 @@ export namespace androidmanagement_v1 {
*/
delegatedScopes?: string[];
/**
- * Whether the app is disabled. When disabled, the app data is still
- * preserved.
+ * Whether the app is disabled. When disabled, the app data is still preserved.
*/
disabled?: boolean;
/**
@@ -229,50 +217,23 @@ export namespace androidmanagement_v1 {
*/
lockTaskAllowed?: boolean;
/**
- * Managed configuration applied to the app. The format for the
- * configuration is dictated by the ManagedProperty values supported by the
- * app. Each field name in the managed configuration must match the key
- * field of the ManagedProperty. The field value must be compatible with the
- * type of the ManagedProperty: <table>
- * <tr><td><i>type</i></td><td><i>JSON
- * value</i></td></tr>
- * <tr><td>BOOL</td><td>true or
- * false</td></tr>
- * <tr><td>STRING</td><td>string</td></tr>
- * <tr><td>INTEGER</td><td>number</td></tr>
- * <tr><td>CHOICE</td><td>string</td></tr>
- * <tr><td>MULTISELECT</td><td>array of
- * strings</td></tr>
- * <tr><td>HIDDEN</td><td>string</td></tr>
- * <tr><td>BUNDLE_ARRAY</td><td>array of
- * objects</td></tr> </table>
+ * Managed configuration applied to the app. The format for the configuration is dictated by the ManagedProperty values supported by the app. Each field name in the managed configuration must match the key field of the ManagedProperty. The field value must be compatible with the type of the ManagedProperty: <table> <tr><td><i>type</i></td><td><i>JSON value</i></td></tr> <tr><td>BOOL</td><td>true or false</td></tr> <tr><td>STRING</td><td>string</td></tr> <tr><td>INTEGER</td><td>number</td></tr> <tr><td>CHOICE</td><td>string</td></tr> <tr><td>MULTISELECT</td><td>array of strings</td></tr> <tr><td>HIDDEN</td><td>string</td></tr> <tr><td>BUNDLE_ARRAY</td><td>array of objects</td></tr> </table>
*/
managedConfiguration?: {[key: string]: any};
/**
- * The managed configurations template for the app, saved from the managed
- * configurations iframe. This field is ignored if managed_configuration is
- * set.
+ * The managed configurations template for the app, saved from the managed configurations iframe. This field is ignored if managed_configuration is set.
*/
managedConfigurationTemplate?: Schema$ManagedConfigurationTemplate;
/**
- * The minimum version of the app that runs on the device. If set, the
- * device attempts to update the app to at least this version code. If the
- * app is not up-to-date, the device will contain a NonComplianceDetail with
- * non_compliance_reason set to APP_NOT_UPDATED. The app must already be
- * published to Google Play with a version code greater than or equal to
- * this value. At most 20 apps may specify a minimum version code per
- * policy.
+ * The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy.
*/
minimumVersionCode?: number;
/**
- * The package name of the app. For example, com.google.android.youtube for
- * the YouTube app.
+ * The package name of the app. For example, com.google.android.youtube for the YouTube app.
*/
packageName?: string;
/**
- * Explicit permission grants or denials for the app. These values override
- * the default_permission_policy and permission_grants which apply to all
- * apps.
+ * Explicit permission grants or denials for the app. These values override the default_permission_policy and permission_grants which apply to all apps.
*/
permissionGrants?: Schema$PermissionGrant[];
}
@@ -305,16 +266,11 @@ export namespace androidmanagement_v1 {
*/
packageName?: string;
/**
- * The SHA-256 hash of the app's APK file, which can be used to verify
- * the app hasn't been modified. Each byte of the hash value is
- * represented as a two-digit hexadecimal number.
+ * The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number.
*/
packageSha256Hash?: string;
/**
- * The SHA-1 hash of each android.content.pm.Signature
- * (https://developer.android.com/reference/android/content/pm/Signature.html)
- * associated with the app package. Each byte of each hash value is
- * represented as a two-digit hexadecimal number.
+ * The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.
*/
signingKeyCertFingerprints?: string[];
/**
@@ -322,8 +278,7 @@ export namespace androidmanagement_v1 {
*/
state?: string;
/**
- * The app version code, which can be used to determine whether one version
- * is more recent than another.
+ * The app version code, which can be used to determine whether one version is more recent than another.
*/
versionCode?: number;
/**
@@ -341,17 +296,20 @@ export namespace androidmanagement_v1 {
includeRemovedApps?: boolean;
}
/**
- * A rule for automatically choosing a private key and certificate to
- * authenticate the device to a server.
+ * An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a device or work profile to displays a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified.
+ */
+ export interface Schema$BlockAction {
+ /**
+ * Number of days the policy is non-compliant before the device or work profile is blocked. To block access immediately, set to 0. blockAfterDays must be less than wipeAfterDays.
+ */
+ blockAfterDays?: number;
+ }
+ /**
+ * A rule for automatically choosing a private key and certificate to authenticate the device to a server.
*/
export interface Schema$ChoosePrivateKeyRule {
/**
- * The package names for which outgoing requests are subject to this rule.
- * If no package names are specified, then the rule applies to all packages.
- * For each package name listed, the rule applies to that package and all
- * other packages that shared the same Android UID. The SHA256 hash of the
- * signing key signatures of each package_name will be verified against
- * those provided by Play
+ * The package names for which outgoing requests are subject to this rule. If no package names are specified, then the rule applies to all packages. For each package name listed, the rule applies to that package and all other packages that shared the same Android UID. The SHA256 hash of the signing key signatures of each package_name will be verified against those provided by Play
*/
packageNames?: string[];
/**
@@ -359,9 +317,7 @@ export namespace androidmanagement_v1 {
*/
privateKeyAlias?: string;
/**
- * The URL pattern to match against the URL of the outgoing request. The
- * pattern may contain asterisk (*) wildcards. Any URL is matched if
- * unspecified.
+ * The URL pattern to match against the URL of the outgoing request. The pattern may contain asterisk (*) wildcards. Any URL is matched if unspecified.
*/
urlPattern?: string;
}
@@ -370,24 +326,19 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$Command {
/**
- * The timestamp at which the command was created. The timestamp is
- * automatically generated by the server.
+ * The timestamp at which the command was created. The timestamp is automatically generated by the server.
*/
createTime?: string;
/**
- * The duration for which the command is valid. The command will expire if
- * not executed by the device during this time. The default duration if
- * unspecified is ten minutes. There is no maximum duration.
+ * The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration.
*/
duration?: string;
/**
- * If the command failed, an error code explaining the failure. This is not
- * set when the command is cancelled by the caller.
+ * If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller.
*/
errorCode?: string;
/**
- * For commands of type RESET_PASSWORD, optionally specifies the new
- * password.
+ * For commands of type RESET_PASSWORD, optionally specifies the new password.
*/
newPassword?: string;
/**
@@ -399,47 +350,33 @@ export namespace androidmanagement_v1 {
*/
type?: string;
/**
- * The resource name of the user that owns the device in the form
- * enterprises/{enterpriseId}/users/{userId}. This is automatically
- * generated by the server based on the device the command is sent to.
+ * The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to.
*/
userName?: string;
}
/**
- * A rule declaring which mitigating actions to take when a device is not
- * compliant with its policy. For every rule, there is always an implicit
- * mitigating action to set policy_compliant to false for the Device resource,
- * and display a message on the device indicating that the device is not
- * compliant with its policy. Other mitigating actions may optionally be taken
- * as well, depending on the field values in the rule.
+ * A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule.
*/
export interface Schema$ComplianceRule {
/**
- * A condition which is satisfied if the Android Framework API level on the
- * device doesn't meet a minimum requirement.
+ * A condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement.
*/
apiLevelCondition?: Schema$ApiLevelCondition;
/**
- * If set to true, the rule includes a mitigating action to disable apps so
- * that the device is effectively disabled, but app data is preserved. If
- * the device is running an app in locked task mode, the app will be closed
- * and a UI showing the reason for non-compliance will be displayed.
+ * If set to true, the rule includes a mitigating action to disable apps so that the device is effectively disabled, but app data is preserved. If the device is running an app in locked task mode, the app will be closed and a UI showing the reason for non-compliance will be displayed.
*/
disableApps?: boolean;
/**
- * A condition which is satisfied if there exists any matching
- * NonComplianceDetail for the device.
+ * A condition which is satisfied if there exists any matching NonComplianceDetail for the device.
*/
nonComplianceDetailCondition?: Schema$NonComplianceDetailCondition;
/**
- * If set, the rule includes a mitigating action to disable apps specified
- * in the list, but app data is preserved.
+ * If set, the rule includes a mitigating action to disable apps specified in the list, but app data is preserved.
*/
packageNamesToDisable?: string[];
}
/**
- * A device owned by an enterprise. Unless otherwise noted, all fields are
- * read-only and can't be modified by enterprises.devices.patch.
+ * A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
*/
export interface Schema$Device {
/**
@@ -447,9 +384,7 @@ export namespace androidmanagement_v1 {
*/
apiLevel?: number;
/**
- * Reports for apps installed on the device. This information is only
- * available when application_reports_enabled is true in the device's
- * policy.
+ * Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
*/
applicationReports?: Schema$ApplicationReport[];
/**
@@ -465,19 +400,15 @@ export namespace androidmanagement_v1 {
*/
appliedState?: string;
/**
- * Device settings information. This information is only available if
- * deviceSettingsEnabled is true in the device's policy.
+ * Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
*/
deviceSettings?: Schema$DeviceSettings;
/**
- * If the device state is DISABLED, an optional message that is displayed on
- * the device indicating the reason the device is disabled. This field can
- * be modified by a patch request.
+ * If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request.
*/
disabledReason?: Schema$UserFacingMessage;
/**
- * Detailed information about displays on the device. This information is
- * only available if displayInfoEnabled is true in the device's policy.
+ * Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
*/
displays?: Schema$Display[];
/**
@@ -485,13 +416,11 @@ export namespace androidmanagement_v1 {
*/
enrollmentTime?: string;
/**
- * If the device was enrolled with an enrollment token with additional data
- * provided, this field contains that data.
+ * If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
*/
enrollmentTokenData?: string;
/**
- * If the device was enrolled with an enrollment token, this field contains
- * the name of the token.
+ * If the device was enrolled with an enrollment token, this field contains the name of the token.
*/
enrollmentTokenName?: string;
/**
@@ -499,8 +428,7 @@ export namespace androidmanagement_v1 {
*/
hardwareInfo?: Schema$HardwareInfo;
/**
- * Hardware status samples in chronological order. This information is only
- * available if hardwareStatusEnabled is true in the device's policy.
+ * Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
*/
hardwareStatusSamples?: Schema$HardwareStatus[];
/**
@@ -516,29 +444,23 @@ export namespace androidmanagement_v1 {
*/
lastStatusReportTime?: string;
/**
- * The type of management mode Android Device Policy takes on the device.
- * This influences which policy settings are supported.
+ * The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
*/
managementMode?: string;
/**
- * Events related to memory and storage measurements in chronological order.
- * This information is only available if memoryInfoEnabled is true in the
- * device's policy.
+ * Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.
*/
memoryEvents?: Schema$MemoryEvent[];
/**
- * Memory information. This information is only available if
- * memoryInfoEnabled is true in the device's policy.
+ * Memory information. This information is only available if memoryInfoEnabled is true in the device's policy.
*/
memoryInfo?: Schema$MemoryInfo;
/**
- * The name of the device in the form
- * enterprises/{enterpriseId}/devices/{deviceId}.
+ * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
/**
- * Device network information. This information is only available if
- * networkInfoEnabled is true in the device's policy.
+ * Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
*/
networkInfo?: Schema$NetworkInfo;
/**
@@ -550,46 +472,35 @@ export namespace androidmanagement_v1 {
*/
policyCompliant?: boolean;
/**
- * The name of the policy applied to the device, in the form
- * enterprises/{enterpriseId}/policies/{policyId}. If not specified, the
- * policy_name for the device's user is applied. This field can be
- * modified by a patch request. You can specify only the policyId when
- * calling enterprises.devices.patch, as long as the policyId doesn’t
- * contain any slashes. The rest of the policy name is inferred.
+ * The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred.
*/
policyName?: string;
/**
- * Power management events on the device in chronological order. This
- * information is only available if powerManagementEventsEnabled is true in
- * the device's policy.
+ * Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
*/
powerManagementEvents?: Schema$PowerManagementEvent[];
/**
- * If the same physical device has been enrolled multiple times, this field
- * contains its previous device names. The serial number is used as the
- * unique identifier to determine if the same physical device has enrolled
- * previously. The names are in chronological order.
+ * If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.
*/
previousDeviceNames?: string[];
/**
- * Detailed information about the device software. This information is only
- * available if softwareInfoEnabled is true in the device's policy.
+ * Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy.
*/
softwareInfo?: Schema$SoftwareInfo;
/**
- * The state to be applied to the device. This field can be modified by a
- * patch request. Note that when calling enterprises.devices.patch, ACTIVE
- * and DISABLED are the only allowable values. To enter the device into a
- * DELETED state, call enterprises.devices.delete.
+ * The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete.
*/
state?: string;
+ /**
+ * Map of selected system properties name and value related to the device.
+ */
+ systemProperties?: {[key: string]: string};
/**
* The user who owns the device.
*/
user?: Schema$User;
/**
- * The resource name of the user that owns this device in the form
- * enterprises/{enterpriseId}/users/{userId}.
+ * The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
*/
userName?: string;
}
@@ -598,8 +509,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$DeviceSettings {
/**
- * Whether ADB (https://developer.android.com/studio/command-line/adb.html)
- * is enabled on the device.
+ * Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
*/
adbEnabled?: boolean;
/**
@@ -623,9 +533,7 @@ export namespace androidmanagement_v1 {
*/
unknownSourcesEnabled?: boolean;
/**
- * Whether Verify Apps (Google Play Protect
- * (https://support.google.com/googleplay/answer/2812853)) is enabled on the
- * device.
+ * Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device.
*/
verifyAppsEnabled?: boolean;
}
@@ -663,11 +571,7 @@ export namespace androidmanagement_v1 {
width?: number;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for Empty is empty JSON object {}.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
*/
export interface Schema$Empty {}
/**
@@ -675,62 +579,39 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$EnrollmentToken {
/**
- * Optional, arbitrary data associated with the enrollment token. This could
- * contain, for example, the ID of an org unit the device is assigned to
- * after enrollment. After a device enrolls with the token, this data will
- * be exposed in the enrollment_token_data field of the Device resource. The
- * data must be 1024 characters or less; otherwise, the creation request
- * will fail.
+ * Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail.
*/
additionalData?: string;
/**
- * The length of time the enrollment token is valid, ranging from 1 minute
- * to 30 days. If not specified, the default duration is 1 hour.
+ * The length of time the enrollment token is valid, ranging from 1 minute to 30 days. If not specified, the default duration is 1 hour.
*/
duration?: string;
/**
- * The expiration time of the token. This is a read-only field generated by
- * the server.
+ * The expiration time of the token. This is a read-only field generated by the server.
*/
expirationTimestamp?: string;
/**
- * The name of the enrollment token, which is generated by the server during
- * creation, in the form
- * enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
+ * The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
*/
name?: string;
/**
- * Whether the enrollment token is for one time use only. If the flag is set
- * to true, only one device can use it for registration.
+ * Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration.
*/
oneTimeOnly?: boolean;
/**
- * The name of the policy initially applied to the enrolled device, in the
- * form enterprises/{enterpriseId}/policies/{policyId}. If not specified,
- * the policy_name for the device’s user is applied. If user_name is also
- * not specified, enterprises/{enterpriseId}/policies/default is applied by
- * default. When updating this field, you can specify only the policyId as
- * long as the policyId doesn’t contain any slashes. The rest of the policy
- * name will be inferred.
+ * The name of the policy initially applied to the enrolled device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device’s user is applied. If user_name is also not specified, enterprises/{enterpriseId}/policies/default is applied by default. When updating this field, you can specify only the policyId as long as the policyId doesn’t contain any slashes. The rest of the policy name will be inferred.
*/
policyName?: string;
/**
- * A JSON string whose UTF-8 representation can be used to generate a QR
- * code to enroll a device with this enrollment token. To enroll a device
- * using NFC, the NFC record must contain a serialized java.util.Properties
- * representation of the properties in the JSON.
+ * A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON.
*/
qrCode?: string;
/**
- * The user associated with this enrollment token. If it's specified
- * when the enrollment token is created and the user does not exist, the
- * user will be created. This field must not contain personally identifiable
- * information. Only the account_identifier field needs to be set.
+ * The user associated with this enrollment token. If it's specified when the enrollment token is created and the user does not exist, the user will be created. This field must not contain personally identifiable information. Only the account_identifier field needs to be set.
*/
user?: Schema$User;
/**
- * The token value that's passed to the device and authorizes the device
- * to enroll. This is a read-only field generated by the server.
+ * The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
*/
value?: string;
}
@@ -751,75 +632,53 @@ export namespace androidmanagement_v1 {
*/
enterpriseDisplayName?: string;
/**
- * An image displayed as a logo during device provisioning. Supported types
- * are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png,
- * image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
+ * An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
*/
logo?: Schema$ExternalData;
/**
- * The name of the enterprise which is generated by the server during
- * creation, in the form enterprises/{enterpriseId}.
+ * The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
*/
name?: string;
/**
- * A color in RGB format that indicates the predominant color to display in
- * the device management app UI. The color components are stored as follows:
- * (red << 16) | (green << 8) | blue, where the value of each
- * component is between 0 and 255, inclusive.
+ * A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.
*/
primaryColor?: number;
/**
- * The topic that Cloud Pub/Sub notifications are published to, in the form
- * projects/{project}/topics/{topic}. This field is only required if Pub/Sub
- * notifications are enabled.
+ * The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
*/
pubsubTopic?: string;
/**
- * Sign-in details of the enterprise. Maximum of 1 SigninDetail is
- * supported.
+ * Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported.
*/
signinDetails?: Schema$SigninDetail[];
/**
- * Terms and conditions that must be accepted when provisioning a device for
- * this enterprise. A page of terms is generated for each value in this
- * list.
+ * Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
*/
termsAndConditions?: Schema$TermsAndConditions[];
}
/**
- * Data hosted at an external location. The data is to be downloaded by
- * Android Device Policy and verified against the hash.
+ * Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash.
*/
export interface Schema$ExternalData {
/**
- * The base-64 encoded SHA-256 hash of the content hosted at url. If the
- * content doesn't match this hash, Android Device Policy won't use
- * the data.
+ * The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.
*/
sha256Hash?: string;
/**
- * The absolute URL to the data, which must use either the http or https
- * scheme. Android Device Policy doesn't provide any credentials in the
- * GET request, so the URL must be publicly accessible. Including a long,
- * random component in the URL may be used to prevent attackers from
- * discovering the URL.
+ * The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
*/
url?: string;
}
/**
- * Information about device hardware. The fields related to temperature
- * thresholds are only available if hardwareStatusEnabled is true in the
- * device's policy.
+ * Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy.
*/
export interface Schema$HardwareInfo {
/**
- * Battery shutdown temperature thresholds in Celsius for each battery on
- * the device.
+ * Battery shutdown temperature thresholds in Celsius for each battery on the device.
*/
batteryShutdownTemperatures?: number[];
/**
- * Battery throttling temperature thresholds in Celsius for each battery on
- * the device.
+ * Battery throttling temperature thresholds in Celsius for each battery on the device.
*/
batteryThrottlingTemperatures?: number[];
/**
@@ -827,13 +686,11 @@ export namespace androidmanagement_v1 {
*/
brand?: string;
/**
- * CPU shutdown temperature thresholds in Celsius for each CPU on the
- * device.
+ * CPU shutdown temperature thresholds in Celsius for each CPU on the device.
*/
cpuShutdownTemperatures?: number[];
/**
- * CPU throttling temperature thresholds in Celsius for each CPU on the
- * device.
+ * CPU throttling temperature thresholds in Celsius for each CPU on the device.
*/
cpuThrottlingTemperatures?: number[];
/**
@@ -841,13 +698,11 @@ export namespace androidmanagement_v1 {
*/
deviceBasebandVersion?: string;
/**
- * GPU shutdown temperature thresholds in Celsius for each GPU on the
- * device.
+ * GPU shutdown temperature thresholds in Celsius for each GPU on the device.
*/
gpuShutdownTemperatures?: number[];
/**
- * GPU throttling temperature thresholds in Celsius for each GPU on the
- * device.
+ * GPU throttling temperature thresholds in Celsius for each GPU on the device.
*/
gpuThrottlingTemperatures?: number[];
/**
@@ -876,8 +731,7 @@ export namespace androidmanagement_v1 {
skinThrottlingTemperatures?: number[];
}
/**
- * Hardware status. Temperatures may be compared to the temperature thresholds
- * available in hardwareInfo to determine hardware health.
+ * Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
*/
export interface Schema$HardwareStatus {
/**
@@ -889,9 +743,7 @@ export namespace androidmanagement_v1 {
*/
cpuTemperatures?: number[];
/**
- * CPU usages in percentage for each core available on the device. Usage is
- * 0 for each unplugged core. Empty array implies that CPU usage is not
- * supported in the system.
+ * CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system.
*/
cpuUsages?: number[];
/**
@@ -899,8 +751,7 @@ export namespace androidmanagement_v1 {
*/
createTime?: string;
/**
- * Fan speeds in RPM for each fan on the device. Empty array means that
- * there are no fans or fan speed is not supported on the system.
+ * Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system.
*/
fanSpeeds?: number[];
/**
@@ -921,15 +772,11 @@ export namespace androidmanagement_v1 {
*/
createTime?: string;
/**
- * Optionally, a machine-readable value to be read by the EMM. For example,
- * setting values that the admin can choose to query against in the EMM
- * console (e.g. “notify me if the battery_warning data < 10”).
+ * Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”).
*/
data?: string;
/**
- * The key for the app state. Acts as a point of reference for what the app
- * is providing state for. For example, when providing managed configuration
- * feedback, this key could be the managed configuration key.
+ * The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key.
*/
key?: string;
/**
@@ -937,9 +784,7 @@ export namespace androidmanagement_v1 {
*/
lastUpdateTime?: string;
/**
- * Optionally, a free-form message string to explain the app state. If the
- * state was triggered by a particular value (e.g. a managed configuration
- * value), it should be included in the message.
+ * Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.
*/
message?: string;
/**
@@ -1009,13 +854,11 @@ export namespace androidmanagement_v1 {
webApps?: Schema$WebApp[];
}
/**
- * The managed configurations template for the app, saved from the managed
- * configurations iframe.
+ * The managed configurations template for the app, saved from the managed configurations iframe.
*/
export interface Schema$ManagedConfigurationTemplate {
/**
- * Optional, a map containing <key, value> configuration variables
- * defined for the configuration.
+ * Optional, a map containing <key, value> configuration variables defined for the configuration.
*/
configurationVariables?: {[key: string]: string};
/**
@@ -1028,13 +871,11 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$ManagedProperty {
/**
- * The default value of the property. BUNDLE_ARRAY properties don't have
- * a default value.
+ * The default value of the property. BUNDLE_ARRAY properties don't have a default value.
*/
defaultValue?: any;
/**
- * A longer description of the property, providing more detail of what it
- * affects. Localized.
+ * A longer description of the property, providing more detail of what it affects. Localized.
*/
description?: string;
/**
@@ -1042,13 +883,11 @@ export namespace androidmanagement_v1 {
*/
entries?: Schema$ManagedPropertyEntry[];
/**
- * The unique key that the app uses to identify the property, e.g.
- * "com.google.android.gm.fieldname".
+ * The unique key that the app uses to identify the property, e.g. "com.google.android.gm.fieldname".
*/
key?: string;
/**
- * For BUNDLE_ARRAY properties, the list of nested properties. A
- * BUNDLE_ARRAY property is at most two levels deep.
+ * For BUNDLE_ARRAY properties, the list of nested properties. A BUNDLE_ARRAY property is at most two levels deep.
*/
nestedProperties?: Schema$ManagedProperty[];
/**
@@ -1069,8 +908,7 @@ export namespace androidmanagement_v1 {
*/
name?: string;
/**
- * The machine-readable value of the entry, which should be used in the
- * configuration. Not localized.
+ * The machine-readable value of the entry, which should be used in the configuration. Not localized.
*/
value?: string;
}
@@ -1079,8 +917,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$MemoryEvent {
/**
- * The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED,
- * the total capacity in bytes of the storage medium.
+ * The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.
*/
byteCount?: string;
/**
@@ -1131,26 +968,15 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$NonComplianceDetail {
/**
- * If the policy setting could not be applied, the current value of the
- * setting on the device.
+ * If the policy setting could not be applied, the current value of the setting on the device.
*/
currentValue?: any;
/**
- * For settings with nested fields, if a particular nested field is out of
- * compliance, this specifies the full path to the offending field. The path
- * is formatted in the same way the policy JSON field would be referenced in
- * JavaScript, that is: 1) For object-typed fields, the field name is
- * followed by a dot then by a subfield name. 2) For array-typed fields,
- * the field name is followed by the array index enclosed in brackets. For
- * example, to indicate a problem with the url field in the externalData
- * field in the 3rd application, the path would be
- * applications[2].externalData.url
+ * For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url
*/
fieldPath?: string;
/**
- * If package_name is set and the non-compliance reason is APP_NOT_INSTALLED
- * or APP_NOT_UPDATED, the detailed reason the app can't be installed or
- * updated.
+ * If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated.
*/
installationFailureReason?: string;
/**
@@ -1158,50 +984,37 @@ export namespace androidmanagement_v1 {
*/
nonComplianceReason?: string;
/**
- * The package name indicating which app is out of compliance, if
- * applicable.
+ * The package name indicating which app is out of compliance, if applicable.
*/
packageName?: string;
/**
- * The name of the policy setting. This is the JSON field name of a
- * top-level Policy field.
+ * The name of the policy setting. This is the JSON field name of a top-level Policy field.
*/
settingName?: string;
}
/**
- * A compliance rule condition which is satisfied if there exists any matching
- * NonComplianceDetail for the device. A NonComplianceDetail matches a
- * NonComplianceDetailCondition if all the fields which are set within the
- * NonComplianceDetailCondition match the corresponding NonComplianceDetail
- * fields.
+ * A compliance rule condition which is satisfied if there exists any matching NonComplianceDetail for the device. A NonComplianceDetail matches a NonComplianceDetailCondition if all the fields which are set within the NonComplianceDetailCondition match the corresponding NonComplianceDetail fields.
*/
export interface Schema$NonComplianceDetailCondition {
/**
- * The reason the device is not in compliance with the setting. If not set,
- * then this condition matches any reason.
+ * The reason the device is not in compliance with the setting. If not set, then this condition matches any reason.
*/
nonComplianceReason?: string;
/**
- * The package name of the app that's out of compliance. If not set,
- * then this condition matches any package name.
+ * The package name of the app that's out of compliance. If not set, then this condition matches any package name.
*/
packageName?: string;
/**
- * The name of the policy setting. This is the JSON field name of a
- * top-level Policy field. If not set, then this condition matches any
- * setting name.
+ * The name of the policy setting. This is the JSON field name of a top-level Policy field. If not set, then this condition matches any setting name.
*/
settingName?: string;
}
/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
+ * This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
- * If the value is false, it means the operation is still in progress. If
- * true, the operation is completed, and either error or response is
- * available.
+ * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
*/
done?: boolean;
/**
@@ -1209,26 +1022,15 @@ export namespace androidmanagement_v1 {
*/
error?: Schema$Status;
/**
- * Service-specific metadata associated with the operation. It typically
- * contains progress information and common metadata such as create time.
- * Some services might not provide such metadata. Any method that returns a
- * long-running operation should document the metadata type, if any.
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any};
/**
- * The server-assigned name, which is only unique within the same service
- * that originally returns it. If you use the default HTTP mapping, the name
- * should have the format of operations/some/unique/name.
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
*/
name?: string;
/**
- * The normal response of the operation in case of success. If the original
- * method returns no data on success, such as Delete, the response is
- * google.protobuf.Empty. If the original method is standard
- * Get/Create/Update, the response should be the resource. For other
- * methods, the response should have the type XxxResponse, where Xxx is the
- * original method name. For example, if the original method name is
- * TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
*/
response?: {[key: string]: any};
}
@@ -1246,8 +1048,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$PasswordRequirements {
/**
- * Number of incorrect device-unlock passwords that can be entered before a
- * device is wiped. A value of 0 means there is no restriction.
+ * Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
*/
maximumFailedPasswordsForWipe?: number;
/**
@@ -1255,45 +1056,35 @@ export namespace androidmanagement_v1 {
*/
passwordExpirationTimeout?: string;
/**
- * The length of the password history. After setting this field, the user
- * won't be able to enter a new password that is the same as any
- * password in the history. A value of 0 means there is no restriction.
+ * The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
*/
passwordHistoryLength?: number;
/**
- * The minimum allowed password length. A value of 0 means there is no
- * restriction. Only enforced when password_quality is NUMERIC,
- * NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
+ * The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
*/
passwordMinimumLength?: number;
/**
- * Minimum number of letters required in the password. Only enforced when
- * password_quality is COMPLEX.
+ * Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumLetters?: number;
/**
- * Minimum number of lower case letters required in the password. Only
- * enforced when password_quality is COMPLEX.
+ * Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumLowerCase?: number;
/**
- * Minimum number of non-letter characters (numerical digits or symbols)
- * required in the password. Only enforced when password_quality is COMPLEX.
+ * Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumNonLetter?: number;
/**
- * Minimum number of numerical digits required in the password. Only
- * enforced when password_quality is COMPLEX.
+ * Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumNumeric?: number;
/**
- * Minimum number of symbols required in the password. Only enforced when
- * password_quality is COMPLEX.
+ * Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumSymbols?: number;
/**
- * Minimum number of upper case letters required in the password. Only
- * enforced when password_quality is COMPLEX.
+ * Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumUpperCase?: number;
/**
@@ -1310,8 +1101,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$PermissionGrant {
/**
- * The Android permission or group, e.g. android.permission.READ_CALENDAR or
- * android.permission_group.CALENDAR.
+ * The Android permission or group, e.g. android.permission.READ_CALENDAR or android.permission_group.CALENDAR.
*/
permission?: string;
/**
@@ -1320,35 +1110,24 @@ export namespace androidmanagement_v1 {
policy?: string;
}
/**
- * A default activity for handling intents that match a particular intent
- * filter.
+ * A default activity for handling intents that match a particular intent filter.
*/
export interface Schema$PersistentPreferredActivity {
/**
- * The intent actions to match in the filter. If any actions are included in
- * the filter, then an intent's action must be one of those values for
- * it to match. If no actions are included, the intent action is ignored.
+ * The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored.
*/
actions?: string[];
/**
- * The intent categories to match in the filter. An intent includes the
- * categories that it requires, all of which must be included in the filter
- * in order to match. In other words, adding a category to the filter has no
- * impact on matching unless that category is specified in the intent.
+ * The intent categories to match in the filter. An intent includes the categories that it requires, all of which must be included in the filter in order to match. In other words, adding a category to the filter has no impact on matching unless that category is specified in the intent.
*/
categories?: string[];
/**
- * The activity that should be the default intent handler. This should be an
- * Android component name, e.g. com.android.enterprise.app/.MainActivity.
- * Alternatively, the value may be the package name of an app, which causes
- * Android Device Policy to choose an appropriate activity from the app to
- * handle the intent.
+ * The activity that should be the default intent handler. This should be an Android component name, e.g. com.android.enterprise.app/.MainActivity. Alternatively, the value may be the package name of an app, which causes Android Device Policy to choose an appropriate activity from the app to handle the intent.
*/
receiverActivity?: string;
}
/**
- * A policy resources represents a group settings that govern the behavior of
- * a managed device and the apps installed on it.
+ * A policy resources represents a group settings that govern the behavior of a managed device and the apps installed on it.
*/
export interface Schema$Policy {
/**
@@ -1364,19 +1143,15 @@ export namespace androidmanagement_v1 {
*/
adjustVolumeDisabled?: boolean;
/**
- * Configuration for an always-on VPN connection. Use with
- * vpn_config_disabled to prevent modification of this setting.
+ * Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting.
*/
alwaysOnVpnPackage?: Schema$AlwaysOnVpnPackage;
/**
- * The app tracks for Android Device Policy the device can access. The
- * device receives the latest version among all accessible tracks. If no
- * tracks are specified, then the device only uses the production track.
+ * The app tracks for Android Device Policy the device can access. The device receives the latest version among all accessible tracks. If no tracks are specified, then the device only uses the production track.
*/
androidDevicePolicyTracks?: string[];
/**
- * The app auto update policy, which controls when automatic app updates can
- * be applied.
+ * The app auto update policy, which controls when automatic app updates can be applied.
*/
appAutoUpdatePolicy?: string;
/**
@@ -1384,15 +1159,11 @@ export namespace androidmanagement_v1 {
*/
applications?: Schema$ApplicationPolicy[];
/**
- * Whether auto time is required, which prevents the user from manually
- * setting the date and time.
+ * Whether auto time is required, which prevents the user from manually setting the date and time.
*/
autoTimeRequired?: boolean;
/**
- * Whether applications other than the ones configured in applications are
- * blocked from being installed. When set, applications that were installed
- * under a previous policy but no longer appear in the policy are
- * automatically uninstalled.
+ * Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled.
*/
blockApplicationsEnabled?: boolean;
/**
@@ -1404,9 +1175,7 @@ export namespace androidmanagement_v1 {
*/
bluetoothContactSharingDisabled?: boolean;
/**
- * Whether bluetooth is disabled. Prefer this setting over
- * bluetooth_config_disabled because bluetooth_config_disabled can be
- * bypassed by the user.
+ * Whether bluetooth is disabled. Prefer this setting over bluetooth_config_disabled because bluetooth_config_disabled can be bypassed by the user.
*/
bluetoothDisabled?: boolean;
/**
@@ -1418,17 +1187,11 @@ export namespace androidmanagement_v1 {
*/
cellBroadcastsConfigDisabled?: boolean;
/**
- * Rules for automatically choosing a private key and certificate to
- * authenticate the device to a server. The rules are ordered by increasing
- * precedence, so if an outgoing request matches more than one rule, the
- * last rule defines which private key to use.
+ * Rules for automatically choosing a private key and certificate to authenticate the device to a server. The rules are ordered by increasing precedence, so if an outgoing request matches more than one rule, the last rule defines which private key to use.
*/
choosePrivateKeyRules?: Schema$ChoosePrivateKeyRule[];
/**
- * Rules declaring which mitigating actions to take when a device is not
- * compliant with its policy. When the conditions for multiple rules are
- * satisfied, all of the mitigating actions for the rules are taken. There
- * is a maximum limit of 100 rules.
+ * Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules.
*/
complianceRules?: Schema$ComplianceRule[];
/**
@@ -1468,16 +1231,11 @@ export namespace androidmanagement_v1 {
*/
factoryResetDisabled?: boolean;
/**
- * Email addresses of device administrators for factory reset protection.
- * When the device is factory reset, it will require one of these admins to
- * log in with the Google account email and password to unlock the device.
- * If no admins are specified, the device won't provide factory reset
- * protection.
+ * Email addresses of device administrators for factory reset protection. When the device is factory reset, it will require one of these admins to log in with the Google account email and password to unlock the device. If no admins are specified, the device won't provide factory reset protection.
*/
frpAdminEmails?: string[];
/**
- * Whether the user is allowed to have fun. Controls whether the Easter egg
- * game in Settings is disabled.
+ * Whether the user is allowed to have fun. Controls whether the Easter egg game in Settings is disabled.
*/
funDisabled?: boolean;
/**
@@ -1485,8 +1243,7 @@ export namespace androidmanagement_v1 {
*/
installAppsDisabled?: boolean;
/**
- * Whether the user is allowed to enable the "Unknown Sources"
- * setting, which allows installation of apps from unknown sources.
+ * Whether the user is allowed to enable the "Unknown Sources" setting, which allows installation of apps from unknown sources.
*/
installUnknownSourcesAllowed?: boolean;
/**
@@ -1498,28 +1255,25 @@ export namespace androidmanagement_v1 {
*/
keyguardDisabledFeatures?: string[];
/**
- * Whether the kiosk custom launcher is enabled. This replaces the home
- * screen with a launcher that locks down the device to the apps installed
- * via the applications setting. The apps appear on a single page in
- * alphabetical order. It is recommended to also use status_bar_disabled to
- * block access to device settings.
+ * Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. The apps appear on a single page in alphabetical order. It is recommended to also use status_bar_disabled to block access to device settings.
*/
kioskCustomLauncherEnabled?: boolean;
/**
- * The degree of location detection enabled. The user may change the value
- * unless the user is otherwise blocked from accessing device settings.
+ * The degree of location detection enabled. The user may change the value unless the user is otherwise blocked from accessing device settings.
*/
locationMode?: string;
/**
- * A message displayed to the user in the device administators settings
- * screen.
+ * A message displayed to the user in the device administators settings screen.
*/
longSupportMessage?: Schema$UserFacingMessage;
/**
- * Maximum time in milliseconds for user activity until the device locks. A
- * value of 0 means there is no restriction.
+ * Maximum time in milliseconds for user activity until the device locks. A value of 0 means there is no restriction.
*/
maximumTimeToLock?: string;
+ /**
+ * The minimum allowed Android API level.
+ */
+ minimumApiLevel?: number;
/**
* Whether configuring mobile networks is disabled.
*/
@@ -1533,19 +1287,11 @@ export namespace androidmanagement_v1 {
*/
mountPhysicalMediaDisabled?: boolean;
/**
- * The name of the policy in the form
- * enterprises/{enterpriseId}/policies/{policyId}.
+ * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
*/
name?: string;
/**
- * Whether the network escape hatch is enabled. If a network connection
- * can't be made at boot time, the escape hatch prompts the user to
- * temporarily connect to a network in order to refresh the device policy.
- * After applying policy, the temporary network will be forgotten and the
- * device will continue booting. This prevents being unable to connect to a
- * network if there is no suitable network in the last policy and the device
- * boots into an app in lock task mode, or the user is otherwise unable to
- * reach device settings.
+ * Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.
*/
networkEscapeHatchEnabled?: boolean;
/**
@@ -1553,8 +1299,7 @@ export namespace androidmanagement_v1 {
*/
networkResetDisabled?: boolean;
/**
- * Network configuration for the device. See configure networks for more
- * information.
+ * Network configuration for the device. See configure networks for more information.
*/
openNetworkConfiguration?: {[key: string]: any};
/**
@@ -1566,9 +1311,7 @@ export namespace androidmanagement_v1 {
*/
outgoingCallsDisabled?: boolean;
/**
- * Password requirement policies. Different policies can be set for work
- * profile or fully managed devices by setting the password_scope field in
- * the policy.
+ * Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy.
*/
passwordPolicies?: Schema$PasswordRequirements[];
/**
@@ -1576,14 +1319,11 @@ export namespace androidmanagement_v1 {
*/
passwordRequirements?: Schema$PasswordRequirements;
/**
- * Explicit permission or group grants or denials for all apps. These values
- * override the default_permission_policy.
+ * Explicit permission or group grants or denials for all apps. These values override the default_permission_policy.
*/
permissionGrants?: Schema$PermissionGrant[];
/**
- * If present, only the input methods provided by packages in this list are
- * permitted. If this field is present, but the list is empty, then only
- * system input methods are permitted.
+ * If present, only the input methods provided by packages in this list are permitted. If this field is present, but the list is empty, then only system input methods are permitted.
*/
permittedInputMethods?: Schema$PackageNameList;
/**
@@ -1591,22 +1331,19 @@ export namespace androidmanagement_v1 {
*/
persistentPreferredActivities?: Schema$PersistentPreferredActivity[];
/**
- * This mode controls which apps are available to the user in the Play Store
- * and the behavior on the device when apps are removed from the policy.
+ * This mode controls which apps are available to the user in the Play Store and the behavior on the device when apps are removed from the policy.
*/
playStoreMode?: string;
/**
- * Allows showing UI on a device for a user to choose a private key alias if
- * there are no matching rules in ChoosePrivateKeyRules. For devices below
- * Android P, setting this may leave enterprise keys vulnerable.
+ * Rules that define the behavior when a particular policy can not be applied on device
+ */
+ policyEnforcementRules?: Schema$PolicyEnforcementRule[];
+ /**
+ * Allows showing UI on a device for a user to choose a private key alias if there are no matching rules in ChoosePrivateKeyRules. For devices below Android P, setting this may leave enterprise keys vulnerable.
*/
privateKeySelectionEnabled?: boolean;
/**
- * The network-independent global HTTP proxy. Typically proxies should be
- * configured per-network in open_network_configuration. However for unusual
- * configurations like general internal filtering a global HTTP proxy may be
- * useful. If the proxy is not accessible, network access may break. The
- * global proxy is only a recommendation and some apps may ignore it.
+ * The network-independent global HTTP proxy. Typically proxies should be configured per-network in open_network_configuration. However for unusual configurations like general internal filtering a global HTTP proxy may be useful. If the proxy is not accessible, network access may break. The global proxy is only a recommendation and some apps may ignore it.
*/
recommendedGlobalProxy?: Schema$ProxyInfo;
/**
@@ -1638,14 +1375,11 @@ export namespace androidmanagement_v1 {
*/
shareLocationDisabled?: boolean;
/**
- * A message displayed to the user in the settings screen wherever
- * functionality has been disabled by the admin.
+ * A message displayed to the user in the settings screen wherever functionality has been disabled by the admin.
*/
shortSupportMessage?: Schema$UserFacingMessage;
/**
- * Flag to skip hints on the first use. Enterprise admin can enable the
- * system recommendation for apps to skip their user tutorial and other
- * introductory hints on first start-up.
+ * Flag to skip hints on the first use. Enterprise admin can enable the system recommendation for apps to skip their user tutorial and other introductory hints on first start-up.
*/
skipFirstUseHintsEnabled?: boolean;
/**
@@ -1653,9 +1387,7 @@ export namespace androidmanagement_v1 {
*/
smsDisabled?: boolean;
/**
- * Whether the status bar is disabled. This disables notifications, quick
- * settings, and other screen overlays that allow escape from full-screen
- * mode.
+ * Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode.
*/
statusBarDisabled?: boolean;
/**
@@ -1663,15 +1395,11 @@ export namespace androidmanagement_v1 {
*/
statusReportingSettings?: Schema$StatusReportingSettings;
/**
- * The battery plugged in modes for which the device stays on. When using
- * this setting, it is recommended to clear maximum_time_to_lock so that the
- * device doesn't lock itself while it stays on.
+ * The battery plugged in modes for which the device stays on. When using this setting, it is recommended to clear maximum_time_to_lock so that the device doesn't lock itself while it stays on.
*/
stayOnPluggedModes?: string[];
/**
- * The system update policy, which controls how OS updates are applied. If
- * the update type is WINDOWED, the update window will automatically apply
- * to Play app updates as well.
+ * The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well.
*/
systemUpdate?: Schema$SystemUpdate;
/**
@@ -1683,8 +1411,7 @@ export namespace androidmanagement_v1 {
*/
uninstallAppsDisabled?: boolean;
/**
- * Whether the microphone is muted and adjusting microphone volume is
- * disabled.
+ * Whether the microphone is muted and adjusting microphone volume is disabled.
*/
unmuteMicrophoneDisabled?: boolean;
/**
@@ -1696,8 +1423,7 @@ export namespace androidmanagement_v1 {
*/
usbMassStorageEnabled?: boolean;
/**
- * The version of the policy. This is a read-only field. The version is
- * incremented each time the policy is updated.
+ * The version of the policy. This is a read-only field. The version is incremented each time the policy is updated.
*/
version?: string;
/**
@@ -1713,6 +1439,23 @@ export namespace androidmanagement_v1 {
*/
wifiConfigsLockdownEnabled?: boolean;
}
+ /**
+ * A rule that defines the actions to take if a device or work profile is not compliant with the policy specified in settingName.
+ */
+ export interface Schema$PolicyEnforcementRule {
+ /**
+ * An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified.
+ */
+ blockAction?: Schema$BlockAction;
+ /**
+ * The top-level policy to enforce. For example, applications or passwordRequirements.
+ */
+ settingName?: string;
+ /**
+ * An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified.
+ */
+ wipeAction?: Schema$WipeAction;
+ }
/**
* A power management event.
*/
@@ -1731,14 +1474,11 @@ export namespace androidmanagement_v1 {
eventType?: string;
}
/**
- * Configuration info for an HTTP proxy. For a direct proxy, set the host,
- * port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri
- * field.
+ * Configuration info for an HTTP proxy. For a direct proxy, set the host, port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri field.
*/
export interface Schema$ProxyInfo {
/**
- * For a direct proxy, the hosts for which the proxy is bypassed. The host
- * names may contain wildcards such as *.example.com.
+ * For a direct proxy, the hosts for which the proxy is bypassed. The host names may contain wildcards such as *.example.com.
*/
excludedHosts?: string[];
/**
@@ -1776,25 +1516,15 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$SigninDetail {
/**
- * A JSON string whose UTF-8 representation can be used to generate a QR
- * code to enroll a device with this enrollment token. To enroll a device
- * using NFC, the NFC record must contain a serialized java.util.Properties
- * representation of the properties in the JSON. This is a read-only field
- * generated by the server.
+ * A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
*/
qrCode?: string;
/**
- * An enterprise wide enrollment token used to trigger custom sign-in flow.
- * This is a read-only field generated by the server.
+ * An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
*/
signinEnrollmentToken?: string;
/**
- * Sign-in URL for authentication when device is provisioned with a sign-in
- * enrollment token. The sign-in endpoint should finish authentication flow
- * with a URL in the form of
- * https://enterprise.google.com/android/enroll?et=<token> for a
- * successful login, or https://enterprise.google.com/android/enroll/invalid
- * for a failed login.
+ * Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
*/
signinUrl?: string;
}
@@ -1803,13 +1533,11 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$SignupUrl {
/**
- * The name of the resource. Use this value in the signupUrl field when
- * calling enterprises.create to complete the enterprise signup flow.
+ * The name of the resource. Use this value in the signupUrl field when calling enterprises.create to complete the enterprise signup flow.
*/
name?: string;
/**
- * A URL where an enterprise admin can register their enterprise. The page
- * can't be rendered in an iframe.
+ * A URL where an enterprise admin can register their enterprise. The page can't be rendered in an iframe.
*/
url?: string;
}
@@ -1818,8 +1546,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$SoftwareInfo {
/**
- * Android build ID string meant for displaying to the user. For example,
- * shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
+ * Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
*/
androidBuildNumber?: string;
/**
@@ -1843,10 +1570,7 @@ export namespace androidmanagement_v1 {
*/
bootloaderVersion?: string;
/**
- * SHA-256 hash of android.content.pm.Signature
- * (https://developer.android.com/reference/android/content/pm/Signature.html)
- * associated with the system package, which can be used to verify that the
- * system build hasn't been modified.
+ * SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified.
*/
deviceBuildSignature?: string;
/**
@@ -1863,39 +1587,7 @@ export namespace androidmanagement_v1 {
securityPatchLevel?: string;
}
/**
- * The Status type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by gRPC (https://github.com/grpc). The error model is designed to be:
- * Simple to use and understand for most users Flexible enough to meet
- * unexpected needsOverviewThe Status message contains three pieces of data:
- * error code, error message, and error details. The error code should be an
- * enum value of google.rpc.Code, but it may accept additional error codes if
- * needed. The error message should be a developer-facing English message that
- * helps developers understand and resolve the error. If a localized
- * user-facing error message is needed, put the localized message in the error
- * details or localize it in the client. The optional error details may
- * contain arbitrary information about the error. There is a predefined set of
- * error detail types in the package google.rpc that can be used for common
- * error conditions.Language mappingThe Status message is the logical
- * representation of the error model, but it is not necessarily the actual
- * wire format. When the Status message is exposed in different client
- * libraries and different wire protocols, it can be mapped differently. For
- * example, it will likely be mapped to some exceptions in Java, but more
- * likely mapped to some error codes in C.Other usesThe error model and the
- * Status message can be used in a variety of environments, either with or
- * without APIs, to provide a consistent developer experience across different
- * environments.Example uses of this error model include: Partial errors. If a
- * service needs to return partial errors to the client, it may embed the
- * Status in the normal response to indicate the partial errors. Workflow
- * errors. A typical workflow has multiple steps. Each step may have a Status
- * message for error reporting. Batch operations. If a client uses batch
- * request and batch response, the Status message should be used directly
- * inside batch response, one for each error sub-response. Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the Status message. Logging. If some API errors are stored in logs,
- * the message Status could be used directly after any stripping needed for
- * security/privacy reasons.
+ * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -1903,14 +1595,11 @@ export namespace androidmanagement_v1 {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set of
- * message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
@@ -1919,8 +1608,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$StatusReportingSettings {
/**
- * Application reporting settings. Only applicable if
- * application_reports_enabled is true.
+ * Application reporting settings. Only applicable if application_reports_enabled is true.
*/
applicationReportingSettings?: Schema$ApplicationReportingSettings;
/**
@@ -1961,18 +1649,11 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$SystemUpdate {
/**
- * If the type is WINDOWED, the end of the maintenance window, measured as
- * the number of minutes after midnight in device's local time. This
- * value must be between 0 and 1439, inclusive. If this value is less than
- * start_minutes, then the maintenance window spans midnight. If the
- * maintenance window specified is smaller than 30 minutes, the actual
- * window is extended to 30 minutes beyond the start time.
+ * If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time.
*/
endMinutes?: number;
/**
- * If the type is WINDOWED, the start of the maintenance window, measured as
- * the number of minutes after midnight in the device's local time. This
- * value must be between 0 and 1439, inclusive.
+ * If the type is WINDOWED, the start of the maintenance window, measured as the number of minutes after midnight in the device's local time. This value must be between 0 and 1439, inclusive.
*/
startMinutes?: number;
/**
@@ -1985,8 +1666,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$TermsAndConditions {
/**
- * A well-formatted HTML string. It will be parsed on the client with
- * android.text.Html#fromHtml.
+ * A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
*/
content?: Schema$UserFacingMessage;
/**
@@ -1999,30 +1679,20 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$User {
/**
- * A unique identifier you create for this user, such as user342 or
- * asset#44418. This field must be set when the user is created and
- * can't be updated. This field must not contain personally identifiable
- * information (PII). This identifier must be 1024 characters or less;
- * otherwise, the update policy request will fail.
+ * A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.
*/
accountIdentifier?: string;
}
/**
- * Provides a user-facing message with locale info. The maximum message length
- * is 4096 characters.
+ * Provides a user-facing message with locale info. The maximum message length is 4096 characters.
*/
export interface Schema$UserFacingMessage {
/**
- * The default message displayed if no localized message is specified or the
- * user's locale doesn't match with any of the localized messages. A
- * default message must be provided if any localized messages are provided.
+ * The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
*/
defaultMessage?: string;
/**
- * A map containing <locale, message> pairs, where locale is a
- * well-formed BCP 47 language
- * (https://www.w3.org/International/articles/language-tags/) code, such as
- * en-US, es-ES, or fr.
+ * A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
*/
localizedMessages?: {[key: string]: string};
}
@@ -2039,24 +1709,19 @@ export namespace androidmanagement_v1 {
*/
icons?: Schema$WebAppIcon[];
/**
- * The name of the web app, which is generated by the server during creation
- * in the form enterprises/{enterpriseId}/webApps/{packageName}.
+ * The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.
*/
name?: string;
/**
- * The start URL, i.e. the URL that should load when the user opens the
- * application.
+ * The start URL, i.e. the URL that should load when the user opens the application.
*/
startUrl?: string;
/**
- * The title of the web app as displayed to the user (e.g., amongst a list
- * of other applications, or as a label for an icon).
+ * The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
*/
title?: string;
/**
- * The current version of the app.<p>Note that the version can
- * automatically increase during the lifetime of the web app, while Google
- * does internal housekeeping to keep the web app up-to-date.
+ * The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
*/
versionCode?: string;
}
@@ -2065,11 +1730,7 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$WebAppIcon {
/**
- * The actual bytes of the image in a base64url encoded string (c.f.
- * RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe
- * Alphabet"). <ul> <li>The image type can be png or jpg.
- * <li>The image should ideally be square. <li>The image should
- * ideally have a size of 512x512. </ul>
+ * The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
*/
imageData?: string;
}
@@ -2078,27 +1739,35 @@ export namespace androidmanagement_v1 {
*/
export interface Schema$WebToken {
/**
- * The name of the web token, which is generated by the server during
- * creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}.
+ * The name of the web token, which is generated by the server during creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}.
*/
name?: string;
/**
- * The URL of the parent frame hosting the iframe with the embedded UI. To
- * prevent XSS, the iframe may not be hosted at other URLs. The URL must use
- * the https scheme.
+ * The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe may not be hosted at other URLs. The URL must use the https scheme.
*/
parentFrameUrl?: string;
/**
- * Permissions available to an admin in the embedded UI. An admin must have
- * all of these permissions in order to view the UI.
+ * Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI.
*/
permissions?: string[];
/**
- * The token value which is used in the hosting page to generate the iframe
- * with the embedded UI. This is a read-only field generated by the server.
+ * The token value which is used in the hosting page to generate the iframe with the embedded UI. This is a read-only field generated by the server.
*/
value?: string;
}
+ /**
+ * An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified.
+ */
+ export interface Schema$WipeAction {
+ /**
+ * Whether the factory-reset protection data is preserved on the device. This setting doesn’t apply to work profiles.
+ */
+ preserveFrp?: boolean;
+ /**
+ * Number of days the policy is non-compliant before the device or work profile is wiped. wipeAfterDays must be greater than blockAfterDays.
+ */
+ wipeAfterDays?: number;
+ }
export class Resource$Enterprises {
context: APIRequestContext;
@@ -2122,8 +1791,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.create
- * @desc Creates an enterprise. This is the last step in the enterprise
- * signup flow.
+ * @desc Creates an enterprise. This is the last step in the enterprise signup flow.
* @alias androidmanagement.enterprises.create
* @memberOf! ()
*
@@ -2354,8 +2022,7 @@ export namespace androidmanagement_v1 {
*/
enterpriseToken?: string;
/**
- * The ID of the Google Cloud Platform project which will own the
- * enterprise.
+ * The ID of the Google Cloud Platform project which will own the enterprise.
*/
projectId?: string;
/**
@@ -2391,8 +2058,7 @@ export namespace androidmanagement_v1 {
*/
name?: string;
/**
- * The field mask indicating the fields to update. If not set, all
- * modifiable fields will be modified.
+ * The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
*/
updateMask?: string;
@@ -2490,14 +2156,11 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The preferred language for localized application info, as a BCP47 tag
- * (e.g. "en-US", "de"). If not specified the default language of the
- * application will be used.
+ * The preferred language for localized application info, as a BCP47 tag (e.g. "en-US", "de"). If not specified the default language of the application will be used.
*/
languageCode?: string;
/**
- * The name of the application in the form
- * enterprises/{enterpriseId}/applications/{package_name}.
+ * The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}.
*/
name?: string;
}
@@ -2655,9 +2318,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.devices.issueCommand
- * @desc Issues a command to a device. The Operation resource returned
- * contains a Command in its metadata field. Use the get operation method to
- * get the status of the command.
+ * @desc Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command.
* @alias androidmanagement.enterprises.devices.issueCommand
* @memberOf! ()
*
@@ -2889,8 +2550,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the device in the form
- * enterprises/{enterpriseId}/devices/{deviceId}.
+ * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
/**
@@ -2906,8 +2566,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the device in the form
- * enterprises/{enterpriseId}/devices/{deviceId}.
+ * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
}
@@ -2919,8 +2578,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the device in the form
- * enterprises/{enterpriseId}/devices/{deviceId}.
+ * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
@@ -2937,8 +2595,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The requested page size. The actual page size may be fixed to a min or
- * max value.
+ * The requested page size. The actual page size may be fixed to a min or max value.
*/
pageSize?: number;
/**
@@ -2958,13 +2615,11 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the device in the form
- * enterprises/{enterpriseId}/devices/{deviceId}.
+ * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
/**
- * The field mask indicating the fields to update. If not set, all
- * modifiable fields will be modified.
+ * The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
*/
updateMask?: string;
@@ -2982,15 +2637,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.devices.operations.cancel
- * @desc Starts asynchronous cancellation on a long-running operation. The
- * server makes a best effort to cancel the operation, but success is not
- * guaranteed. If the server doesn't support this method, it returns
- * google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or
- * other methods to check whether the cancellation succeeded or whether the
- * operation completed despite cancellation. On successful cancellation, the
- * operation is not deleted; instead, it becomes an operation with an
- * Operation.error value with a google.rpc.Status.code of 1, corresponding
- * to Code.CANCELLED.
+ * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
* @alias androidmanagement.enterprises.devices.operations.cancel
* @memberOf! ()
*
@@ -3060,10 +2707,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.devices.operations.delete
- * @desc Deletes a long-running operation. This method indicates that the
- * client is no longer interested in the operation result. It does not
- * cancel the operation. If the server doesn't support this method, it
- * returns google.rpc.Code.UNIMPLEMENTED.
+ * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
* @alias androidmanagement.enterprises.devices.operations.delete
* @memberOf! ()
*
@@ -3133,9 +2777,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.devices.operations.get
- * @desc Gets the latest state of a long-running operation. Clients can use
- * this method to poll the operation result at intervals as recommended by
- * the API service.
+ * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias androidmanagement.enterprises.devices.operations.get
* @memberOf! ()
*
@@ -3207,15 +2849,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.devices.operations.list
- * @desc Lists operations that match the specified filter in the request. If
- * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE:
- * the name binding allows API services to override the binding to use
- * different resource name schemes, such as users/x/operations. To override
- * the binding, API services can add a binding such as
- * "/v1/{name=users/x}/operations" to their service configuration. For
- * backwards compatibility, the default name includes the operations
- * collection id, however overriding users must ensure the name binding is
- * the parent resource, without the operations collection id.
+ * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @alias androidmanagement.enterprises.devices.operations.list
* @memberOf! ()
*
@@ -3436,8 +3070,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.enrollmentTokens.delete
- * @desc Deletes an enrollment token. This operation invalidates the token,
- * preventing its future use.
+ * @desc Deletes an enrollment token. This operation invalidates the token, preventing its future use.
* @alias androidmanagement.enterprises.enrollmentTokens.delete
* @memberOf! ()
*
@@ -3531,8 +3164,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the enrollment token in the form
- * enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
+ * The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
*/
name?: string;
}
@@ -3545,8 +3177,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.policies.delete
- * @desc Deletes a policy. This operation is only permitted if no devices
- * are currently referencing the policy.
+ * @desc Deletes a policy. This operation is only permitted if no devices are currently referencing the policy.
* @alias androidmanagement.enterprises.policies.delete
* @memberOf! ()
*
@@ -3844,8 +3475,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the policy in the form
- * enterprises/{enterpriseId}/policies/{policyId}.
+ * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
*/
name?: string;
}
@@ -3857,8 +3487,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the policy in the form
- * enterprises/{enterpriseId}/policies/{policyId}.
+ * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
*/
name?: string;
}
@@ -3870,8 +3499,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The requested page size. The actual page size may be fixed to a min or
- * max value.
+ * The requested page size. The actual page size may be fixed to a min or max value.
*/
pageSize?: number;
/**
@@ -3891,13 +3519,11 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the policy in the form
- * enterprises/{enterpriseId}/policies/{policyId}.
+ * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
*/
name?: string;
/**
- * The field mask indicating the fields to update. If not set, all
- * modifiable fields will be modified.
+ * The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
*/
updateMask?: string;
@@ -4302,8 +3928,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the web app in the form
- * enterprises/{enterpriseId}/webApps/{packageName}.
+ * The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.
*/
name?: string;
}
@@ -4315,8 +3940,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the web app in the form
- * enterprises/{enterpriseId}/webApp/{packageName}.
+ * The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}.
*/
name?: string;
}
@@ -4328,8 +3952,7 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The requested page size. The actual page size may be fixed to a min or
- * max value.
+ * The requested page size. The actual page size may be fixed to a min or max value.
*/
pageSize?: number;
/**
@@ -4349,13 +3972,11 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The name of the web app in the form
- * enterprises/{enterpriseId}/webApps/{packageName}.
+ * The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.
*/
name?: string;
/**
- * The field mask indicating the fields to update. If not set, all
- * modifiable fields will be modified.
+ * The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
*/
updateMask?: string;
@@ -4373,8 +3994,7 @@ export namespace androidmanagement_v1 {
/**
* androidmanagement.enterprises.webTokens.create
- * @desc Creates a web token to access an embeddable managed Google Play web
- * UI for a given enterprise.
+ * @desc Creates a web token to access an embeddable managed Google Play web UI for a given enterprise.
* @alias androidmanagement.enterprises.webTokens.create
* @memberOf! ()
*
@@ -4553,17 +4173,11 @@ export namespace androidmanagement_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The callback URL that the admin will be redirected to after successfully
- * creating an enterprise. Before redirecting there the system will add a
- * query parameter to this URL named enterpriseToken which will contain an
- * opaque token to be used for the create enterprise request. The URL will
- * be parsed then reformatted in order to add the enterpriseToken parameter,
- * so there may be some minor formatting changes.
+ * The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes.
*/
callbackUrl?: string;
/**
- * The ID of the Google Cloud Platform project which will own the
- * enterprise.
+ * The ID of the Google Cloud Platform project which will own the enterprise.
*/
projectId?: string;
}
diff --git a/src/apis/androidpublisher/index.ts b/src/apis/androidpublisher/index.ts
index 808630ff53f..2e23842a03f 100644
--- a/src/apis/androidpublisher/index.ts
+++ b/src/apis/androidpublisher/index.ts
@@ -14,9 +14,8 @@
/*! THIS FILE IS AUTO-GENERATED */
import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common';
-
-import {androidpublisher_v1} from './v1';
import {androidpublisher_v1_1} from './v1.1';
+import {androidpublisher_v1} from './v1';
import {androidpublisher_v2} from './v2';
import {androidpublisher_v3} from './v3';
diff --git a/src/apis/androidpublisher/package.json b/src/apis/androidpublisher/package.json
index a215ce5438f..7a8f0f98b30 100644
--- a/src/apis/androidpublisher/package.json
+++ b/src/apis/androidpublisher/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/androidpublisher/v1.1.ts b/src/apis/androidpublisher/v1.1.ts
index 340440d47c2..2fc3d6c2429 100644
--- a/src/apis/androidpublisher/v1.1.ts
+++ b/src/apis/androidpublisher/v1.1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace androidpublisher_v1_1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace androidpublisher_v1_1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -96,7 +93,10 @@ export namespace androidpublisher_v1_1 {
purchases: Resource$Purchases;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.inapppurchases = new Resource$Inapppurchases(this.context);
this.purchases = new Resource$Purchases(this.context);
@@ -104,23 +104,19 @@ export namespace androidpublisher_v1_1 {
}
/**
- * An InappPurchase resource indicates the status of a user's inapp
- * product purchase.
+ * An InappPurchase resource indicates the status of a user's inapp product purchase.
*/
export interface Schema$InappPurchase {
/**
- * The consumption state of the inapp product. Possible values are: - Yet
- * to be consumed - Consumed
+ * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed
*/
consumptionState?: number;
/**
- * A developer-specified string that contains supplemental information about
- * an order.
+ * A developer-specified string that contains supplemental information about an order.
*/
developerPayload?: string;
/**
- * This kind represents an inappPurchase object in the androidpublisher
- * service.
+ * This kind represents an inappPurchase object in the androidpublisher service.
*/
kind?: string;
/**
@@ -128,47 +124,36 @@ export namespace androidpublisher_v1_1 {
*/
orderId?: string;
/**
- * The purchase state of the order. Possible values are: - Purchased -
- * Canceled
+ * The purchase state of the order. Possible values are: - Purchased - Canceled
*/
purchaseState?: number;
/**
- * The time the product was purchased, in milliseconds since the epoch (Jan
- * 1, 1970).
+ * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
*/
purchaseTime?: string;
/**
- * The type of purchase of the inapp product. This field is only set if this
- * purchase was not made using the standard in-app billing flow. Possible
- * values are: - Test (i.e. purchased from a license testing account) -
- * Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching
- * a video ad instead of paying)
+ * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying)
*/
purchaseType?: number;
}
/**
- * A SubscriptionPurchase resource indicates the status of a user's
- * subscription purchase.
+ * A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
*/
export interface Schema$SubscriptionPurchase {
/**
- * Whether the subscription will automatically be renewed when it reaches
- * its current expiry time.
+ * Whether the subscription will automatically be renewed when it reaches its current expiry time.
*/
autoRenewing?: boolean;
/**
- * Time at which the subscription was granted, in milliseconds since the
- * Epoch.
+ * Time at which the subscription was granted, in milliseconds since the Epoch.
*/
initiationTimestampMsec?: string;
/**
- * This kind represents a subscriptionPurchase object in the
- * androidpublisher service.
+ * This kind represents a subscriptionPurchase object in the androidpublisher service.
*/
kind?: string;
/**
- * Time at which the subscription will expire, in milliseconds since the
- * Epoch.
+ * Time at which the subscription will expire, in milliseconds since the Epoch.
*/
validUntilTimestampMsec?: string;
}
@@ -264,8 +249,7 @@ export namespace androidpublisher_v1_1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application the inapp product was sold in (for
- * example, 'com.some.thing').
+ * The package name of the application the inapp product was sold in (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -273,8 +257,7 @@ export namespace androidpublisher_v1_1 {
*/
productId?: string;
/**
- * The token provided to the user's device when the inapp product was
- * purchased.
+ * The token provided to the user's device when the inapp product was purchased.
*/
token?: string;
}
@@ -287,8 +270,7 @@ export namespace androidpublisher_v1_1 {
/**
* androidpublisher.purchases.cancel
- * @desc Cancels a user's subscription purchase. The subscription remains
- * valid until its expiration time.
+ * @desc Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
* @alias androidpublisher.purchases.cancel
* @memberOf! ()
*
@@ -361,8 +343,7 @@ export namespace androidpublisher_v1_1 {
/**
* androidpublisher.purchases.get
- * @desc Checks whether a user's subscription purchase is valid and returns
- * its expiry time.
+ * @desc Checks whether a user's subscription purchase is valid and returns its expiry time.
* @alias androidpublisher.purchases.get
* @memberOf! ()
*
@@ -445,8 +426,7 @@ export namespace androidpublisher_v1_1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -454,8 +434,7 @@ export namespace androidpublisher_v1_1 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -466,8 +445,7 @@ export namespace androidpublisher_v1_1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -475,8 +453,7 @@ export namespace androidpublisher_v1_1 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
diff --git a/src/apis/androidpublisher/v1.ts b/src/apis/androidpublisher/v1.ts
index de9dd89a2ce..e2c22195760 100644
--- a/src/apis/androidpublisher/v1.ts
+++ b/src/apis/androidpublisher/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace androidpublisher_v1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace androidpublisher_v1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -95,35 +92,33 @@ export namespace androidpublisher_v1 {
purchases: Resource$Purchases;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.purchases = new Resource$Purchases(this.context);
}
}
/**
- * A SubscriptionPurchase resource indicates the status of a user's
- * subscription purchase.
+ * A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
*/
export interface Schema$SubscriptionPurchase {
/**
- * Whether the subscription will automatically be renewed when it reaches
- * its current expiry time.
+ * Whether the subscription will automatically be renewed when it reaches its current expiry time.
*/
autoRenewing?: boolean;
/**
- * Time at which the subscription was granted, in milliseconds since the
- * Epoch.
+ * Time at which the subscription was granted, in milliseconds since the Epoch.
*/
initiationTimestampMsec?: string;
/**
- * This kind represents a subscriptionPurchase object in the
- * androidpublisher service.
+ * This kind represents a subscriptionPurchase object in the androidpublisher service.
*/
kind?: string;
/**
- * Time at which the subscription will expire, in milliseconds since the
- * Epoch.
+ * Time at which the subscription will expire, in milliseconds since the Epoch.
*/
validUntilTimestampMsec?: string;
}
@@ -136,8 +131,7 @@ export namespace androidpublisher_v1 {
/**
* androidpublisher.purchases.cancel
- * @desc Cancels a user's subscription purchase. The subscription remains
- * valid until its expiration time.
+ * @desc Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
* @alias androidpublisher.purchases.cancel
* @memberOf! ()
*
@@ -210,8 +204,7 @@ export namespace androidpublisher_v1 {
/**
* androidpublisher.purchases.get
- * @desc Checks whether a user's subscription purchase is valid and returns
- * its expiry time.
+ * @desc Checks whether a user's subscription purchase is valid and returns its expiry time.
* @alias androidpublisher.purchases.get
* @memberOf! ()
*
@@ -294,8 +287,7 @@ export namespace androidpublisher_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -303,8 +295,7 @@ export namespace androidpublisher_v1 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -315,8 +306,7 @@ export namespace androidpublisher_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -324,8 +314,7 @@ export namespace androidpublisher_v1 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts
index a2f2f08c847..26c85fe2d03 100644
--- a/src/apis/androidpublisher/v2.ts
+++ b/src/apis/androidpublisher/v2.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace androidpublisher_v2 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace androidpublisher_v2 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -99,7 +96,10 @@ export namespace androidpublisher_v2 {
reviews: Resource$Reviews;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.edits = new Resource$Edits(this.context);
this.inappproducts = new Resource$Inappproducts(this.context);
@@ -124,13 +124,11 @@ export namespace androidpublisher_v2 {
*/
export interface Schema$ApkBinary {
/**
- * A sha1 hash of the APK payload, encoded as a hex string and matching the
- * output of the sha1sum command.
+ * A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.
*/
sha1?: string;
/**
- * A sha256 hash of the APK payload, encoded as a hex string and matching
- * the output of the sha256sum command.
+ * A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command.
*/
sha256?: string;
}
@@ -146,8 +144,7 @@ export namespace androidpublisher_v2 {
}
export interface Schema$ApkListingsListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#apkListingsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apkListingsListResponse".
*/
kind?: string;
listings?: Schema$ApkListing[];
@@ -167,8 +164,7 @@ export namespace androidpublisher_v2 {
export interface Schema$ApksListResponse {
apks?: Schema$Apk[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#apksListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse".
*/
kind?: string;
}
@@ -191,13 +187,11 @@ export namespace androidpublisher_v2 {
defaultLanguage?: string;
}
/**
- * Represents an edit of an app. An edit allows clients to make multiple
- * changes before committing them in one operation.
+ * Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
*/
export interface Schema$AppEdit {
/**
- * The time at which the edit will expire and will be no longer valid for
- * use in any subsequent API calls (encoded as seconds since the Epoch).
+ * The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
*/
expiryTimeSeconds?: string;
/**
@@ -207,26 +201,22 @@ export namespace androidpublisher_v2 {
}
export interface Schema$Bundle {
/**
- * A sha1 hash of the upload payload, encoded as a hex string and matching
- * the output of the sha1sum command.
+ * A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command.
*/
sha1?: string;
/**
- * A sha256 hash of the upload payload, encoded as a hex string and matching
- * the output of the sha256sum command.
+ * A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command.
*/
sha256?: string;
/**
- * The version code of the Android App Bundle. As specified in the Android
- * App Bundle's base module APK manifest file.
+ * The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file.
*/
versionCode?: number;
}
export interface Schema$BundlesListResponse {
bundles?: Schema$Bundle[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#bundlesListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#bundlesListResponse".
*/
kind?: string;
}
@@ -284,8 +274,7 @@ export namespace androidpublisher_v2 {
*/
manufacturer?: string;
/**
- * Comma separated list of native platforms (e.g. "arm",
- * "arm7")
+ * Comma separated list of native platforms (e.g. "arm", "arm7")
*/
nativePlatform?: string;
/**
@@ -311,14 +300,11 @@ export namespace androidpublisher_v2 {
}
export interface Schema$ExpansionFile {
/**
- * If set this field indicates that this APK has an Expansion File uploaded
- * to it: this APK does not reference another APK's Expansion File. The
- * field's value is the size of the uploaded Expansion File in bytes.
+ * If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.
*/
fileSize?: string;
/**
- * If set this APK's Expansion File references another APK's
- * Expansion File. The file_size field will not be set.
+ * If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.
*/
referencesVersion?: number;
}
@@ -326,10 +312,7 @@ export namespace androidpublisher_v2 {
expansionFile?: Schema$ExpansionFile;
}
/**
- * Defines an APK available for this application that is hosted externally and
- * not uploaded to Google Play. This function is only available to enterprises
- * who are using Google Play for Work, and whos application is restricted to
- * the enterprise private channel
+ * Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel
*/
export interface Schema$ExternallyHostedApk {
/**
@@ -337,8 +320,7 @@ export namespace androidpublisher_v2 {
*/
applicationLabel?: string;
/**
- * A certificate (or array of certificates if a certificate-chain is used)
- * used to signed this APK, represented as a base64 encoded byte array.
+ * A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.
*/
certificateBase64s?: string[];
/**
@@ -346,13 +328,11 @@ export namespace androidpublisher_v2 {
*/
externallyHostedUrl?: string;
/**
- * The SHA1 checksum of this APK, represented as a base64 encoded byte
- * array.
+ * The SHA1 checksum of this APK, represented as a base64 encoded byte array.
*/
fileSha1Base64?: string;
/**
- * The SHA256 checksum of this APK, represented as a base64 encoded byte
- * array.
+ * The SHA256 checksum of this APK, represented as a base64 encoded byte array.
*/
fileSha256Base64?: string;
/**
@@ -434,20 +414,15 @@ export namespace androidpublisher_v2 {
}
export interface Schema$InAppProduct {
/**
- * The default language of the localized data, as defined by BCP 47. e.g.
- * "en-US", "en-GB".
+ * The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
*/
defaultLanguage?: string;
/**
- * Default price cannot be zero. In-app products can never be free. Default
- * price is always in the developer's Checkout merchant currency.
+ * Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
*/
defaultPrice?: Schema$Price;
/**
- * Grace period of the subscription, specified in ISO 8601 format. It will
- * allow developers to give their subscribers a grace period when the
- * payment for the new recurrence period is declined. Acceptable values =
- * "P3D" (three days) and "P7D" (seven days)
+ * Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
*/
gracePeriod?: string;
/**
@@ -459,8 +434,7 @@ export namespace androidpublisher_v2 {
*/
packageName?: string;
/**
- * Prices per buyer region. None of these prices should be zero. In-app
- * products can never be free.
+ * Prices per buyer region. None of these prices should be zero. In-app products can never be free.
*/
prices?: {[key: string]: Schema$Price};
/**
@@ -468,8 +442,7 @@ export namespace androidpublisher_v2 {
*/
purchaseType?: string;
/**
- * Definition of a season for a seasonal subscription. Can be defined only
- * for yearly subscriptions.
+ * Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
*/
season?: Schema$Season;
/**
@@ -478,16 +451,11 @@ export namespace androidpublisher_v2 {
sku?: string;
status?: string;
/**
- * Subscription period, specified in ISO 8601 format. Acceptable values are
- * "P1W" (one week), "P1M" (one month), "P3M"
- * (three months), "P6M" (six months), and "P1Y" (one
- * year).
+ * Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
*/
subscriptionPeriod?: string;
/**
- * Trial period, specified in ISO 8601 format. Acceptable values are
- * anything between "P7D" (seven days) and "P999D" (999
- * days). Seasonal subscriptions cannot have a trial period.
+ * Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
*/
trialPeriod?: string;
}
@@ -498,8 +466,7 @@ export namespace androidpublisher_v2 {
export interface Schema$InappproductsListResponse {
inappproduct?: Schema$InAppProduct[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#inappproductsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse".
*/
kind?: string;
pageInfo?: Schema$PageInfo;
@@ -511,13 +478,11 @@ export namespace androidpublisher_v2 {
*/
fullDescription?: string;
/**
- * Language localization code (for example, "de-AT" for Austrian
- * German).
+ * Language localization code (for example, "de-AT" for Austrian German).
*/
language?: string;
/**
- * Short description of the app (previously known as promo text); this may
- * be up to 80 characters in length.
+ * Short description of the app (previously known as promo text); this may be up to 80 characters in length.
*/
shortDescription?: string;
/**
@@ -531,16 +496,14 @@ export namespace androidpublisher_v2 {
}
export interface Schema$ListingsListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#listingsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#listingsListResponse".
*/
kind?: string;
listings?: Schema$Listing[];
}
export interface Schema$MonthDay {
/**
- * Day of a month, value in [1, 31] range. Valid range depends on the
- * specified month.
+ * Day of a month, value in [1, 31] range. Valid range depends on the specified month.
*/
day?: number;
/**
@@ -559,29 +522,24 @@ export namespace androidpublisher_v2 {
*/
currency?: string;
/**
- * The price in millionths of the currency base unit represented as a
- * string.
+ * The price in millionths of the currency base unit represented as a string.
*/
priceMicros?: string;
}
/**
- * A ProductPurchase resource indicates the status of a user's inapp
- * product purchase.
+ * A ProductPurchase resource indicates the status of a user's inapp product purchase.
*/
export interface Schema$ProductPurchase {
/**
- * The consumption state of the inapp product. Possible values are: - Yet
- * to be consumed - Consumed
+ * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed
*/
consumptionState?: number;
/**
- * A developer-specified string that contains supplemental information about
- * an order.
+ * A developer-specified string that contains supplemental information about an order.
*/
developerPayload?: string;
/**
- * This kind represents an inappPurchase object in the androidpublisher
- * service.
+ * This kind represents an inappPurchase object in the androidpublisher service.
*/
kind?: string;
/**
@@ -589,30 +547,21 @@ export namespace androidpublisher_v2 {
*/
orderId?: string;
/**
- * The purchase state of the order. Possible values are: - Purchased -
- * Canceled
+ * The purchase state of the order. Possible values are: - Purchased - Canceled
*/
purchaseState?: number;
/**
- * The time the product was purchased, in milliseconds since the epoch (Jan
- * 1, 1970).
+ * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
*/
purchaseTimeMillis?: string;
/**
- * The type of purchase of the inapp product. This field is only set if this
- * purchase was not made using the standard in-app billing flow. Possible
- * values are: - Test (i.e. purchased from a license testing account) -
- * Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching
- * a video ad instead of paying)
+ * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying)
*/
purchaseType?: number;
}
export interface Schema$Prorate {
/**
- * Default price cannot be zero and must be less than the full subscription
- * price. Default price is always in the developer's Checkout merchant
- * currency. Targeted countries have their prices set automatically based on
- * the default_price.
+ * Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
*/
defaultPrice?: Schema$Price;
/**
@@ -651,8 +600,7 @@ export namespace androidpublisher_v2 {
}
export interface Schema$ReviewsReplyRequest {
/**
- * The text to set as the reply. Replies of more than approximately 350
- * characters will be rejected. HTML tags will be stripped.
+ * The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.
*/
replyText?: string;
}
@@ -665,10 +613,7 @@ export namespace androidpublisher_v2 {
*/
end?: Schema$MonthDay;
/**
- * Optionally present list of prorations for the season. Each proration is a
- * one-off discounted entry into a subscription. Each proration contains the
- * first date on which the discount is available and the new pricing
- * information.
+ * Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
*/
prorations?: Schema$Prorate[];
/**
@@ -677,189 +622,130 @@ export namespace androidpublisher_v2 {
start?: Schema$MonthDay;
}
/**
- * Information provided by the user when they complete the subscription
- * cancellation flow (cancellation reason survey).
+ * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).
*/
export interface Schema$SubscriptionCancelSurveyResult {
/**
- * The cancellation reason the user chose in the survey. Possible values
- * are: - Other - I don't use this service enough - Technical issues
- * - Cost-related reasons - I found a better app
+ * The cancellation reason the user chose in the survey. Possible values are: - Other - I don't use this service enough - Technical issues - Cost-related reasons - I found a better app
*/
cancelSurveyReason?: number;
/**
- * The customized input cancel reason from the user. Only present when
- * cancelReason is 0.
+ * The customized input cancel reason from the user. Only present when cancelReason is 0.
*/
userInputCancelReason?: string;
}
/**
- * A SubscriptionDeferralInfo contains the data needed to defer a subscription
- * purchase to a future expiry time.
+ * A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.
*/
export interface Schema$SubscriptionDeferralInfo {
/**
- * The desired next expiry time to assign to the subscription, in
- * milliseconds since the Epoch. The given time must be later/greater than
- * the current expiry time for the subscription.
+ * The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription.
*/
desiredExpiryTimeMillis?: string;
/**
- * The expected expiry time for the subscription. If the current expiry time
- * for the subscription is not the value specified here, the deferral will
- * not occur.
+ * The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur.
*/
expectedExpiryTimeMillis?: string;
}
/**
- * Contains the price change information for a subscription that can be used
- * to control the user journey for the price change in the app. This can be in
- * the form of seeking confirmation from the user or tailoring the experience
- * for a successful conversion.
+ * Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion.
*/
export interface Schema$SubscriptionPriceChange {
/**
- * The new price the subscription will renew with if the price change is
- * accepted by the user.
+ * The new price the subscription will renew with if the price change is accepted by the user.
*/
newPrice?: Schema$Price;
/**
- * The current state of the price change. Possible values are: -
- * Outstanding: State for a pending price change waiting for the user to
- * agree. In this state, you can optionally seek confirmation from the user
- * using the In-App API. - Accepted: State for an accepted price change
- * that the subscription will renew with unless it's canceled. The price
- * change takes effect on a future date when the subscription renews. Note
- * that the change might not occur when the subscription is renewed next.
+ * The current state of the price change. Possible values are: - Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. - Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next.
*/
state?: number;
}
/**
- * A SubscriptionPurchase resource indicates the status of a user's
- * subscription purchase.
+ * A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
*/
export interface Schema$SubscriptionPurchase {
/**
- * Whether the subscription will automatically be renewed when it reaches
- * its current expiry time.
+ * Whether the subscription will automatically be renewed when it reaches its current expiry time.
*/
autoRenewing?: boolean;
/**
- * The reason why a subscription was canceled or is not auto-renewing.
- * Possible values are: - User canceled the subscription - Subscription
- * was canceled by the system, for example because of a billing problem -
- * Subscription was replaced with a new subscription - Subscription was
- * canceled by the developer
+ * The reason why a subscription was canceled or is not auto-renewing. Possible values are: - User canceled the subscription - Subscription was canceled by the system, for example because of a billing problem - Subscription was replaced with a new subscription - Subscription was canceled by the developer
*/
cancelReason?: number;
/**
- * Information provided by the user when they complete the subscription
- * cancellation flow (cancellation reason survey).
+ * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).
*/
cancelSurveyResult?: Schema$SubscriptionCancelSurveyResult;
/**
- * ISO 3166-1 alpha-2 billing country/region code of the user at the time
- * the subscription was granted.
+ * ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.
*/
countryCode?: string;
/**
- * A developer-specified string that contains supplemental information about
- * an order.
+ * A developer-specified string that contains supplemental information about an order.
*/
developerPayload?: string;
/**
- * The email address of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
emailAddress?: string;
/**
- * Time at which the subscription will expire, in milliseconds since the
- * Epoch.
+ * Time at which the subscription will expire, in milliseconds since the Epoch.
*/
expiryTimeMillis?: string;
/**
- * The family name of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
familyName?: string;
/**
- * The given name of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
givenName?: string;
/**
- * This kind represents a subscriptionPurchase object in the
- * androidpublisher service.
+ * This kind represents a subscriptionPurchase object in the androidpublisher service.
*/
kind?: string;
/**
- * The purchase token of the originating purchase if this subscription is
- * one of the following: - Re-signup of a canceled but non-lapsed
- * subscription - Upgrade/downgrade from a previous subscription For
- * example, suppose a user originally signs up and you receive purchase
- * token X, then the user cancels and goes through the resignup flow (before
- * their subscription lapses) and you receive purchase token Y, and finally
- * the user upgrades their subscription and you receive purchase token Z. If
- * you call this API with purchase token Z, this field will be set to Y. If
- * you call this API with purchase token Y, this field will be set to X. If
- * you call this API with purchase token X, this field will not be set.
+ * The purchase token of the originating purchase if this subscription is one of the following: - Re-signup of a canceled but non-lapsed subscription - Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set.
*/
linkedPurchaseToken?: string;
/**
- * The order id of the latest recurring order associated with the purchase
- * of the subscription.
+ * The order id of the latest recurring order associated with the purchase of the subscription.
*/
orderId?: string;
/**
- * The payment state of the subscription. Possible values are: - Payment
- * pending - Payment received - Free trial - Pending deferred
- * upgrade/downgrade
+ * The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade
*/
paymentState?: number;
/**
- * Price of the subscription, not including tax. Price is expressed in
- * micro-units, where 1,000,000 micro-units represents one unit of the
- * currency. For example, if the subscription price is €1.99,
- * price_amount_micros is 1990000.
+ * Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.
*/
priceAmountMicros?: string;
/**
- * The latest price change information available. This is present only when
- * there is an upcoming price change for the subscription yet to be applied.
- * Once the subscription renews with the new price or the subscription is
- * canceled, no price change information will be returned.
+ * The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned.
*/
priceChange?: Schema$SubscriptionPriceChange;
/**
- * ISO 4217 currency code for the subscription price. For example, if the
- * price is specified in British pounds sterling, price_currency_code is
- * "GBP".
+ * ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".
*/
priceCurrencyCode?: string;
/**
- * The profile id of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
profileId?: string;
/**
- * The profile name of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
profileName?: string;
/**
- * The type of purchase of the subscription. This field is only set if this
- * purchase was not made using the standard in-app billing flow. Possible
- * values are: - Test (i.e. purchased from a license testing account)
+ * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account)
*/
purchaseType?: number;
/**
- * Time at which the subscription was granted, in milliseconds since the
- * Epoch.
+ * Time at which the subscription was granted, in milliseconds since the Epoch.
*/
startTimeMillis?: string;
/**
- * The time at which the subscription was canceled by the user, in
- * milliseconds since the epoch. Only present if cancelReason is 0.
+ * The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.
*/
userCancellationTimeMillis?: string;
}
@@ -894,39 +780,32 @@ export namespace androidpublisher_v2 {
track?: string;
userFraction?: number;
/**
- * Version codes to make active on this track. Note that this list should
- * contain all versions you wish to be active, including those you wish to
- * retain from previous releases.
+ * Version codes to make active on this track. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases.
*/
versionCodes?: number[];
}
export interface Schema$TracksListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#tracksListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse".
*/
kind?: string;
tracks?: Schema$Track[];
}
export interface Schema$UserComment {
/**
- * Integer Android SDK version of the user's device at the time the
- * review was written, e.g. 23 is Marshmallow. May be absent.
+ * Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
*/
androidOsVersion?: number;
/**
- * Integer version code of the app as installed at the time the review was
- * written. May be absent.
+ * Integer version code of the app as installed at the time the review was written. May be absent.
*/
appVersionCode?: number;
/**
- * String version name of the app as installed at the time the review was
- * written. May be absent.
+ * String version name of the app as installed at the time the review was written. May be absent.
*/
appVersionName?: string;
/**
- * Codename for the reviewer's device, e.g. klte, flounder. May be
- * absent.
+ * Codename for the reviewer's device, e.g. klte, flounder. May be absent.
*/
device?: string;
/**
@@ -938,14 +817,11 @@ export namespace androidpublisher_v2 {
*/
lastModified?: Schema$Timestamp;
/**
- * Untranslated text of the review, in the case where the review has been
- * translated. If the review has not been translated this is left blank.
+ * Untranslated text of the review, in the case where the review has been translated. If the review has not been translated this is left blank.
*/
originalText?: string;
/**
- * Language code for the reviewer. This is taken from the device settings so
- * is not guaranteed to match the language the review is written in. May be
- * absent.
+ * Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent.
*/
reviewerLanguage?: string;
/**
@@ -953,9 +829,7 @@ export namespace androidpublisher_v2 {
*/
starRating?: number;
/**
- * The content of the comment, i.e. review body. In some cases users have
- * been able to write a review with separate title and body; in those cases
- * the title and body are concatenated and separated by a tab character.
+ * The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character.
*/
text?: string;
/**
@@ -968,28 +842,23 @@ export namespace androidpublisher_v2 {
thumbsUpCount?: number;
}
/**
- * A VoidedPurchase resource indicates a purchase that was either
- * canceled/refunded/charged-back.
+ * A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.
*/
export interface Schema$VoidedPurchase {
/**
- * This kind represents a voided purchase object in the androidpublisher
- * service.
+ * This kind represents a voided purchase object in the androidpublisher service.
*/
kind?: string;
/**
- * The time at which the purchase was made, in milliseconds since the epoch
- * (Jan 1, 1970).
+ * The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).
*/
purchaseTimeMillis?: string;
/**
- * The token that was generated when a purchase was made. This uniquely
- * identifies a purchase.
+ * The token that was generated when a purchase was made. This uniquely identifies a purchase.
*/
purchaseToken?: string;
/**
- * The time at which the purchase was canceled/refunded/charged-back, in
- * milliseconds since the epoch (Jan 1, 1970).
+ * The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).
*/
voidedTimeMillis?: string;
}
@@ -1101,9 +970,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.delete
- * @desc Deletes an edit for an app. Creating a new edit will automatically
- * delete any of your previous edits so this method need only be called if
- * you want to preemptively abandon an edit.
+ * @desc Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.
* @alias androidpublisher.edits.delete
* @memberOf! ()
*
@@ -1175,9 +1042,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.get
- * @desc Returns information about the edit specified. Calls will fail if
- * the edit is no long active (e.g. has been deleted, superseded or
- * expired).
+ * @desc Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).
* @alias androidpublisher.edits.get
* @memberOf! ()
*
@@ -1249,8 +1114,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.insert
- * @desc Creates a new edit for an app, populated with the app's current
- * state.
+ * @desc Creates a new edit for an app, populated with the app's current state.
* @alias androidpublisher.edits.insert
* @memberOf! ()
*
@@ -1321,8 +1185,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.validate
- * @desc Checks that the edit can be successfully committed. The edit's
- * changes are not applied to the live app.
+ * @desc Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.
* @alias androidpublisher.edits.validate
* @memberOf! ()
*
@@ -1404,8 +1267,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1420,8 +1282,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1436,8 +1297,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1448,8 +1308,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -1469,8 +1328,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1483,8 +1341,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.apklistings.delete
- * @desc Deletes the APK-specific localized listing for a specified APK and
- * language code.
+ * @desc Deletes the APK-specific localized listing for a specified APK and language code.
* @alias androidpublisher.edits.apklistings.delete
* @memberOf! ()
*
@@ -1559,8 +1416,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.apklistings.deleteall
- * @desc Deletes all the APK-specific localized listings for a specified
- * APK.
+ * @desc Deletes all the APK-specific localized listings for a specified APK.
* @alias androidpublisher.edits.apklistings.deleteall
* @memberOf! ()
*
@@ -1634,8 +1490,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.apklistings.get
- * @desc Fetches the APK-specific localized listing for a specified APK and
- * language code.
+ * @desc Fetches the APK-specific localized listing for a specified APK and language code.
* @alias androidpublisher.edits.apklistings.get
* @memberOf! ()
*
@@ -1790,8 +1645,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.apklistings.patch
- * @desc Updates or creates the APK-specific localized listing for a
- * specified APK and language code. This method supports patch semantics.
+ * @desc Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.
* @alias androidpublisher.edits.apklistings.patch
* @memberOf! ()
*
@@ -1869,8 +1723,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.apklistings.update
- * @desc Updates or creates the APK-specific localized listing for a
- * specified APK and language code.
+ * @desc Updates or creates the APK-specific localized listing for a specified APK and language code.
* @alias androidpublisher.edits.apklistings.update
* @memberOf! ()
*
@@ -1955,8 +1808,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The APK version code whose APK-specific listings should be read or
- * modified.
+ * The APK version code whose APK-specific listings should be read or modified.
*/
apkVersionCode?: number;
/**
@@ -1964,14 +1816,11 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the APK-specific localized
- * listing to read or modify. For example, to select Austrian German, pass
- * "de-AT".
+ * The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1983,8 +1832,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The APK version code whose APK-specific listings should be read or
- * modified.
+ * The APK version code whose APK-specific listings should be read or modified.
*/
apkVersionCode?: number;
/**
@@ -1992,8 +1840,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -2005,8 +1852,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The APK version code whose APK-specific listings should be read or
- * modified.
+ * The APK version code whose APK-specific listings should be read or modified.
*/
apkVersionCode?: number;
/**
@@ -2014,14 +1860,11 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the APK-specific localized
- * listing to read or modify. For example, to select Austrian German, pass
- * "de-AT".
+ * The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -2033,8 +1876,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The APK version code whose APK-specific listings should be read or
- * modified.
+ * The APK version code whose APK-specific listings should be read or modified.
*/
apkVersionCode?: number;
/**
@@ -2042,8 +1884,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -2055,8 +1896,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The APK version code whose APK-specific listings should be read or
- * modified.
+ * The APK version code whose APK-specific listings should be read or modified.
*/
apkVersionCode?: number;
/**
@@ -2064,14 +1904,11 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the APK-specific localized
- * listing to read or modify. For example, to select Austrian German, pass
- * "de-AT".
+ * The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2088,8 +1925,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The APK version code whose APK-specific listings should be read or
- * modified.
+ * The APK version code whose APK-specific listings should be read or modified.
*/
apkVersionCode?: number;
/**
@@ -2097,14 +1933,11 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the APK-specific localized
- * listing to read or modify. For example, to select Austrian German, pass
- * "de-AT".
+ * The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2122,10 +1955,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.apks.addexternallyhosted
- * @desc Creates a new APK without uploading the APK itself to Google Play,
- * instead hosting the APK at a specified URL. This function is only
- * available to enterprises using Google Play for Work whose application is
- * configured to restrict distribution to the enterprise domain.
+ * @desc Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.
* @alias androidpublisher.edits.apks.addexternallyhosted
* @memberOf! ()
*
@@ -2373,8 +2203,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2394,8 +2223,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -2411,8 +2239,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2514,12 +2341,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.bundles.upload
- * @desc Uploads a new Android App Bundle to this edit. If you are using the
- * Google API client libraries, please increase the timeout of the http
- * request before calling this endpoint (a timeout of 2 minutes is
- * recommended). See:
- * https://developers.google.com/api-client-library/java/google-api-java-client/errors
- * for an example in java.
+ * @desc Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.
* @alias androidpublisher.edits.bundles.upload
* @memberOf! ()
*
@@ -2611,8 +2433,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -2624,9 +2445,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Must be set to true if the bundle installation may trigger a warning on
- * user devices (for example, if installation size may be over a threshold,
- * typically 100 MB).
+ * Must be set to true if the bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB).
*/
ackBundleInstallationWarning?: boolean;
/**
@@ -2634,8 +2453,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2663,8 +2481,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.deobfuscationfiles.upload
- * @desc Uploads the deobfuscation file of the specified APK. If a
- * deobfuscation file already exists, it will be replaced.
+ * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.
* @alias androidpublisher.edits.deobfuscationfiles.upload
* @memberOf! ()
*
@@ -2786,8 +2603,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier of the Android app for which the deobfuscatiuon files
- * are being uploaded; for example, "com.spiffygame".
+ * Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2815,8 +2631,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.details.get
- * @desc Fetches app details for this edit. This includes the default
- * language and developer support contact information.
+ * @desc Fetches app details for this edit. This includes the default language and developer support contact information.
* @alias androidpublisher.edits.details.get
* @memberOf! ()
*
@@ -2891,8 +2706,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.details.patch
- * @desc Updates app details for this edit. This method supports patch
- * semantics.
+ * @desc Updates app details for this edit. This method supports patch semantics.
* @alias androidpublisher.edits.details.patch
* @memberOf! ()
*
@@ -3055,8 +2869,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3072,8 +2885,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -3094,8 +2906,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -3200,9 +3011,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.expansionfiles.patch
- * @desc Updates the APK's Expansion File configuration to reference another
- * APK's Expansion Files. To add a new Expansion File use the Upload method.
- * This method supports patch semantics.
+ * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.
* @alias androidpublisher.edits.expansionfiles.patch
* @memberOf! ()
*
@@ -3290,8 +3099,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.expansionfiles.update
- * @desc Updates the APK's Expansion File configuration to reference another
- * APK's Expansion Files. To add a new Expansion File use the Upload method.
+ * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.
* @alias androidpublisher.edits.expansionfiles.update
* @memberOf! ()
*
@@ -3489,8 +3297,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version code of the APK whose Expansion File configuration is being
- * read or modified.
+ * The version code of the APK whose Expansion File configuration is being read or modified.
*/
apkVersionCode?: number;
/**
@@ -3502,8 +3309,7 @@ export namespace androidpublisher_v2 {
*/
expansionFileType?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3515,8 +3321,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version code of the APK whose Expansion File configuration is being
- * read or modified.
+ * The version code of the APK whose Expansion File configuration is being read or modified.
*/
apkVersionCode?: number;
/**
@@ -3528,8 +3333,7 @@ export namespace androidpublisher_v2 {
*/
expansionFileType?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -3546,8 +3350,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version code of the APK whose Expansion File configuration is being
- * read or modified.
+ * The version code of the APK whose Expansion File configuration is being read or modified.
*/
apkVersionCode?: number;
/**
@@ -3559,8 +3362,7 @@ export namespace androidpublisher_v2 {
*/
expansionFileType?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -3577,8 +3379,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version code of the APK whose Expansion File configuration is being
- * read or modified.
+ * The version code of the APK whose Expansion File configuration is being read or modified.
*/
apkVersionCode?: number;
/**
@@ -3590,8 +3391,7 @@ export namespace androidpublisher_v2 {
*/
expansionFileType?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -3865,8 +3665,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.images.upload
- * @desc Uploads a new image and adds it to the list of images for the
- * specified language and image type.
+ * @desc Uploads a new image and adds it to the list of images for the specified language and image type.
* @alias androidpublisher.edits.images.upload
* @memberOf! ()
*
@@ -3963,8 +3762,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier an image within the set of images attached to this
- * edit.
+ * Unique identifier an image within the set of images attached to this edit.
*/
imageId?: string;
/**
@@ -3972,14 +3770,11 @@ export namespace androidpublisher_v2 {
*/
imageType?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing whose
- * images are to read or modified. For example, to select Austrian German,
- * pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3999,14 +3794,11 @@ export namespace androidpublisher_v2 {
*/
imageType?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing whose
- * images are to read or modified. For example, to select Austrian German,
- * pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -4026,14 +3818,11 @@ export namespace androidpublisher_v2 {
*/
imageType?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing whose
- * images are to read or modified. For example, to select Austrian German,
- * pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -4053,14 +3842,11 @@ export namespace androidpublisher_v2 {
*/
imageType?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing whose
- * images are to read or modified. For example, to select Austrian German,
- * pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -4386,8 +4172,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.listings.patch
- * @desc Creates or updates a localized store listing. This method supports
- * patch semantics.
+ * @desc Creates or updates a localized store listing. This method supports patch semantics.
* @alias androidpublisher.edits.listings.patch
* @memberOf! ()
*
@@ -4548,13 +4333,11 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing to
- * read or modify. For example, to select Austrian German, pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -4570,8 +4353,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -4587,13 +4369,11 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing to
- * read or modify. For example, to select Austrian German, pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -4609,8 +4389,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -4626,13 +4405,11 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing to
- * read or modify. For example, to select Austrian German, pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -4653,13 +4430,11 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing to
- * read or modify. For example, to select Austrian German, pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -4909,8 +4684,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4930,8 +4704,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4956,8 +4729,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4979,8 +4751,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.tracks.get
- * @desc Fetches the track configuration for the specified track type.
- * Includes the APK version codes that are in this track.
+ * @desc Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.
* @alias androidpublisher.edits.tracks.get
* @memberOf! ()
*
@@ -5128,8 +4899,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.edits.tracks.patch
- * @desc Updates the track configuration for the specified track type. This
- * method supports patch semantics.
+ * @desc Updates the track configuration for the specified track type. This method supports patch semantics.
* @alias androidpublisher.edits.tracks.patch
* @memberOf! ()
*
@@ -5289,8 +5059,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5310,8 +5079,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -5327,8 +5095,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5353,8 +5120,7 @@ export namespace androidpublisher_v2 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5600,8 +5366,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.inappproducts.list
- * @desc List all the in-app products for an Android app, both subscriptions
- * and managed in-app products..
+ * @desc List all the in-app products for an Android app, both subscriptions and managed in-app products..
* @alias androidpublisher.inappproducts.list
* @memberOf! ()
*
@@ -5685,8 +5450,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.inappproducts.patch
- * @desc Updates the details of an in-app product. This method supports
- * patch semantics.
+ * @desc Updates the details of an in-app product. This method supports patch semantics.
* @alias androidpublisher.inappproducts.patch
* @memberOf! ()
*
@@ -5847,8 +5611,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique identifier for the Android app with the in-app product; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5880,9 +5643,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * If true the prices for all regions targeted by the parent app that don't
- * have a price specified for this in-app product will be auto converted to
- * the target currency based on the default price. Defaults to false.
+ * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
*/
autoConvertMissingPrices?: boolean;
/**
@@ -5907,8 +5668,7 @@ export namespace androidpublisher_v2 {
*/
maxResults?: number;
/**
- * Unique identifier for the Android app with in-app products; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app with in-app products; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5928,14 +5688,11 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * If true the prices for all regions targeted by the parent app that don't
- * have a price specified for this in-app product will be auto converted to
- * the target currency based on the default price. Defaults to false.
+ * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
*/
autoConvertMissingPrices?: boolean;
/**
- * Unique identifier for the Android app with the in-app product; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5956,14 +5713,11 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * If true the prices for all regions targeted by the parent app that don't
- * have a price specified for this in-app product will be auto converted to
- * the target currency based on the default price. Defaults to false.
+ * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
*/
autoConvertMissingPrices?: boolean;
/**
- * Unique identifier for the Android app with the in-app product; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -6064,20 +5818,15 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The order ID provided to the user when the subscription or in-app order
- * was purchased.
+ * The order ID provided to the user when the subscription or in-app order was purchased.
*/
orderId?: string;
/**
- * The package name of the application for which this subscription or in-app
- * item was purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
- * Whether to revoke the purchased item. If set to true, access to the
- * subscription or in-app item will be terminated immediately. If the item
- * is a recurring subscription, all future payments will also be terminated.
- * Consumed in-app items need to be handled by developer's app. (optional)
+ * Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional)
*/
revoke?: boolean;
}
@@ -6188,8 +5937,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application the inapp product was sold in (for
- * example, 'com.some.thing').
+ * The package name of the application the inapp product was sold in (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6197,8 +5945,7 @@ export namespace androidpublisher_v2 {
*/
productId?: string;
/**
- * The token provided to the user's device when the inapp product was
- * purchased.
+ * The token provided to the user's device when the inapp product was purchased.
*/
token?: string;
}
@@ -6211,8 +5958,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.purchases.subscriptions.cancel
- * @desc Cancels a user's subscription purchase. The subscription remains
- * valid until its expiration time.
+ * @desc Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
* @alias androidpublisher.purchases.subscriptions.cancel
* @memberOf! ()
*
@@ -6286,8 +6032,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.purchases.subscriptions.defer
- * @desc Defers a user's subscription purchase until a specified future
- * expiration time.
+ * @desc Defers a user's subscription purchase until a specified future expiration time.
* @alias androidpublisher.purchases.subscriptions.defer
* @memberOf! ()
*
@@ -6373,8 +6118,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.purchases.subscriptions.get
- * @desc Checks whether a user's subscription purchase is valid and returns
- * its expiry time.
+ * @desc Checks whether a user's subscription purchase is valid and returns its expiry time.
* @alias androidpublisher.purchases.subscriptions.get
* @memberOf! ()
*
@@ -6452,8 +6196,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.purchases.subscriptions.refund
- * @desc Refunds a user's subscription purchase, but the subscription
- * remains valid until its expiration time and it will continue to recur.
+ * @desc Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.
* @alias androidpublisher.purchases.subscriptions.refund
* @memberOf! ()
*
@@ -6527,9 +6270,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.purchases.subscriptions.revoke
- * @desc Refunds and immediately revokes a user's subscription purchase.
- * Access to the subscription will be terminated immediately and it will
- * stop recurring.
+ * @desc Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.
* @alias androidpublisher.purchases.subscriptions.revoke
* @memberOf! ()
*
@@ -6610,8 +6351,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6619,8 +6359,7 @@ export namespace androidpublisher_v2 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -6632,8 +6371,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6641,8 +6379,7 @@ export namespace androidpublisher_v2 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
@@ -6659,8 +6396,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6668,8 +6404,7 @@ export namespace androidpublisher_v2 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -6681,8 +6416,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6690,8 +6424,7 @@ export namespace androidpublisher_v2 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -6703,8 +6436,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6712,8 +6444,7 @@ export namespace androidpublisher_v2 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -6819,12 +6550,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The time, in milliseconds since the Epoch, of the newest voided in-app
- * product purchase that you want to see in the response. The value of this
- * parameter cannot be greater than the current time and is ignored if a
- * pagination token is set. Default value is current time. Note: This filter
- * is applied on the time at which the record is seen as voided by our
- * systems and not the actual voided time returned in the response.
+ * The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
*/
endTime?: string;
/**
@@ -6832,8 +6558,7 @@ export namespace androidpublisher_v2 {
*/
maxResults?: number;
/**
- * The package name of the application for which voided purchases need to be
- * returned (for example, 'com.some.thing').
+ * The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6841,12 +6566,7 @@ export namespace androidpublisher_v2 {
*/
startIndex?: number;
/**
- * The time, in milliseconds since the Epoch, of the oldest voided in-app
- * product purchase that you want to see in the response. The value of this
- * parameter cannot be older than 30 days and is ignored if a pagination
- * token is set. Default value is current time minus 30 days. Note: This
- * filter is applied on the time at which the record is seen as voided by
- * our systems and not the actual voided time returned in the response.
+ * The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
*/
startTime?: string;
/**
@@ -6936,8 +6656,7 @@ export namespace androidpublisher_v2 {
/**
* androidpublisher.reviews.list
- * @desc Returns a list of reviews. Only reviews from last week will be
- * returned.
+ * @desc Returns a list of reviews. Only reviews from last week will be returned.
* @alias androidpublisher.reviews.list
* @memberOf! ()
*
@@ -7097,8 +6816,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique identifier for the Android app for which we want reviews; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -7121,8 +6839,7 @@ export namespace androidpublisher_v2 {
*/
maxResults?: number;
/**
- * Unique identifier for the Android app for which we want reviews; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -7145,8 +6862,7 @@ export namespace androidpublisher_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique identifier for the Android app for which we want reviews; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame".
*/
packageName?: string;
/**
diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts
index 40b362b8cee..8fe032dc6ce 100644
--- a/src/apis/androidpublisher/v3.ts
+++ b/src/apis/androidpublisher/v3.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace androidpublisher_v3 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace androidpublisher_v3 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -94,15 +91,22 @@ export namespace androidpublisher_v3 {
context: APIRequestContext;
edits: Resource$Edits;
inappproducts: Resource$Inappproducts;
+ internalappsharingartifacts: Resource$Internalappsharingartifacts;
orders: Resource$Orders;
purchases: Resource$Purchases;
reviews: Resource$Reviews;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.edits = new Resource$Edits(this.context);
this.inappproducts = new Resource$Inappproducts(this.context);
+ this.internalappsharingartifacts = new Resource$Internalappsharingartifacts(
+ this.context
+ );
this.orders = new Resource$Orders(this.context);
this.purchases = new Resource$Purchases(this.context);
this.reviews = new Resource$Reviews(this.context);
@@ -124,13 +128,11 @@ export namespace androidpublisher_v3 {
*/
export interface Schema$ApkBinary {
/**
- * A sha1 hash of the APK payload, encoded as a hex string and matching the
- * output of the sha1sum command.
+ * A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.
*/
sha1?: string;
/**
- * A sha256 hash of the APK payload, encoded as a hex string and matching
- * the output of the sha256sum command.
+ * A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command.
*/
sha256?: string;
}
@@ -149,8 +151,7 @@ export namespace androidpublisher_v3 {
export interface Schema$ApksListResponse {
apks?: Schema$Apk[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#apksListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse".
*/
kind?: string;
}
@@ -173,13 +174,11 @@ export namespace androidpublisher_v3 {
defaultLanguage?: string;
}
/**
- * Represents an edit of an app. An edit allows clients to make multiple
- * changes before committing them in one operation.
+ * Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
*/
export interface Schema$AppEdit {
/**
- * The time at which the edit will expire and will be no longer valid for
- * use in any subsequent API calls (encoded as seconds since the Epoch).
+ * The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
*/
expiryTimeSeconds?: string;
/**
@@ -189,26 +188,22 @@ export namespace androidpublisher_v3 {
}
export interface Schema$Bundle {
/**
- * A sha1 hash of the upload payload, encoded as a hex string and matching
- * the output of the sha1sum command.
+ * A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command.
*/
sha1?: string;
/**
- * A sha256 hash of the upload payload, encoded as a hex string and matching
- * the output of the sha256sum command.
+ * A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command.
*/
sha256?: string;
/**
- * The version code of the Android App Bundle. As specified in the Android
- * App Bundle's base module APK manifest file.
+ * The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file.
*/
versionCode?: number;
}
export interface Schema$BundlesListResponse {
bundles?: Schema$Bundle[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#bundlesListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#bundlesListResponse".
*/
kind?: string;
}
@@ -270,8 +265,7 @@ export namespace androidpublisher_v3 {
*/
manufacturer?: string;
/**
- * Comma separated list of native platforms (e.g. "arm",
- * "arm7")
+ * Comma separated list of native platforms (e.g. "arm", "arm7")
*/
nativePlatform?: string;
/**
@@ -297,14 +291,11 @@ export namespace androidpublisher_v3 {
}
export interface Schema$ExpansionFile {
/**
- * If set this field indicates that this APK has an Expansion File uploaded
- * to it: this APK does not reference another APK's Expansion File. The
- * field's value is the size of the uploaded Expansion File in bytes.
+ * If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.
*/
fileSize?: string;
/**
- * If set this APK's Expansion File references another APK's
- * Expansion File. The file_size field will not be set.
+ * If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.
*/
referencesVersion?: number;
}
@@ -312,10 +303,7 @@ export namespace androidpublisher_v3 {
expansionFile?: Schema$ExpansionFile;
}
/**
- * Defines an APK available for this application that is hosted externally and
- * not uploaded to Google Play. This function is only available to enterprises
- * who are using Google Play for Work, and whos application is restricted to
- * the enterprise private channel
+ * Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel
*/
export interface Schema$ExternallyHostedApk {
/**
@@ -323,8 +311,7 @@ export namespace androidpublisher_v3 {
*/
applicationLabel?: string;
/**
- * A certificate (or array of certificates if a certificate-chain is used)
- * used to signed this APK, represented as a base64 encoded byte array.
+ * A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.
*/
certificateBase64s?: string[];
/**
@@ -332,13 +319,11 @@ export namespace androidpublisher_v3 {
*/
externallyHostedUrl?: string;
/**
- * The SHA1 checksum of this APK, represented as a base64 encoded byte
- * array.
+ * The SHA1 checksum of this APK, represented as a base64 encoded byte array.
*/
fileSha1Base64?: string;
/**
- * The SHA256 checksum of this APK, represented as a base64 encoded byte
- * array.
+ * The SHA256 checksum of this APK, represented as a base64 encoded byte array.
*/
fileSha256Base64?: string;
/**
@@ -420,20 +405,15 @@ export namespace androidpublisher_v3 {
}
export interface Schema$InAppProduct {
/**
- * The default language of the localized data, as defined by BCP 47. e.g.
- * "en-US", "en-GB".
+ * The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
*/
defaultLanguage?: string;
/**
- * Default price cannot be zero. In-app products can never be free. Default
- * price is always in the developer's Checkout merchant currency.
+ * Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
*/
defaultPrice?: Schema$Price;
/**
- * Grace period of the subscription, specified in ISO 8601 format. It will
- * allow developers to give their subscribers a grace period when the
- * payment for the new recurrence period is declined. Acceptable values =
- * "P3D" (three days) and "P7D" (seven days)
+ * Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
*/
gracePeriod?: string;
/**
@@ -445,8 +425,7 @@ export namespace androidpublisher_v3 {
*/
packageName?: string;
/**
- * Prices per buyer region. None of these prices should be zero. In-app
- * products can never be free.
+ * Prices per buyer region. None of these prices should be zero. In-app products can never be free.
*/
prices?: {[key: string]: Schema$Price};
/**
@@ -454,8 +433,7 @@ export namespace androidpublisher_v3 {
*/
purchaseType?: string;
/**
- * Definition of a season for a seasonal subscription. Can be defined only
- * for yearly subscriptions.
+ * Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
*/
season?: Schema$Season;
/**
@@ -464,16 +442,11 @@ export namespace androidpublisher_v3 {
sku?: string;
status?: string;
/**
- * Subscription period, specified in ISO 8601 format. Acceptable values are
- * "P1W" (one week), "P1M" (one month), "P3M"
- * (three months), "P6M" (six months), and "P1Y" (one
- * year).
+ * Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
*/
subscriptionPeriod?: string;
/**
- * Trial period, specified in ISO 8601 format. Acceptable values are
- * anything between "P7D" (seven days) and "P999D" (999
- * days). Seasonal subscriptions cannot have a trial period.
+ * Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
*/
trialPeriod?: string;
}
@@ -484,26 +457,40 @@ export namespace androidpublisher_v3 {
export interface Schema$InappproductsListResponse {
inappproduct?: Schema$InAppProduct[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#inappproductsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse".
*/
kind?: string;
pageInfo?: Schema$PageInfo;
tokenPagination?: Schema$TokenPagination;
}
+ /**
+ * An artifact resource which gets created when uploading an APK or Android App Bundle through internal app sharing.
+ */
+ export interface Schema$InternalAppSharingArtifact {
+ /**
+ * The SHA256 fingerprint of the certificate used to signed the generated artifact.
+ */
+ certificateFingerprint?: string;
+ /**
+ * The download URL generated for the uploaded artifact. Users that are authorized to download can follow the link to the Play Store app to install it.
+ */
+ downloadUrl?: string;
+ /**
+ * The SHA-256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command.
+ */
+ sha256?: string;
+ }
export interface Schema$Listing {
/**
* Full description of the app; this may be up to 4000 characters in length.
*/
fullDescription?: string;
/**
- * Language localization code (for example, "de-AT" for Austrian
- * German).
+ * Language localization code (for example, "de-AT" for Austrian German).
*/
language?: string;
/**
- * Short description of the app (previously known as promo text); this may
- * be up to 80 characters in length.
+ * Short description of the app (previously known as promo text); this may be up to 80 characters in length.
*/
shortDescription?: string;
/**
@@ -517,8 +504,7 @@ export namespace androidpublisher_v3 {
}
export interface Schema$ListingsListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#listingsListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#listingsListResponse".
*/
kind?: string;
listings?: Schema$Listing[];
@@ -535,8 +521,7 @@ export namespace androidpublisher_v3 {
}
export interface Schema$MonthDay {
/**
- * Day of a month, value in [1, 31] range. Valid range depends on the
- * specified month.
+ * Day of a month, value in [1, 31] range. Valid range depends on the specified month.
*/
day?: number;
/**
@@ -555,29 +540,28 @@ export namespace androidpublisher_v3 {
*/
currency?: string;
/**
- * The price in millionths of the currency base unit represented as a
- * string.
+ * The price in millionths of the currency base unit represented as a string.
*/
priceMicros?: string;
}
/**
- * A ProductPurchase resource indicates the status of a user's inapp
- * product purchase.
+ * A ProductPurchase resource indicates the status of a user's inapp product purchase.
*/
export interface Schema$ProductPurchase {
/**
- * The consumption state of the inapp product. Possible values are: - Yet
- * to be consumed - Consumed
+ * The acknowledgement state of the inapp product. Possible values are: - Yet to be acknowledged - Acknowledged
+ */
+ acknowledgementState?: number;
+ /**
+ * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed
*/
consumptionState?: number;
/**
- * A developer-specified string that contains supplemental information about
- * an order.
+ * A developer-specified string that contains supplemental information about an order.
*/
developerPayload?: string;
/**
- * This kind represents an inappPurchase object in the androidpublisher
- * service.
+ * This kind represents an inappPurchase object in the androidpublisher service.
*/
kind?: string;
/**
@@ -585,30 +569,27 @@ export namespace androidpublisher_v3 {
*/
orderId?: string;
/**
- * The purchase state of the order. Possible values are: - Purchased -
- * Canceled
+ * The purchase state of the order. Possible values are: - Purchased - Canceled
*/
purchaseState?: number;
/**
- * The time the product was purchased, in milliseconds since the epoch (Jan
- * 1, 1970).
+ * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
*/
purchaseTimeMillis?: string;
/**
- * The type of purchase of the inapp product. This field is only set if this
- * purchase was not made using the standard in-app billing flow. Possible
- * values are: - Test (i.e. purchased from a license testing account) -
- * Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching
- * a video ad instead of paying)
+ * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying)
*/
purchaseType?: number;
}
+ export interface Schema$ProductPurchasesAcknowledgeRequest {
+ /**
+ * Payload to attach to the purchase.
+ */
+ developerPayload?: string;
+ }
export interface Schema$Prorate {
/**
- * Default price cannot be zero and must be less than the full subscription
- * price. Default price is always in the developer's Checkout merchant
- * currency. Targeted countries have their prices set automatically based on
- * the default_price.
+ * Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
*/
defaultPrice?: Schema$Price;
/**
@@ -647,8 +628,7 @@ export namespace androidpublisher_v3 {
}
export interface Schema$ReviewsReplyRequest {
/**
- * The text to set as the reply. Replies of more than approximately 350
- * characters will be rejected. HTML tags will be stripped.
+ * The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.
*/
replyText?: string;
}
@@ -661,10 +641,7 @@ export namespace androidpublisher_v3 {
*/
end?: Schema$MonthDay;
/**
- * Optionally present list of prorations for the season. Each proration is a
- * one-off discounted entry into a subscription. Each proration contains the
- * first date on which the discount is available and the new pricing
- * information.
+ * Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
*/
prorations?: Schema$Prorate[];
/**
@@ -673,198 +650,143 @@ export namespace androidpublisher_v3 {
start?: Schema$MonthDay;
}
/**
- * Information provided by the user when they complete the subscription
- * cancellation flow (cancellation reason survey).
+ * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).
*/
export interface Schema$SubscriptionCancelSurveyResult {
/**
- * The cancellation reason the user chose in the survey. Possible values
- * are: - Other - I don't use this service enough - Technical issues
- * - Cost-related reasons - I found a better app
+ * The cancellation reason the user chose in the survey. Possible values are: - Other - I don't use this service enough - Technical issues - Cost-related reasons - I found a better app
*/
cancelSurveyReason?: number;
/**
- * The customized input cancel reason from the user. Only present when
- * cancelReason is 0.
+ * The customized input cancel reason from the user. Only present when cancelReason is 0.
*/
userInputCancelReason?: string;
}
/**
- * A SubscriptionDeferralInfo contains the data needed to defer a subscription
- * purchase to a future expiry time.
+ * A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.
*/
export interface Schema$SubscriptionDeferralInfo {
/**
- * The desired next expiry time to assign to the subscription, in
- * milliseconds since the Epoch. The given time must be later/greater than
- * the current expiry time for the subscription.
+ * The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription.
*/
desiredExpiryTimeMillis?: string;
/**
- * The expected expiry time for the subscription. If the current expiry time
- * for the subscription is not the value specified here, the deferral will
- * not occur.
+ * The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur.
*/
expectedExpiryTimeMillis?: string;
}
/**
- * Contains the price change information for a subscription that can be used
- * to control the user journey for the price change in the app. This can be in
- * the form of seeking confirmation from the user or tailoring the experience
- * for a successful conversion.
+ * Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion.
*/
export interface Schema$SubscriptionPriceChange {
/**
- * The new price the subscription will renew with if the price change is
- * accepted by the user.
+ * The new price the subscription will renew with if the price change is accepted by the user.
*/
newPrice?: Schema$Price;
/**
- * The current state of the price change. Possible values are: -
- * Outstanding: State for a pending price change waiting for the user to
- * agree. In this state, you can optionally seek confirmation from the user
- * using the In-App API. - Accepted: State for an accepted price change
- * that the subscription will renew with unless it's canceled. The price
- * change takes effect on a future date when the subscription renews. Note
- * that the change might not occur when the subscription is renewed next.
+ * The current state of the price change. Possible values are: - Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. - Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next.
*/
state?: number;
}
/**
- * A SubscriptionPurchase resource indicates the status of a user's
- * subscription purchase.
+ * A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
*/
export interface Schema$SubscriptionPurchase {
/**
- * Whether the subscription will automatically be renewed when it reaches
- * its current expiry time.
+ * Whether the subscription will automatically be renewed when it reaches its current expiry time.
*/
autoRenewing?: boolean;
/**
- * Time at which the subscription will be automatically resumed, in
- * milliseconds since the Epoch. Only present if the user has requested to
- * pause the subscription.
+ * Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription.
*/
autoResumeTimeMillis?: string;
/**
- * The reason why a subscription was canceled or is not auto-renewing.
- * Possible values are: - User canceled the subscription - Subscription
- * was canceled by the system, for example because of a billing problem -
- * Subscription was replaced with a new subscription - Subscription was
- * canceled by the developer
+ * The reason why a subscription was canceled or is not auto-renewing. Possible values are: - User canceled the subscription - Subscription was canceled by the system, for example because of a billing problem - Subscription was replaced with a new subscription - Subscription was canceled by the developer
*/
cancelReason?: number;
/**
- * Information provided by the user when they complete the subscription
- * cancellation flow (cancellation reason survey).
+ * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).
*/
cancelSurveyResult?: Schema$SubscriptionCancelSurveyResult;
/**
- * ISO 3166-1 alpha-2 billing country/region code of the user at the time
- * the subscription was granted.
+ * ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.
*/
countryCode?: string;
/**
- * A developer-specified string that contains supplemental information about
- * an order.
+ * A developer-specified string that contains supplemental information about an order.
*/
developerPayload?: string;
/**
- * The email address of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
emailAddress?: string;
/**
- * Time at which the subscription will expire, in milliseconds since the
- * Epoch.
+ * Time at which the subscription will expire, in milliseconds since the Epoch.
*/
expiryTimeMillis?: string;
/**
- * The family name of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
familyName?: string;
/**
- * The given name of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
givenName?: string;
/**
- * This kind represents a subscriptionPurchase object in the
- * androidpublisher service.
+ * This kind represents a subscriptionPurchase object in the androidpublisher service.
*/
kind?: string;
/**
- * The purchase token of the originating purchase if this subscription is
- * one of the following: - Re-signup of a canceled but non-lapsed
- * subscription - Upgrade/downgrade from a previous subscription For
- * example, suppose a user originally signs up and you receive purchase
- * token X, then the user cancels and goes through the resignup flow (before
- * their subscription lapses) and you receive purchase token Y, and finally
- * the user upgrades their subscription and you receive purchase token Z. If
- * you call this API with purchase token Z, this field will be set to Y. If
- * you call this API with purchase token Y, this field will be set to X. If
- * you call this API with purchase token X, this field will not be set.
+ * The purchase token of the originating purchase if this subscription is one of the following: - Re-signup of a canceled but non-lapsed subscription - Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set.
*/
linkedPurchaseToken?: string;
/**
- * The order id of the latest recurring order associated with the purchase
- * of the subscription.
+ * The order id of the latest recurring order associated with the purchase of the subscription.
*/
orderId?: string;
/**
- * The payment state of the subscription. Possible values are: - Payment
- * pending - Payment received - Free trial - Pending deferred
- * upgrade/downgrade
+ * The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade
*/
paymentState?: number;
/**
- * Price of the subscription, not including tax. Price is expressed in
- * micro-units, where 1,000,000 micro-units represents one unit of the
- * currency. For example, if the subscription price is €1.99,
- * price_amount_micros is 1990000.
+ * Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.
*/
priceAmountMicros?: string;
/**
- * The latest price change information available. This is present only when
- * there is an upcoming price change for the subscription yet to be applied.
- * Once the subscription renews with the new price or the subscription is
- * canceled, no price change information will be returned.
+ * The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned.
*/
priceChange?: Schema$SubscriptionPriceChange;
/**
- * ISO 4217 currency code for the subscription price. For example, if the
- * price is specified in British pounds sterling, price_currency_code is
- * "GBP".
+ * ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".
*/
priceCurrencyCode?: string;
/**
- * The profile id of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
profileId?: string;
/**
- * The profile name of the user when the subscription was purchased. Only
- * present for purchases made with 'Subscribe with Google'.
+ * The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
*/
profileName?: string;
/**
- * The type of purchase of the subscription. This field is only set if this
- * purchase was not made using the standard in-app billing flow. Possible
- * values are: - Test (i.e. purchased from a license testing account)
+ * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account)
*/
purchaseType?: number;
/**
- * Time at which the subscription was granted, in milliseconds since the
- * Epoch.
+ * Time at which the subscription was granted, in milliseconds since the Epoch.
*/
startTimeMillis?: string;
/**
- * The time at which the subscription was canceled by the user, in
- * milliseconds since the epoch. Only present if cancelReason is 0.
+ * The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.
*/
userCancellationTimeMillis?: string;
}
+ export interface Schema$SubscriptionPurchasesAcknowledgeRequest {
+ /**
+ * Payload to attach to the purchase.
+ */
+ developerPayload?: string;
+ }
export interface Schema$SubscriptionPurchasesDeferRequest {
/**
* The information about the new desired expiry time for the subscription.
@@ -891,8 +813,7 @@ export namespace androidpublisher_v3 {
}
export interface Schema$Track {
/**
- * A list of all active releases in this track during a read request. On an
- * update request, it represents desired changes.
+ * A list of all active releases in this track during a read request. On an update request, it represents desired changes.
*/
releases?: Schema$TrackRelease[];
/**
@@ -903,9 +824,7 @@ export namespace androidpublisher_v3 {
export interface Schema$TrackRelease {
countryTargeting?: Schema$CountryTargeting;
/**
- * The release name, used to identify this release in the Play Console UI.
- * Not required to be unique. This is optional, if not set it will be
- * generated from the version_name in the APKs.
+ * The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs.
*/
name?: string;
/**
@@ -917,46 +836,36 @@ export namespace androidpublisher_v3 {
*/
status?: string;
/**
- * Fraction of users who are eligible to receive the release. 0 <
- * fraction < 1. To be set, release status must be "inProgress"
- * or "halted".
+ * Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted".
*/
userFraction?: number;
/**
- * A list of all version codes of APKs that will be exposed to the users of
- * this track when this release is rolled out. Note that this list should
- * contain all versions you wish to be active, including those you wish to
- * retain from previous releases.
+ * A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases.
*/
versionCodes?: string[];
}
export interface Schema$TracksListResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "androidpublisher#tracksListResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse".
*/
kind?: string;
tracks?: Schema$Track[];
}
export interface Schema$UserComment {
/**
- * Integer Android SDK version of the user's device at the time the
- * review was written, e.g. 23 is Marshmallow. May be absent.
+ * Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
*/
androidOsVersion?: number;
/**
- * Integer version code of the app as installed at the time the review was
- * written. May be absent.
+ * Integer version code of the app as installed at the time the review was written. May be absent.
*/
appVersionCode?: number;
/**
- * String version name of the app as installed at the time the review was
- * written. May be absent.
+ * String version name of the app as installed at the time the review was written. May be absent.
*/
appVersionName?: string;
/**
- * Codename for the reviewer's device, e.g. klte, flounder. May be
- * absent.
+ * Codename for the reviewer's device, e.g. klte, flounder. May be absent.
*/
device?: string;
/**
@@ -968,14 +877,11 @@ export namespace androidpublisher_v3 {
*/
lastModified?: Schema$Timestamp;
/**
- * Untranslated text of the review, in the case where the review has been
- * translated. If the review has not been translated this is left blank.
+ * Untranslated text of the review, in the case where the review has been translated. If the review has not been translated this is left blank.
*/
originalText?: string;
/**
- * Language code for the reviewer. This is taken from the device settings so
- * is not guaranteed to match the language the review is written in. May be
- * absent.
+ * Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent.
*/
reviewerLanguage?: string;
/**
@@ -983,9 +889,7 @@ export namespace androidpublisher_v3 {
*/
starRating?: number;
/**
- * The content of the comment, i.e. review body. In some cases users have
- * been able to write a review with separate title and body; in those cases
- * the title and body are concatenated and separated by a tab character.
+ * The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character.
*/
text?: string;
/**
@@ -998,28 +902,23 @@ export namespace androidpublisher_v3 {
thumbsUpCount?: number;
}
/**
- * A VoidedPurchase resource indicates a purchase that was either
- * canceled/refunded/charged-back.
+ * A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.
*/
export interface Schema$VoidedPurchase {
/**
- * This kind represents a voided purchase object in the androidpublisher
- * service.
+ * This kind represents a voided purchase object in the androidpublisher service.
*/
kind?: string;
/**
- * The time at which the purchase was made, in milliseconds since the epoch
- * (Jan 1, 1970).
+ * The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).
*/
purchaseTimeMillis?: string;
/**
- * The token that was generated when a purchase was made. This uniquely
- * identifies a purchase.
+ * The token that was generated when a purchase was made. This uniquely identifies a purchase.
*/
purchaseToken?: string;
/**
- * The time at which the purchase was canceled/refunded/charged-back, in
- * milliseconds since the epoch (Jan 1, 1970).
+ * The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).
*/
voidedTimeMillis?: string;
}
@@ -1129,9 +1028,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.delete
- * @desc Deletes an edit for an app. Creating a new edit will automatically
- * delete any of your previous edits so this method need only be called if
- * you want to preemptively abandon an edit.
+ * @desc Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.
* @alias androidpublisher.edits.delete
* @memberOf! ()
*
@@ -1203,9 +1100,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.get
- * @desc Returns information about the edit specified. Calls will fail if
- * the edit is no long active (e.g. has been deleted, superseded or
- * expired).
+ * @desc Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).
* @alias androidpublisher.edits.get
* @memberOf! ()
*
@@ -1277,8 +1172,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.insert
- * @desc Creates a new edit for an app, populated with the app's current
- * state.
+ * @desc Creates a new edit for an app, populated with the app's current state.
* @alias androidpublisher.edits.insert
* @memberOf! ()
*
@@ -1349,8 +1243,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.validate
- * @desc Checks that the edit can be successfully committed. The edit's
- * changes are not applied to the live app.
+ * @desc Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.
* @alias androidpublisher.edits.validate
* @memberOf! ()
*
@@ -1432,8 +1325,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1448,8 +1340,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1464,8 +1355,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1476,8 +1366,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -1497,8 +1386,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1511,10 +1399,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.apks.addexternallyhosted
- * @desc Creates a new APK without uploading the APK itself to Google Play,
- * instead hosting the APK at a specified URL. This function is only
- * available to enterprises using Google Play for Work whose application is
- * configured to restrict distribution to the enterprise domain.
+ * @desc Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.
* @alias androidpublisher.edits.apks.addexternallyhosted
* @memberOf! ()
*
@@ -1762,8 +1647,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -1783,8 +1667,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -1800,8 +1683,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -1903,12 +1785,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.bundles.upload
- * @desc Uploads a new Android App Bundle to this edit. If you are using the
- * Google API client libraries, please increase the timeout of the http
- * request before calling this endpoint (a timeout of 2 minutes is
- * recommended). See:
- * https://developers.google.com/api-client-library/java/google-api-java-client/errors
- * for an example in java.
+ * @desc Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.
* @alias androidpublisher.edits.bundles.upload
* @memberOf! ()
*
@@ -2000,8 +1877,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -2013,9 +1889,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Must be set to true if the bundle installation may trigger a warning on
- * user devices (for example, if installation size may be over a threshold,
- * typically 100 MB).
+ * Must be set to true if the bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB).
*/
ackBundleInstallationWarning?: boolean;
/**
@@ -2023,8 +1897,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2052,8 +1925,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.deobfuscationfiles.upload
- * @desc Uploads the deobfuscation file of the specified APK. If a
- * deobfuscation file already exists, it will be replaced.
+ * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.
* @alias androidpublisher.edits.deobfuscationfiles.upload
* @memberOf! ()
*
@@ -2175,8 +2047,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier of the Android app for which the deobfuscatiuon files
- * are being uploaded; for example, "com.spiffygame".
+ * Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2204,8 +2075,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.details.get
- * @desc Fetches app details for this edit. This includes the default
- * language and developer support contact information.
+ * @desc Fetches app details for this edit. This includes the default language and developer support contact information.
* @alias androidpublisher.edits.details.get
* @memberOf! ()
*
@@ -2280,8 +2150,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.details.patch
- * @desc Updates app details for this edit. This method supports patch
- * semantics.
+ * @desc Updates app details for this edit. This method supports patch semantics.
* @alias androidpublisher.edits.details.patch
* @memberOf! ()
*
@@ -2444,8 +2313,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -2461,8 +2329,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2483,8 +2350,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2589,9 +2455,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.expansionfiles.patch
- * @desc Updates the APK's Expansion File configuration to reference another
- * APK's Expansion Files. To add a new Expansion File use the Upload method.
- * This method supports patch semantics.
+ * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.
* @alias androidpublisher.edits.expansionfiles.patch
* @memberOf! ()
*
@@ -2679,8 +2543,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.expansionfiles.update
- * @desc Updates the APK's Expansion File configuration to reference another
- * APK's Expansion Files. To add a new Expansion File use the Upload method.
+ * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.
* @alias androidpublisher.edits.expansionfiles.update
* @memberOf! ()
*
@@ -2878,8 +2741,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version code of the APK whose Expansion File configuration is being
- * read or modified.
+ * The version code of the APK whose Expansion File configuration is being read or modified.
*/
apkVersionCode?: number;
/**
@@ -2891,8 +2753,7 @@ export namespace androidpublisher_v3 {
*/
expansionFileType?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -2904,8 +2765,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version code of the APK whose Expansion File configuration is being
- * read or modified.
+ * The version code of the APK whose Expansion File configuration is being read or modified.
*/
apkVersionCode?: number;
/**
@@ -2917,8 +2777,7 @@ export namespace androidpublisher_v3 {
*/
expansionFileType?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2935,8 +2794,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version code of the APK whose Expansion File configuration is being
- * read or modified.
+ * The version code of the APK whose Expansion File configuration is being read or modified.
*/
apkVersionCode?: number;
/**
@@ -2948,8 +2806,7 @@ export namespace androidpublisher_v3 {
*/
expansionFileType?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -2966,8 +2823,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version code of the APK whose Expansion File configuration is being
- * read or modified.
+ * The version code of the APK whose Expansion File configuration is being read or modified.
*/
apkVersionCode?: number;
/**
@@ -2979,8 +2835,7 @@ export namespace androidpublisher_v3 {
*/
expansionFileType?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -3254,8 +3109,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.images.upload
- * @desc Uploads a new image and adds it to the list of images for the
- * specified language and image type.
+ * @desc Uploads a new image and adds it to the list of images for the specified language and image type.
* @alias androidpublisher.edits.images.upload
* @memberOf! ()
*
@@ -3352,8 +3206,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier an image within the set of images attached to this
- * edit.
+ * Unique identifier an image within the set of images attached to this edit.
*/
imageId?: string;
/**
@@ -3361,14 +3214,11 @@ export namespace androidpublisher_v3 {
*/
imageType?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing whose
- * images are to read or modified. For example, to select Austrian German,
- * pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3388,14 +3238,11 @@ export namespace androidpublisher_v3 {
*/
imageType?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing whose
- * images are to read or modified. For example, to select Austrian German,
- * pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3415,14 +3262,11 @@ export namespace androidpublisher_v3 {
*/
imageType?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing whose
- * images are to read or modified. For example, to select Austrian German,
- * pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3442,14 +3286,11 @@ export namespace androidpublisher_v3 {
*/
imageType?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing whose
- * images are to read or modified. For example, to select Austrian German,
- * pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -3775,8 +3616,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.listings.patch
- * @desc Creates or updates a localized store listing. This method supports
- * patch semantics.
+ * @desc Creates or updates a localized store listing. This method supports patch semantics.
* @alias androidpublisher.edits.listings.patch
* @memberOf! ()
*
@@ -3937,13 +3777,11 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing to
- * read or modify. For example, to select Austrian German, pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3959,8 +3797,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3976,13 +3813,11 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing to
- * read or modify. For example, to select Austrian German, pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -3998,8 +3833,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -4015,13 +3849,11 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing to
- * read or modify. For example, to select Austrian German, pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -4042,13 +3874,11 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * The language code (a BCP-47 language tag) of the localized listing to
- * read or modify. For example, to select Austrian German, pass "de-AT".
+ * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".
*/
language?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
@@ -4298,8 +4128,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4319,8 +4148,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4345,8 +4173,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4368,8 +4195,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.tracks.get
- * @desc Fetches the track configuration for the specified track type.
- * Includes the APK version codes that are in this track.
+ * @desc Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.
* @alias androidpublisher.edits.tracks.get
* @memberOf! ()
*
@@ -4517,8 +4343,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.edits.tracks.patch
- * @desc Updates the track configuration for the specified track type. This
- * method supports patch semantics.
+ * @desc Updates the track configuration for the specified track type. This method supports patch semantics.
* @alias androidpublisher.edits.tracks.patch
* @memberOf! ()
*
@@ -4678,8 +4503,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4699,8 +4523,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
}
@@ -4716,8 +4539,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4742,8 +4564,7 @@ export namespace androidpublisher_v3 {
*/
editId?: string;
/**
- * Unique identifier for the Android app that is being updated; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app that is being updated; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -4989,8 +4810,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.inappproducts.list
- * @desc List all the in-app products for an Android app, both subscriptions
- * and managed in-app products..
+ * @desc List all the in-app products for an Android app, both subscriptions and managed in-app products..
* @alias androidpublisher.inappproducts.list
* @memberOf! ()
*
@@ -5074,8 +4894,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.inappproducts.patch
- * @desc Updates the details of an in-app product. This method supports
- * patch semantics.
+ * @desc Updates the details of an in-app product. This method supports patch semantics.
* @alias androidpublisher.inappproducts.patch
* @memberOf! ()
*
@@ -5236,8 +5055,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique identifier for the Android app with the in-app product; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5269,9 +5087,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * If true the prices for all regions targeted by the parent app that don't
- * have a price specified for this in-app product will be auto converted to
- * the target currency based on the default price. Defaults to false.
+ * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
*/
autoConvertMissingPrices?: boolean;
/**
@@ -5296,8 +5112,7 @@ export namespace androidpublisher_v3 {
*/
maxResults?: number;
/**
- * Unique identifier for the Android app with in-app products; for example,
- * "com.spiffygame".
+ * Unique identifier for the Android app with in-app products; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5317,14 +5132,11 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * If true the prices for all regions targeted by the parent app that don't
- * have a price specified for this in-app product will be auto converted to
- * the target currency based on the default price. Defaults to false.
+ * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
*/
autoConvertMissingPrices?: boolean;
/**
- * Unique identifier for the Android app with the in-app product; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5345,14 +5157,11 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * If true the prices for all regions targeted by the parent app that don't
- * have a price specified for this in-app product will be auto converted to
- * the target currency based on the default price. Defaults to false.
+ * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
*/
autoConvertMissingPrices?: boolean;
/**
- * Unique identifier for the Android app with the in-app product; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -5366,6 +5175,244 @@ export namespace androidpublisher_v3 {
requestBody?: Schema$InAppProduct;
}
+ export class Resource$Internalappsharingartifacts {
+ context: APIRequestContext;
+ constructor(context: APIRequestContext) {
+ this.context = context;
+ }
+
+ /**
+ * androidpublisher.internalappsharingartifacts.uploadapk
+ * @desc Uploads an APK to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.
+ * @alias androidpublisher.internalappsharingartifacts.uploadapk
+ * @memberOf! ()
+ *
+ * @param {object} params Parameters for request
+ * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame".
+ * @param {object} params.media Media object
+ * @param {string} params.media.mimeType Media mime-type
+ * @param {string|object} params.media.body Media body contents
+ * @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
+ */
+ uploadapk(
+ params?: Params$Resource$Internalappsharingartifacts$Uploadapk,
+ options?: MethodOptions
+ ): GaxiosPromise;
+ uploadapk(
+ params: Params$Resource$Internalappsharingartifacts$Uploadapk,
+ options:
+ | MethodOptions
+ | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ uploadapk(
+ params: Params$Resource$Internalappsharingartifacts$Uploadapk,
+ callback: BodyResponseCallback
+ ): void;
+ uploadapk(
+ callback: BodyResponseCallback
+ ): void;
+ uploadapk(
+ paramsOrCallback?:
+ | Params$Resource$Internalappsharingartifacts$Uploadapk
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | BodyResponseCallback,
+ callback?: BodyResponseCallback
+ ): void | GaxiosPromise {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Internalappsharingartifacts$Uploadapk;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Internalappsharingartifacts$Uploadapk;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (
+ rootUrl +
+ '/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ method: 'POST',
+ },
+ options
+ ),
+ params,
+ mediaUrl: (
+ rootUrl +
+ '/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ requiredParams: ['packageName'],
+ pathParams: ['packageName'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * androidpublisher.internalappsharingartifacts.uploadbundle
+ * @desc Uploads an app bundle to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.
+ * @alias androidpublisher.internalappsharingartifacts.uploadbundle
+ * @memberOf! ()
+ *
+ * @param {object} params Parameters for request
+ * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame".
+ * @param {object} params.media Media object
+ * @param {string} params.media.mimeType Media mime-type
+ * @param {string|object} params.media.body Media body contents
+ * @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
+ */
+ uploadbundle(
+ params?: Params$Resource$Internalappsharingartifacts$Uploadbundle,
+ options?: MethodOptions
+ ): GaxiosPromise;
+ uploadbundle(
+ params: Params$Resource$Internalappsharingartifacts$Uploadbundle,
+ options:
+ | MethodOptions
+ | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ uploadbundle(
+ params: Params$Resource$Internalappsharingartifacts$Uploadbundle,
+ callback: BodyResponseCallback
+ ): void;
+ uploadbundle(
+ callback: BodyResponseCallback
+ ): void;
+ uploadbundle(
+ paramsOrCallback?:
+ | Params$Resource$Internalappsharingartifacts$Uploadbundle
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | BodyResponseCallback,
+ callback?: BodyResponseCallback
+ ): void | GaxiosPromise {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Internalappsharingartifacts$Uploadbundle;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Internalappsharingartifacts$Uploadbundle;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (
+ rootUrl +
+ '/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ method: 'POST',
+ },
+ options
+ ),
+ params,
+ mediaUrl: (
+ rootUrl +
+ '/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ requiredParams: ['packageName'],
+ pathParams: ['packageName'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+ }
+
+ export interface Params$Resource$Internalappsharingartifacts$Uploadapk
+ extends StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
+
+ /**
+ * Unique identifier for the Android app; for example, "com.spiffygame".
+ */
+ packageName?: string;
+
+ /**
+ * Media metadata
+ */
+ media?: {
+ /**
+ * Media mime-type
+ */
+ mimeType?: string;
+
+ /**
+ * Media body contents
+ */
+ body?: any;
+ };
+ }
+ export interface Params$Resource$Internalappsharingartifacts$Uploadbundle
+ extends StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
+
+ /**
+ * Unique identifier for the Android app; for example, "com.spiffygame".
+ */
+ packageName?: string;
+
+ /**
+ * Media metadata
+ */
+ media?: {
+ /**
+ * Media mime-type
+ */
+ mimeType?: string;
+
+ /**
+ * Media body contents
+ */
+ body?: any;
+ };
+ }
+
export class Resource$Orders {
context: APIRequestContext;
constructor(context: APIRequestContext) {
@@ -5453,20 +5500,15 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The order ID provided to the user when the subscription or in-app order
- * was purchased.
+ * The order ID provided to the user when the subscription or in-app order was purchased.
*/
orderId?: string;
/**
- * The package name of the application for which this subscription or in-app
- * item was purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
- * Whether to revoke the purchased item. If set to true, access to the
- * subscription or in-app item will be terminated immediately. If the item
- * is a recurring subscription, all future payments will also be terminated.
- * Consumed in-app items need to be handled by developer's app. (optional)
+ * Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional)
*/
revoke?: boolean;
}
@@ -5492,6 +5534,81 @@ export namespace androidpublisher_v3 {
this.context = context;
}
+ /**
+ * androidpublisher.purchases.products.acknowledge
+ * @desc Acknowledges a purchase of an inapp item.
+ * @alias androidpublisher.purchases.products.acknowledge
+ * @memberOf! ()
+ *
+ * @param {object} params Parameters for request
+ * @param {string} params.packageName The package name of the application the inapp product was sold in (for example, 'com.some.thing').
+ * @param {string} params.productId The inapp product SKU (for example, 'com.some.thing.inapp1').
+ * @param {string} params.token The token provided to the user's device when the subscription was purchased.
+ * @param {().ProductPurchasesAcknowledgeRequest} 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
+ */
+ acknowledge(
+ params?: Params$Resource$Purchases$Products$Acknowledge,
+ options?: MethodOptions
+ ): GaxiosPromise;
+ acknowledge(
+ params: Params$Resource$Purchases$Products$Acknowledge,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ acknowledge(
+ params: Params$Resource$Purchases$Products$Acknowledge,
+ callback: BodyResponseCallback
+ ): void;
+ acknowledge(callback: BodyResponseCallback): void;
+ acknowledge(
+ paramsOrCallback?:
+ | Params$Resource$Purchases$Products$Acknowledge
+ | BodyResponseCallback,
+ optionsOrCallback?: MethodOptions | BodyResponseCallback,
+ callback?: BodyResponseCallback
+ ): void | GaxiosPromise {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Purchases$Products$Acknowledge;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Purchases$Products$Acknowledge;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (
+ rootUrl +
+ '/androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ method: 'POST',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['packageName', 'productId', 'token'],
+ pathParams: ['packageName', 'productId', 'token'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(parameters, callback);
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
/**
* androidpublisher.purchases.products.get
* @desc Checks the purchase and consumption status of an inapp item.
@@ -5569,6 +5686,31 @@ export namespace androidpublisher_v3 {
}
}
+ export interface Params$Resource$Purchases$Products$Acknowledge
+ extends StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
+
+ /**
+ * The package name of the application the inapp product was sold in (for example, 'com.some.thing').
+ */
+ packageName?: string;
+ /**
+ * The inapp product SKU (for example, 'com.some.thing.inapp1').
+ */
+ productId?: string;
+ /**
+ * The token provided to the user's device when the subscription was purchased.
+ */
+ token?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$ProductPurchasesAcknowledgeRequest;
+ }
export interface Params$Resource$Purchases$Products$Get
extends StandardParameters {
/**
@@ -5577,8 +5719,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application the inapp product was sold in (for
- * example, 'com.some.thing').
+ * The package name of the application the inapp product was sold in (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -5586,8 +5727,7 @@ export namespace androidpublisher_v3 {
*/
productId?: string;
/**
- * The token provided to the user's device when the inapp product was
- * purchased.
+ * The token provided to the user's device when the inapp product was purchased.
*/
token?: string;
}
@@ -5598,10 +5738,84 @@ export namespace androidpublisher_v3 {
this.context = context;
}
+ /**
+ * androidpublisher.purchases.subscriptions.acknowledge
+ * @desc Acknowledges a subscription purchase.
+ * @alias androidpublisher.purchases.subscriptions.acknowledge
+ * @memberOf! ()
+ *
+ * @param {object} params Parameters for request
+ * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
+ * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001').
+ * @param {string} params.token The token provided to the user's device when the subscription was purchased.
+ * @param {().SubscriptionPurchasesAcknowledgeRequest} 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
+ */
+ acknowledge(
+ params?: Params$Resource$Purchases$Subscriptions$Acknowledge,
+ options?: MethodOptions
+ ): GaxiosPromise;
+ acknowledge(
+ params: Params$Resource$Purchases$Subscriptions$Acknowledge,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ acknowledge(
+ params: Params$Resource$Purchases$Subscriptions$Acknowledge,
+ callback: BodyResponseCallback
+ ): void;
+ acknowledge(callback: BodyResponseCallback): void;
+ acknowledge(
+ paramsOrCallback?:
+ | Params$Resource$Purchases$Subscriptions$Acknowledge
+ | BodyResponseCallback,
+ optionsOrCallback?: MethodOptions | BodyResponseCallback,
+ callback?: BodyResponseCallback
+ ): void | GaxiosPromise {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Purchases$Subscriptions$Acknowledge;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Purchases$Subscriptions$Acknowledge;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (
+ rootUrl +
+ '/androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ method: 'POST',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['packageName', 'subscriptionId', 'token'],
+ pathParams: ['packageName', 'subscriptionId', 'token'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(parameters, callback);
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
/**
* androidpublisher.purchases.subscriptions.cancel
- * @desc Cancels a user's subscription purchase. The subscription remains
- * valid until its expiration time.
+ * @desc Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
* @alias androidpublisher.purchases.subscriptions.cancel
* @memberOf! ()
*
@@ -5675,8 +5889,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.purchases.subscriptions.defer
- * @desc Defers a user's subscription purchase until a specified future
- * expiration time.
+ * @desc Defers a user's subscription purchase until a specified future expiration time.
* @alias androidpublisher.purchases.subscriptions.defer
* @memberOf! ()
*
@@ -5762,8 +5975,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.purchases.subscriptions.get
- * @desc Checks whether a user's subscription purchase is valid and returns
- * its expiry time.
+ * @desc Checks whether a user's subscription purchase is valid and returns its expiry time.
* @alias androidpublisher.purchases.subscriptions.get
* @memberOf! ()
*
@@ -5841,8 +6053,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.purchases.subscriptions.refund
- * @desc Refunds a user's subscription purchase, but the subscription
- * remains valid until its expiration time and it will continue to recur.
+ * @desc Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.
* @alias androidpublisher.purchases.subscriptions.refund
* @memberOf! ()
*
@@ -5916,9 +6127,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.purchases.subscriptions.revoke
- * @desc Refunds and immediately revokes a user's subscription purchase.
- * Access to the subscription will be terminated immediately and it will
- * stop recurring.
+ * @desc Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.
* @alias androidpublisher.purchases.subscriptions.revoke
* @memberOf! ()
*
@@ -5991,6 +6200,31 @@ export namespace androidpublisher_v3 {
}
}
+ export interface Params$Resource$Purchases$Subscriptions$Acknowledge
+ extends StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
+
+ /**
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
+ */
+ packageName?: string;
+ /**
+ * The purchased subscription ID (for example, 'monthly001').
+ */
+ subscriptionId?: string;
+ /**
+ * The token provided to the user's device when the subscription was purchased.
+ */
+ token?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$SubscriptionPurchasesAcknowledgeRequest;
+ }
export interface Params$Resource$Purchases$Subscriptions$Cancel
extends StandardParameters {
/**
@@ -5999,8 +6233,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6008,8 +6241,7 @@ export namespace androidpublisher_v3 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -6021,8 +6253,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6030,8 +6261,7 @@ export namespace androidpublisher_v3 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
@@ -6048,8 +6278,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6057,8 +6286,7 @@ export namespace androidpublisher_v3 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -6070,8 +6298,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6079,8 +6306,7 @@ export namespace androidpublisher_v3 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -6092,8 +6318,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The package name of the application for which this subscription was
- * purchased (for example, 'com.some.thing').
+ * The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6101,8 +6326,7 @@ export namespace androidpublisher_v3 {
*/
subscriptionId?: string;
/**
- * The token provided to the user's device when the subscription was
- * purchased.
+ * The token provided to the user's device when the subscription was purchased.
*/
token?: string;
}
@@ -6208,12 +6432,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The time, in milliseconds since the Epoch, of the newest voided in-app
- * product purchase that you want to see in the response. The value of this
- * parameter cannot be greater than the current time and is ignored if a
- * pagination token is set. Default value is current time. Note: This filter
- * is applied on the time at which the record is seen as voided by our
- * systems and not the actual voided time returned in the response.
+ * The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
*/
endTime?: string;
/**
@@ -6221,8 +6440,7 @@ export namespace androidpublisher_v3 {
*/
maxResults?: number;
/**
- * The package name of the application for which voided purchases need to be
- * returned (for example, 'com.some.thing').
+ * The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
*/
packageName?: string;
/**
@@ -6230,12 +6448,7 @@ export namespace androidpublisher_v3 {
*/
startIndex?: number;
/**
- * The time, in milliseconds since the Epoch, of the oldest voided in-app
- * product purchase that you want to see in the response. The value of this
- * parameter cannot be older than 30 days and is ignored if a pagination
- * token is set. Default value is current time minus 30 days. Note: This
- * filter is applied on the time at which the record is seen as voided by
- * our systems and not the actual voided time returned in the response.
+ * The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
*/
startTime?: string;
/**
@@ -6325,8 +6538,7 @@ export namespace androidpublisher_v3 {
/**
* androidpublisher.reviews.list
- * @desc Returns a list of reviews. Only reviews from last week will be
- * returned.
+ * @desc Returns a list of reviews. Only reviews from last week will be returned.
* @alias androidpublisher.reviews.list
* @memberOf! ()
*
@@ -6486,8 +6698,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique identifier for the Android app for which we want reviews; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -6510,8 +6721,7 @@ export namespace androidpublisher_v3 {
*/
maxResults?: number;
/**
- * Unique identifier for the Android app for which we want reviews; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame".
*/
packageName?: string;
/**
@@ -6534,8 +6744,7 @@ export namespace androidpublisher_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Unique identifier for the Android app for which we want reviews; for
- * example, "com.spiffygame".
+ * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame".
*/
packageName?: string;
/**
diff --git a/src/apis/appengine/package.json b/src/apis/appengine/package.json
index 7415ce36f23..f06acf70b95 100644
--- a/src/apis/appengine/package.json
+++ b/src/apis/appengine/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts
index dca7a636b1f..13b70b4c218 100644
--- a/src/apis/appengine/v1.ts
+++ b/src/apis/appengine/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace appengine_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace appengine_v1 {
*/
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.
+ * 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;
/**
@@ -112,21 +108,21 @@ export namespace appengine_v1 {
apps: Resource$Apps;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.apps = new Resource$Apps(this.context);
}
}
/**
- * Google Cloud Endpoints
- * (https://cloud.google.com/appengine/docs/python/endpoints/) configuration
- * for API handlers.
+ * Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.
*/
export interface Schema$ApiConfigHandler {
/**
- * Action to take when users access resources that require authentication.
- * Defaults to redirect.
+ * Action to take when users access resources that require authentication. Defaults to redirect.
*/
authFailAction?: string;
/**
@@ -156,24 +152,19 @@ export namespace appengine_v1 {
scriptPath?: string;
}
/**
- * An Application resource contains the top-level configuration of an App
- * Engine application.
+ * An Application resource contains the top-level configuration of an App Engine application.
*/
export interface Schema$Application {
/**
- * Google Apps authentication domain that controls which users can access
- * this application.Defaults to open access for any Google Account.
+ * Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
*/
authDomain?: string;
/**
- * Google Cloud Storage bucket that can be used for storing files associated
- * with this application. This bucket is associated with the application and
- * can be used by the gcloud deployment commands.@OutputOnly
+ * Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
*/
codeBucket?: string;
/**
- * Google Cloud Storage bucket that can be used by this application to store
- * content.@OutputOnly
+ * Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
*/
defaultBucket?: string;
/**
@@ -181,14 +172,11 @@ export namespace appengine_v1 {
*/
defaultCookieExpiration?: string;
/**
- * Hostname used to reach this application, as resolved by App
- * Engine.@OutputOnly
+ * Hostname used to reach this application, as resolved by App Engine.@OutputOnly
*/
defaultHostname?: string;
/**
- * HTTP path dispatch rules for requests to the application that do not
- * explicitly target a service or version. Rules are order-dependent. Up to
- * 20 dispatch rules can be supported.
+ * HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
*/
dispatchRules?: Schema$UrlDispatchRule[];
/**
@@ -196,28 +184,20 @@ export namespace appengine_v1 {
*/
featureSettings?: Schema$FeatureSettings;
/**
- * The Google Container Registry domain used for storing managed build
- * docker images for this application.
+ * The Google Container Registry domain used for storing managed build docker images for this application.
*/
gcrDomain?: string;
iap?: Schema$IdentityAwareProxy;
/**
- * Identifier of the Application resource. This identifier is equivalent to
- * the project ID of the Google Cloud Platform project where you want to
- * deploy your application. Example: myapp.
+ * Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
*/
id?: string;
/**
- * Location from which this application runs. Application instances run out
- * of the data centers in the specified location, which is also where all of
- * the application's end user content is stored.Defaults to
- * us-central.View the list of supported locations
- * (https://cloud.google.com/appengine/docs/locations).
+ * Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
*/
locationId?: string;
/**
- * Full path to the Application resource in the API. Example:
- * apps/myapp.@OutputOnly
+ * Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
*/
name?: string;
/**
@@ -226,97 +206,65 @@ export namespace appengine_v1 {
servingStatus?: string;
}
/**
- * An SSL certificate that a user has been authorized to administer. A user is
- * authorized to administer any certificate that applies to one of their
- * authorized domains.
+ * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
*/
export interface Schema$AuthorizedCertificate {
/**
- * The SSL certificate serving the AuthorizedCertificate resource. This must
- * be obtained independently from a certificate authority.
+ * The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
*/
certificateRawData?: Schema$CertificateRawData;
/**
- * The user-specified display name of the certificate. This is not
- * guaranteed to be unique. Example: My Certificate.
+ * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
*/
displayName?: string;
/**
- * Aggregate count of the domain mappings with this certificate mapped. This
- * count includes domain mappings on applications for which the user does
- * not have VIEWER permissions.Only returned by GET or LIST requests when
- * specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+ * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
domainMappingsCount?: number;
/**
- * Topmost applicable domains of this certificate. This certificate applies
- * to these domains and their subdomains. Example: example.com.@OutputOnly
+ * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
*/
domainNames?: string[];
/**
- * The time when this certificate expires. To update the renewal time on
- * this certificate, upload an SSL certificate with a different expiration
- * time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
*/
expireTime?: string;
/**
- * Relative name of the certificate. This is a unique value autogenerated on
- * AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
*/
id?: string;
/**
- * Only applicable if this certificate is managed by App Engine. Managed
- * certificates are tied to the lifecycle of a DomainMapping and cannot be
- * updated or deleted via the AuthorizedCertificates API. If this
- * certificate is manually administered by the user, this field will be
- * empty.@OutputOnly
+ * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
*/
managedCertificate?: Schema$ManagedCertificate;
/**
- * Full path to the AuthorizedCertificate resource in the API. Example:
- * apps/myapp/authorizedCertificates/12345.@OutputOnly
+ * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
*/
name?: string;
/**
- * The full paths to user visible Domain Mapping resources that have this
- * certificate mapped. Example: apps/myapp/domainMappings/example.com.This
- * may not represent the full list of mapped domain mappings if the user
- * does not have VIEWER permissions on all of the applications that have
- * this certificate mapped. See domain_mappings_count for a complete
- * count.Only returned by GET or LIST requests when specifically requested
- * by the view=FULL_CERTIFICATE option.@OutputOnly
+ * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
visibleDomainMappings?: string[];
}
/**
- * A domain that a user has been authorized to administer. To authorize use of
- * a domain, verify ownership via Webmaster Central
- * (https://www.google.com/webmasters/verification/home).
+ * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).
*/
export interface Schema$AuthorizedDomain {
/**
- * Fully qualified domain name of the domain authorized for use. Example:
- * example.com.
+ * Fully qualified domain name of the domain authorized for use. Example: example.com.
*/
id?: string;
/**
- * Full path to the AuthorizedDomain resource in the API. Example:
- * apps/myapp/authorizedDomains/example.com.@OutputOnly
+ * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly
*/
name?: string;
}
/**
- * Automatic scaling is based on request rate, response latencies, and other
- * application metrics.
+ * Automatic scaling is based on request rate, response latencies, and other application metrics.
*/
export interface Schema$AutomaticScaling {
/**
- * The time period that the Autoscaler
- * (https://cloud.google.com/compute/docs/autoscaler/) should wait before it
- * starts collecting information from a new instance. This prevents the
- * autoscaler from collecting information when the instance is initializing,
- * during which the collected usage would not be reliable. Only applicable
- * in the App Engine flexible environment.
+ * The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
*/
coolDownPeriod?: string;
/**
@@ -328,39 +276,31 @@ export namespace appengine_v1 {
*/
diskUtilization?: Schema$DiskUtilization;
/**
- * Number of concurrent requests an automatic scaling instance can accept
- * before the scheduler spawns a new instance.Defaults to a runtime-specific
- * value.
+ * Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
*/
maxConcurrentRequests?: number;
/**
- * Maximum number of idle instances that should be maintained for this
- * version.
+ * Maximum number of idle instances that should be maintained for this version.
*/
maxIdleInstances?: number;
/**
- * Maximum amount of time that a request should wait in the pending queue
- * before starting a new instance to handle it.
+ * Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
*/
maxPendingLatency?: string;
/**
- * Maximum number of instances that should be started to handle requests for
- * this version.
+ * Maximum number of instances that should be started to handle requests for this version.
*/
maxTotalInstances?: number;
/**
- * Minimum number of idle instances that should be maintained for this
- * version. Only applicable for the default version of a service.
+ * Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
*/
minIdleInstances?: number;
/**
- * Minimum amount of time a request should wait in the pending queue before
- * starting a new instance to handle it.
+ * Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
*/
minPendingLatency?: string;
/**
- * Minimum number of running instances that should be maintained for this
- * version.
+ * Minimum number of running instances that should be maintained for this version.
*/
minTotalInstances?: number;
/**
@@ -377,15 +317,11 @@ export namespace appengine_v1 {
standardSchedulerSettings?: Schema$StandardSchedulerSettings;
}
/**
- * A service with basic scaling will create an instance when the application
- * receives a request. The instance will be turned down when the app becomes
- * idle. Basic scaling is ideal for work that is intermittent or driven by
- * user activity.
+ * A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
*/
export interface Schema$BasicScaling {
/**
- * Duration of time after the last request that an instance must wait before
- * the instance is shut down.
+ * Duration of time after the last request that an instance must wait before the instance is shut down.
*/
idleTimeout?: string;
/**
@@ -416,51 +352,33 @@ export namespace appengine_v1 {
*/
export interface Schema$CertificateRawData {
/**
- * Unencrypted PEM encoded RSA private key. This field is set once on
- * certificate creation and then encrypted. The key size must be 2048 bits
- * or fewer. Must include the header and footer. Example: <pre>
- * -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END
- * RSA PRIVATE KEY----- </pre> @InputOnly
+ * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly
*/
privateKey?: string;
/**
- * PEM encoded x.509 public key certificate. This field is set once on
- * certificate creation. Must include the header and footer. Example:
- * <pre> -----BEGIN CERTIFICATE----- <certificate_value>
- * -----END CERTIFICATE----- </pre>
+ * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre>
*/
publicCertificate?: string;
}
/**
- * Options for the build operations performed as a part of the version
- * deployment. Only applicable for App Engine flexible environment when
- * creating a version using source code directly.
+ * Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.
*/
export interface Schema$CloudBuildOptions {
/**
- * Path to the yaml file used in deployment, used to determine runtime
- * configuration details.Required for flexible environment builds.See
- * https://cloud.google.com/appengine/docs/standard/python/config/appref for
- * more details.
+ * Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
*/
appYamlPath?: string;
/**
- * The Cloud Build timeout used as part of any dependent builds performed by
- * version creation. Defaults to 10 minutes.
+ * The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
*/
cloudBuildTimeout?: string;
}
/**
- * Docker image that is used to create a container and start a VM instance for
- * the version that you deploy. Only applicable for instances running in the
- * App Engine flexible environment.
+ * Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.
*/
export interface Schema$ContainerInfo {
/**
- * URI to the hosted container image in Google Container Registry. The URI
- * must be fully qualified and include a tag or digest. Examples:
- * "gcr.io/my-project/image:tag" or
- * "gcr.io/my-project/image@digest"
+ * URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
*/
image?: string;
}
@@ -473,41 +391,34 @@ export namespace appengine_v1 {
*/
aggregationWindowLength?: string;
/**
- * Target CPU utilization ratio to maintain when scaling. Must be between 0
- * and 1.
+ * Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
*/
targetUtilization?: number;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1 {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1alpha.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1Alpha {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1beta.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1Beta {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
@@ -516,11 +427,7 @@ export namespace appengine_v1 {
*/
export interface Schema$DebugInstanceRequest {
/**
- * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa
- * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh
- * {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For
- * more information, see Adding and Removing SSH Keys
- * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
+ * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
*/
sshKey?: string;
}
@@ -529,21 +436,15 @@ export namespace appengine_v1 {
*/
export interface Schema$Deployment {
/**
- * Options for any Google Cloud Build builds created as a part of this
- * deployment.These options will only be used if a new build is created,
- * such as when deploying to the App Engine flexible environment using files
- * or zip.
+ * Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
*/
cloudBuildOptions?: Schema$CloudBuildOptions;
/**
- * The Docker image for the container that runs the version. Only applicable
- * for instances running in the App Engine flexible environment.
+ * The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
*/
container?: Schema$ContainerInfo;
/**
- * Manifest of the files stored in Google Cloud Storage that are included as
- * part of this version. All files must be readable using the credentials
- * supplied with this call.
+ * Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
*/
files?: {[key: string]: Schema$FileInfo};
/**
@@ -552,8 +453,7 @@ export namespace appengine_v1 {
zip?: Schema$ZipInfo;
}
/**
- * Target scaling by disk usage. Only applicable in the App Engine flexible
- * environment.
+ * Target scaling by disk usage. Only applicable in the App Engine flexible environment.
*/
export interface Schema$DiskUtilization {
/**
@@ -578,71 +478,44 @@ export namespace appengine_v1 {
*/
export interface Schema$DomainMapping {
/**
- * Relative name of the domain serving the application. Example:
- * example.com.
+ * Relative name of the domain serving the application. Example: example.com.
*/
id?: string;
/**
- * Full path to the DomainMapping resource in the API. Example:
- * apps/myapp/domainMapping/example.com.@OutputOnly
+ * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
*/
name?: string;
/**
- * The resource records required to configure this domain mapping. These
- * records must be added to the domain's DNS configuration in order to
- * serve the application via this domain mapping.@OutputOnly
+ * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
*/
resourceRecords?: Schema$ResourceRecord[];
/**
- * SSL configuration for this domain. If unconfigured, this domain will not
- * serve with SSL.
+ * SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
*/
sslSettings?: Schema$SslSettings;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for Empty is empty JSON object {}.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
*/
export interface Schema$Empty {}
/**
- * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The
- * Endpoints API Service provides tooling for serving Open API and gRPC
- * endpoints via an NGINX proxy. Only valid for App Engine Flexible
- * environment deployments.The fields here refer to the name and configuration
- * ID of a "service" resource in the Service Management API
- * (https://cloud.google.com/service-management/overview).
+ * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview).
*/
export interface Schema$EndpointsApiService {
/**
- * Endpoints service configuration ID as specified by the Service Management
- * API. For example "2016-09-19r1".By default, the rollout
- * strategy for Endpoints is RolloutStrategy.FIXED. This means that
- * Endpoints starts up with a particular configuration ID. When a new
- * configuration is rolled out, Endpoints must be given the new
- * configuration ID. The config_id field is used to give the configuration
- * ID and is required in this case.Endpoints also has a rollout strategy
- * called RolloutStrategy.MANAGED. When using this, Endpoints fetches the
- * latest configuration and does not need the configuration ID. In this
- * case, config_id must be omitted.
+ * Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
*/
configId?: string;
/**
- * Enable or disable trace sampling. By default, this is set to false for
- * enabled.
+ * Enable or disable trace sampling. By default, this is set to false for enabled.
*/
disableTraceSampling?: boolean;
/**
- * Endpoints service name which is the name of the "service"
- * resource in the Service Management API. For example
- * "myapi.endpoints.myproject.cloud.goog"
+ * Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
*/
name?: string;
/**
- * Endpoints rollout strategy. If FIXED, config_id must be specified. If
- * MANAGED, config_id must be omitted.
+ * Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
*/
rolloutStrategy?: string;
}
@@ -673,34 +546,24 @@ export namespace appengine_v1 {
staticFile?: string;
}
/**
- * The feature specific settings to be used in the application. These define
- * behaviors that are user configurable.
+ * The feature specific settings to be used in the application. These define behaviors that are user configurable.
*/
export interface Schema$FeatureSettings {
/**
- * Boolean value indicating if split health checks should be used instead of
- * the legacy health checks. At an app.yaml level, this means defaulting to
- * 'readiness_check' and 'liveness_check' values instead of
- * 'health_check' ones. Once the legacy 'health_check'
- * behavior is deprecated, and this value is always true, this setting can
- * be removed.
+ * Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
*/
splitHealthChecks?: boolean;
/**
- * If true, use Container-Optimized OS
- * (https://cloud.google.com/container-optimized-os/) base image for VMs,
- * rather than a base Debian image.
+ * If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.
*/
useContainerOptimizedOs?: boolean;
}
/**
- * Single source file that is part of the version to be deployed. Each source
- * file that is deployed must be specified separately.
+ * Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
*/
export interface Schema$FileInfo {
/**
- * The MIME type of the file.Defaults to the value from Google Cloud
- * Storage.
+ * The MIME type of the file.Defaults to the value from Google Cloud Storage.
*/
mimeType?: string;
/**
@@ -708,15 +571,12 @@ export namespace appengine_v1 {
*/
sha1Sum?: string;
/**
- * URL source to use to fetch this file. Must be a URL to a resource in
- * Google Cloud Storage in the form
- * 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ * URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
*/
sourceUrl?: string;
}
/**
- * A single firewall rule that is evaluated against incoming traffic and
- * provides an action to take on matched requests.
+ * A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
*/
export interface Schema$FirewallRule {
/**
@@ -724,35 +584,20 @@ export namespace appengine_v1 {
*/
action?: string;
/**
- * An optional string description of this rule. This field has a maximum
- * length of 100 characters.
+ * An optional string description of this rule. This field has a maximum length of 100 characters.
*/
description?: string;
/**
- * A positive integer between 1, Int32.MaxValue-1 that defines the order of
- * rule evaluation. Rules with the lowest priority are evaluated first.A
- * default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic
- * when no previous rule matches. Only the action of this rule can be
- * modified by the user.
+ * A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
*/
priority?: number;
/**
- * IP address or range, defined using CIDR notation, of requests that this
- * rule applies to. You can use the wildcard character "*" to
- * match all IPs equivalent to "0/0" and "::/0"
- * together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or
- * 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be
- * silently performed on addresses which are not properly truncated. For
- * example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24.
- * Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as
- * 2001:db8::/32.
+ * IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
*/
sourceRange?: string;
}
/**
- * Health checking configuration for VM instances. Unhealthy instances are
- * killed and replaced with new instances. Only applicable for instances in
- * App Engine flexible environment.
+ * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
*/
export interface Schema$HealthCheck {
/**
@@ -764,18 +609,15 @@ export namespace appengine_v1 {
*/
disableHealthCheck?: boolean;
/**
- * Number of consecutive successful health checks required before receiving
- * traffic.
+ * Number of consecutive successful health checks required before receiving traffic.
*/
healthyThreshold?: number;
/**
- * Host header to send when performing an HTTP health check. Example:
- * "myapp.appspot.com"
+ * Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
*/
host?: string;
/**
- * Number of consecutive failed health checks required before an instance is
- * restarted.
+ * Number of consecutive failed health checks required before an instance is restarted.
*/
restartThreshold?: number;
/**
@@ -783,8 +625,7 @@ export namespace appengine_v1 {
*/
timeout?: string;
/**
- * Number of consecutive failed health checks required before removing
- * traffic.
+ * Number of consecutive failed health checks required before removing traffic.
*/
unhealthyThreshold?: number;
}
@@ -793,9 +634,7 @@ export namespace appengine_v1 {
*/
export interface Schema$IdentityAwareProxy {
/**
- * Whether the serving infrastructure will authenticate and authorize all
- * incoming requests.If true, the oauth2_client_id and oauth2_client_secret
- * fields must be non-empty.
+ * Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
*/
enabled?: boolean;
/**
@@ -803,10 +642,7 @@ export namespace appengine_v1 {
*/
oauth2ClientId?: string;
/**
- * OAuth2 client secret to use for the authentication flow.For security
- * reasons, this value cannot be retrieved via the API. Instead, the SHA-256
- * hash of the value is returned in the oauth2_client_secret_sha256
- * field.@InputOnly
+ * OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
*/
oauth2ClientSecret?: string;
/**
@@ -815,8 +651,7 @@ export namespace appengine_v1 {
oauth2ClientSecretSha256?: string;
}
/**
- * An Instance resource is the computing unit that App Engine uses to
- * automatically scale an application.
+ * An Instance resource is the computing unit that App Engine uses to automatically scale an application.
*/
export interface Schema$Instance {
/**
@@ -836,8 +671,7 @@ export namespace appengine_v1 {
*/
errors?: number;
/**
- * Relative name of the instance within the version. Example:
- * instance-1.@OutputOnly
+ * Relative name of the instance within the version. Example: instance-1.@OutputOnly
*/
id?: string;
/**
@@ -845,8 +679,7 @@ export namespace appengine_v1 {
*/
memoryUsage?: string;
/**
- * Full path to the Instance resource in the API. Example:
- * apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly
+ * Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly
*/
name?: string;
/**
@@ -862,33 +695,27 @@ export namespace appengine_v1 {
*/
startTime?: string;
/**
- * Whether this instance is in debug mode. Only applicable for instances in
- * App Engine flexible environment.@OutputOnly
+ * Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmDebugEnabled?: boolean;
/**
- * Virtual machine ID of this instance. Only applicable for instances in App
- * Engine flexible environment.@OutputOnly
+ * Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmId?: string;
/**
- * The IP address of this instance. Only applicable for instances in App
- * Engine flexible environment.@OutputOnly
+ * The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmIp?: string;
/**
- * Name of the virtual machine where this instance lives. Only applicable
- * for instances in App Engine flexible environment.@OutputOnly
+ * Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmName?: string;
/**
- * Status of the virtual machine where this instance lives. Only applicable
- * for instances in App Engine flexible environment.@OutputOnly
+ * Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmStatus?: string;
/**
- * Zone where the virtual machine is located. Only applicable for instances
- * in App Engine flexible environment.@OutputOnly
+ * Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmZoneName?: string;
}
@@ -1023,8 +850,7 @@ export namespace appengine_v1 {
versions?: Schema$Version[];
}
/**
- * Health checking configuration for VM instances. Unhealthy instances are
- * killed and replaced with new instances.
+ * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
*/
export interface Schema$LivenessCheck {
/**
@@ -1032,13 +858,11 @@ export namespace appengine_v1 {
*/
checkInterval?: string;
/**
- * Number of consecutive failed checks required before considering the VM
- * unhealthy.
+ * Number of consecutive failed checks required before considering the VM unhealthy.
*/
failureThreshold?: number;
/**
- * Host header to send when performing a HTTP Liveness check. Example:
- * "myapp.appspot.com"
+ * Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
*/
host?: string;
/**
@@ -1050,8 +874,7 @@ export namespace appengine_v1 {
*/
path?: string;
/**
- * Number of consecutive successful checks required before considering the
- * VM healthy.
+ * Number of consecutive successful checks required before considering the VM healthy.
*/
successThreshold?: number;
/**
@@ -1064,13 +887,11 @@ export namespace appengine_v1 {
*/
export interface Schema$Location {
/**
- * The friendly name for this location, typically a nearby city name. For
- * example, "Tokyo".
+ * The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string;
/**
- * Cross-service attributes for the location. For example
- * {"cloud.googleapis.com/region": "us-east1"}
+ * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {[key: string]: string};
/**
@@ -1078,13 +899,11 @@ export namespace appengine_v1 {
*/
locationId?: string;
/**
- * Service-specific metadata. For example the available capacity at the
- * given location.
+ * Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {[key: string]: any};
/**
- * Resource name for the location, which may vary between implementations.
- * For example: "projects/example-project/locations/us-east1"
+ * Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
*/
name?: string;
}
@@ -1093,13 +912,11 @@ export namespace appengine_v1 {
*/
export interface Schema$LocationMetadata {
/**
- * App Engine flexible environment is available in the given
- * location.@OutputOnly
+ * App Engine flexible environment is available in the given location.@OutputOnly
*/
flexibleEnvironmentAvailable?: boolean;
/**
- * App Engine standard environment is available in the given
- * location.@OutputOnly
+ * App Engine standard environment is available in the given location.@OutputOnly
*/
standardEnvironmentAvailable?: boolean;
}
@@ -1108,78 +925,50 @@ export namespace appengine_v1 {
*/
export interface Schema$ManagedCertificate {
/**
- * Time at which the certificate was last renewed. The renewal process is
- * fully managed. Certificate renewal will automatically occur before the
- * certificate expires. Renewal errors can be tracked via
- * ManagementStatus.@OutputOnly
+ * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
*/
lastRenewalTime?: string;
/**
- * Status of certificate management. Refers to the most recent certificate
- * acquisition or renewal attempt.@OutputOnly
+ * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
*/
status?: string;
}
/**
- * A service with manual scaling runs continuously, allowing you to perform
- * complex initialization and rely on the state of its memory over time.
+ * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
*/
export interface Schema$ManualScaling {
/**
- * Number of instances to assign to the service at the start. This number
- * can later be altered by using the Modules API
- * (https://cloud.google.com/appengine/docs/python/modules/functions)
- * set_num_instances() function.
+ * Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
*/
instances?: number;
}
/**
- * Extra network settings. Only applicable in the App Engine flexible
- * environment.
+ * Extra network settings. Only applicable in the App Engine flexible environment.
*/
export interface Schema$Network {
/**
- * List of ports, or port pairs, to forward from the virtual machine to the
- * application container. Only applicable in the App Engine flexible
- * environment.
+ * List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
*/
forwardedPorts?: string[];
/**
- * Tag to apply to the instance during creation. Only applicable in the App
- * Engine flexible environment.
+ * Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
*/
instanceTag?: string;
/**
- * Google Compute Engine network where the virtual machines are created.
- * Specify the short name, not the resource path.Defaults to default.
+ * Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
*/
name?: string;
/**
- * Enable session affinity. Only applicable in the App Engine flexible
- * environment.
+ * Enable session affinity. Only applicable in the App Engine flexible environment.
*/
sessionAffinity?: boolean;
/**
- * Google Cloud Platform sub-network where the virtual machines are created.
- * Specify the short name, not the resource path.If a subnetwork name is
- * specified, a network name will also be required unless it is for the
- * default network. If the network that the instance is being created in is
- * a Legacy network, then the IP address is allocated from the IPv4Range. If
- * the network that the instance is being created in is an auto Subnet Mode
- * Network, then only network name should be specified (not the
- * subnetwork_name) and the IP address is created from the IPCidrRange of
- * the subnetwork that exists in that zone for that network. If the network
- * that the instance is being created in is a custom Subnet Mode Network,
- * then the subnetwork_name must be specified and the IP address is created
- * from the IPCidrRange of the subnetwork.If specified, the subnetwork must
- * exist in the same region as the App Engine flexible environment
- * application.
+ * Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
*/
subnetworkName?: string;
}
/**
- * Target scaling by network usage. Only applicable in the App Engine flexible
- * environment.
+ * Target scaling by network usage. Only applicable in the App Engine flexible environment.
*/
export interface Schema$NetworkUtilization {
/**
@@ -1200,14 +989,11 @@ export namespace appengine_v1 {
targetSentPacketsPerSecond?: number;
}
/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
+ * This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
- * If the value is false, it means the operation is still in progress. If
- * true, the operation is completed, and either error or response is
- * available.
+ * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
*/
done?: boolean;
/**
@@ -1215,26 +1001,15 @@ export namespace appengine_v1 {
*/
error?: Schema$Status;
/**
- * Service-specific metadata associated with the operation. It typically
- * contains progress information and common metadata such as create time.
- * Some services might not provide such metadata. Any method that returns a
- * long-running operation should document the metadata type, if any.
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any};
/**
- * The server-assigned name, which is only unique within the same service
- * that originally returns it. If you use the default HTTP mapping, the name
- * should have the format of operations/some/unique/name.
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
*/
name?: string;
/**
- * The normal response of the operation in case of success. If the original
- * method returns no data on success, such as Delete, the response is
- * google.protobuf.Empty. If the original method is standard
- * Get/Create/Update, the response should be the resource. For other
- * methods, the response should have the type XxxResponse, where Xxx is the
- * original method name. For example, if the original method name is
- * TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
*/
response?: {[key: string]: any};
}
@@ -1248,8 +1023,7 @@ export namespace appengine_v1 {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -1257,13 +1031,11 @@ export namespace appengine_v1 {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -1285,8 +1057,7 @@ export namespace appengine_v1 {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -1294,13 +1065,11 @@ export namespace appengine_v1 {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -1322,8 +1091,7 @@ export namespace appengine_v1 {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -1331,13 +1099,11 @@ export namespace appengine_v1 {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1beta.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -1350,14 +1116,11 @@ export namespace appengine_v1 {
warning?: string[];
}
/**
- * Readiness checking configuration for VM instances. Unhealthy instances are
- * removed from traffic rotation.
+ * Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
*/
export interface Schema$ReadinessCheck {
/**
- * A maximum time limit on application initialization, measured from moment
- * the application successfully replies to a healthcheck until it is ready
- * to serve traffic.
+ * A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
*/
appStartTimeout?: string;
/**
@@ -1369,8 +1132,7 @@ export namespace appengine_v1 {
*/
failureThreshold?: number;
/**
- * Host header to send when performing a HTTP Readiness check. Example:
- * "myapp.appspot.com"
+ * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
*/
host?: string;
/**
@@ -1378,8 +1140,7 @@ export namespace appengine_v1 {
*/
path?: string;
/**
- * Number of consecutive successful checks required before receiving
- * traffic.
+ * Number of consecutive successful checks required before receiving traffic.
*/
successThreshold?: number;
/**
@@ -1392,8 +1153,7 @@ export namespace appengine_v1 {
*/
export interface Schema$RepairApplicationRequest {}
/**
- * Target scaling by request utilization. Only applicable in the App Engine
- * flexible environment.
+ * Target scaling by request utilization. Only applicable in the App Engine flexible environment.
*/
export interface Schema$RequestUtilization {
/**
@@ -1410,13 +1170,11 @@ export namespace appengine_v1 {
*/
export interface Schema$ResourceRecord {
/**
- * Relative name of the object affected by this record. Only applicable for
- * CNAME records. Example: 'www'.
+ * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
*/
name?: string;
/**
- * Data for this record. Values vary by record type, as defined in RFC 1035
- * (section 5) and RFC 1034 (section 3.6.1).
+ * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
*/
rrdata?: string;
/**
@@ -1455,27 +1213,19 @@ export namespace appengine_v1 {
scriptPath?: string;
}
/**
- * A Service resource is a logical component of an application that can share
- * state and communicate in a secure fashion with other services. For example,
- * an application that handles customer requests might include separate
- * services to handle tasks such as backend data analysis or API requests from
- * mobile devices. Each service has a collection of versions that define a
- * specific set of code used to implement the functionality of that service.
+ * A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
*/
export interface Schema$Service {
/**
- * Relative name of the service within the application. Example:
- * default.@OutputOnly
+ * Relative name of the service within the application. Example: default.@OutputOnly
*/
id?: string;
/**
- * Full path to the Service resource in the API. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
*/
name?: string;
/**
- * Mapping that defines fractional HTTP traffic diversion to different
- * versions within the service.
+ * Mapping that defines fractional HTTP traffic diversion to different versions within the service.
*/
split?: Schema$TrafficSplit;
}
@@ -1484,29 +1234,15 @@ export namespace appengine_v1 {
*/
export interface Schema$SslSettings {
/**
- * ID of the AuthorizedCertificate resource configuring SSL for the
- * application. Clearing this field will remove SSL support.By default, a
- * managed certificate is automatically created for every domain mapping. To
- * omit SSL support or to configure SSL manually, specify
- * SslManagementType.MANUAL on a CREATE or UPDATE request. You must be
- * authorized to administer the AuthorizedCertificate resource to manually
- * map it to a DomainMapping resource. Example: 12345.
+ * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
*/
certificateId?: string;
/**
- * ID of the managed AuthorizedCertificate resource currently being
- * provisioned, if applicable. Until the new managed certificate has been
- * successfully provisioned, the previous SSL state will be preserved. Once
- * the provisioning process completes, the certificate_id field will reflect
- * the new managed certificate and this field will be left empty. To remove
- * SSL support while there is still a pending managed certificate, clear the
- * certificate_id field with an UpdateDomainMappingRequest.@OutputOnly
+ * ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly
*/
pendingManagedCertificateId?: string;
/**
- * SSL management type for this domain. If AUTOMATIC, a managed certificate
- * is automatically provisioned. If MANUAL, certificate_id must be manually
- * specified in order to configure SSL for this domain.
+ * SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
*/
sslManagementType?: string;
}
@@ -1515,13 +1251,11 @@ export namespace appengine_v1 {
*/
export interface Schema$StandardSchedulerSettings {
/**
- * Maximum number of instances to run for this version. Set to zero to
- * disable max_instances configuration.
+ * Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.
*/
maxInstances?: number;
/**
- * Minimum number of instances to run for this version. Set to zero to
- * disable min_instances configuration.
+ * Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
*/
minInstances?: number;
/**
@@ -1534,23 +1268,15 @@ export namespace appengine_v1 {
targetThroughputUtilization?: number;
}
/**
- * Files served directly to the user for a given URL, such as images, CSS
- * stylesheets, or JavaScript source files. Static file handlers describe
- * which files in the application directory are static files, and which URLs
- * serve them.
+ * Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.
*/
export interface Schema$StaticFilesHandler {
/**
- * Whether files should also be uploaded as code data. By default, files
- * declared in static file handlers are uploaded as static data and are only
- * served to end users; they cannot be read by the application. If enabled,
- * uploads are charged against both your code and static data storage
- * resource quotas.
+ * Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
*/
applicationReadable?: boolean;
/**
- * Time a static file served by this handler should be cached by web proxies
- * and browsers.
+ * Time a static file served by this handler should be cached by web proxies and browsers.
*/
expiration?: string;
/**
@@ -1558,62 +1284,24 @@ export namespace appengine_v1 {
*/
httpHeaders?: {[key: string]: string};
/**
- * MIME type used to serve all files served by this handler.Defaults to
- * file-specific MIME types, which are derived from each file's filename
- * extension.
+ * MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
*/
mimeType?: string;
/**
- * Path to the static files matched by the URL pattern, from the application
- * root directory. The path can refer to text matched in groupings in the
- * URL pattern.
+ * Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
*/
path?: string;
/**
- * Whether this handler should match the request if the file referenced by
- * the handler does not exist.
+ * Whether this handler should match the request if the file referenced by the handler does not exist.
*/
requireMatchingFile?: boolean;
/**
- * Regular expression that matches the file paths for all files that should
- * be referenced by this handler.
+ * Regular expression that matches the file paths for all files that should be referenced by this handler.
*/
uploadPathRegex?: string;
}
/**
- * The Status type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by gRPC (https://github.com/grpc). The error model is designed to be:
- * Simple to use and understand for most users Flexible enough to meet
- * unexpected needsOverviewThe Status message contains three pieces of data:
- * error code, error message, and error details. The error code should be an
- * enum value of google.rpc.Code, but it may accept additional error codes if
- * needed. The error message should be a developer-facing English message that
- * helps developers understand and resolve the error. If a localized
- * user-facing error message is needed, put the localized message in the error
- * details or localize it in the client. The optional error details may
- * contain arbitrary information about the error. There is a predefined set of
- * error detail types in the package google.rpc that can be used for common
- * error conditions.Language mappingThe Status message is the logical
- * representation of the error model, but it is not necessarily the actual
- * wire format. When the Status message is exposed in different client
- * libraries and different wire protocols, it can be mapped differently. For
- * example, it will likely be mapped to some exceptions in Java, but more
- * likely mapped to some error codes in C.Other usesThe error model and the
- * Status message can be used in a variety of environments, either with or
- * without APIs, to provide a consistent developer experience across different
- * environments.Example uses of this error model include: Partial errors. If a
- * service needs to return partial errors to the client, it may embed the
- * Status in the normal response to indicate the partial errors. Workflow
- * errors. A typical workflow has multiple steps. Each step may have a Status
- * message for error reporting. Batch operations. If a client uses batch
- * request and batch response, the Status message should be used directly
- * inside batch response, one for each error sub-response. Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the Status message. Logging. If some API errors are stored in logs,
- * the message Status could be used directly after any stripping needed for
- * security/privacy reasons.
+ * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -1621,37 +1309,24 @@ export namespace appengine_v1 {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set of
- * message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
- * Traffic routing configuration for versions within a single service. Traffic
- * splits define how traffic directed to the service is assigned to versions.
+ * Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
*/
export interface Schema$TrafficSplit {
/**
- * Mapping from version IDs within the service to fractional (0.000, 1]
- * allocations of traffic for that version. Each version can be specified
- * only once, but some versions in the service may not have any traffic
- * allocation. Services that have traffic allocated cannot be deleted until
- * either the service is deleted or their traffic allocation is removed.
- * Allocations must sum to 1. Up to two decimal place precision is supported
- * for IP-based splits and up to three decimal places is supported for
- * cookie-based splits.
+ * Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
*/
allocations?: {[key: string]: number};
/**
- * Mechanism used to determine which version a request is sent to. The
- * traffic selection algorithm will be stable for either type until
- * allocations are changed.
+ * Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
*/
shardBy?: string;
}
@@ -1660,27 +1335,20 @@ export namespace appengine_v1 {
*/
export interface Schema$UrlDispatchRule {
/**
- * Domain name to match against. The wildcard "*" is supported if
- * specified before a period: "*.".Defaults to matching all
- * domains: "*".
+ * Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
*/
domain?: string;
/**
- * Pathname within the host. Must start with a "/". A single
- * "*" can be included at the end of the path.The sum of the
- * lengths of the domain and path may not exceed 100 characters.
+ * Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
*/
path?: string;
/**
- * Resource ID of a service in this application that should serve the
- * matched request. The service must already exist. Example: default.
+ * Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
*/
service?: string;
}
/**
- * URL pattern and description of how the URL should be handled. App Engine
- * can handle URLs by executing application code or by serving static files
- * uploaded with the version, such as images, CSS, or JavaScript.
+ * URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
*/
export interface Schema$UrlMap {
/**
@@ -1688,24 +1356,19 @@ export namespace appengine_v1 {
*/
apiEndpoint?: Schema$ApiEndpointHandler;
/**
- * Action to take when users access resources that require authentication.
- * Defaults to redirect.
+ * Action to take when users access resources that require authentication. Defaults to redirect.
*/
authFailAction?: string;
/**
- * Level of login required to access this resource. Not supported for
- * Node.js in the App Engine standard environment.
+ * Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
*/
login?: string;
/**
- * 30x code to use when performing redirects for the secure field. Defaults
- * to 302.
+ * 30x code to use when performing redirects for the secure field. Defaults to 302.
*/
redirectHttpResponseCode?: string;
/**
- * Executes a script to handle the requests that match this URL pattern.
- * Only the auto value is supported for Node.js in the App Engine standard
- * environment, for example "script": "auto".
+ * Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
*/
script?: Schema$ScriptHandler;
/**
@@ -1717,39 +1380,28 @@ export namespace appengine_v1 {
*/
staticFiles?: Schema$StaticFilesHandler;
/**
- * URL prefix. Uses regular expression syntax, which means regexp special
- * characters must be escaped, but should not contain groupings. All URLs
- * that begin with this prefix are handled by this handler, using the
- * portion of the URL after the prefix as part of the file path.
+ * URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
*/
urlRegex?: string;
}
/**
- * A Version resource is a specific set of source code and configuration files
- * that are deployed into a service.
+ * A Version resource is a specific set of source code and configuration files that are deployed into a service.
*/
export interface Schema$Version {
/**
- * Serving configuration for Google Cloud Endpoints
- * (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned
- * in GET requests if view=FULL is set.
+ * Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
*/
apiConfig?: Schema$ApiConfigHandler;
/**
- * Automatic scaling is based on request rate, response latencies, and other
- * application metrics.
+ * Automatic scaling is based on request rate, response latencies, and other application metrics.
*/
automaticScaling?: Schema$AutomaticScaling;
/**
- * A service with basic scaling will create an instance when the application
- * receives a request. The instance will be turned down when the app becomes
- * idle. Basic scaling is ideal for work that is intermittent or driven by
- * user activity.
+ * A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
*/
basicScaling?: Schema$BasicScaling;
/**
- * Metadata settings that are supplied to this version to enable beta
- * runtime features.
+ * Metadata settings that are supplied to this version to enable beta runtime features.
*/
betaSettings?: {[key: string]: string};
/**
@@ -1761,27 +1413,19 @@ export namespace appengine_v1 {
*/
createTime?: string;
/**
- * Duration that static files should be cached by web proxies and browsers.
- * Only applicable if the corresponding StaticFilesHandler
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler)
- * does not specify its own expiration time.Only returned in GET requests if
- * view=FULL is set.
+ * Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
*/
defaultExpiration?: string;
/**
- * Code and application artifacts that make up this version.Only returned in
- * GET requests if view=FULL is set.
+ * Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
*/
deployment?: Schema$Deployment;
/**
- * Total size in bytes of all the files that are included in this version
- * and currently hosted on the App Engine disk.@OutputOnly
+ * Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
*/
diskUsageBytes?: string;
/**
- * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud
- * Endpoints Extensible Service Proxy will be provided to serve the API
- * implemented by the app.
+ * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
*/
endpointsApiService?: Schema$EndpointsApiService;
/**
@@ -1793,88 +1437,63 @@ export namespace appengine_v1 {
*/
env?: string;
/**
- * Environment variables available to the application.Only returned in GET
- * requests if view=FULL is set.
+ * Environment variables available to the application.Only returned in GET requests if view=FULL is set.
*/
envVariables?: {[key: string]: string};
/**
- * Custom static error pages. Limited to 10KB per page.Only returned in GET
- * requests if view=FULL is set.
+ * Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
*/
errorHandlers?: Schema$ErrorHandler[];
/**
- * An ordered list of URL-matching patterns that should be applied to
- * incoming requests. The first matching URL handles the request and other
- * request handlers are not attempted.Only returned in GET requests if
- * view=FULL is set.
+ * An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
*/
handlers?: Schema$UrlMap[];
/**
- * Configures health checking for instances. Unhealthy instances are stopped
- * and replaced with new instances. Only applicable in the App Engine
- * flexible environment.Only returned in GET requests if view=FULL is set.
+ * Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.
*/
healthCheck?: Schema$HealthCheck;
/**
- * Relative name of the version within the service. Example: v1. Version
- * names can contain only lowercase letters, numbers, or hyphens. Reserved
- * names: "default", "latest", and any name with the
- * prefix "ah-".
+ * Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
*/
id?: string;
/**
- * Before an application can receive email or XMPP messages, the application
- * must be configured to enable the service.
+ * Before an application can receive email or XMPP messages, the application must be configured to enable the service.
*/
inboundServices?: string[];
/**
- * Instance class that is used to run this version. Valid values are:
- * AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1,
- * B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for
- * ManualScaling or BasicScaling.
+ * Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
*/
instanceClass?: string;
/**
- * Configuration for third-party Python runtime libraries that are required
- * by the application.Only returned in GET requests if view=FULL is set.
+ * Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
*/
libraries?: Schema$Library[];
/**
- * Configures liveness health checking for instances. Unhealthy instances
- * are stopped and replaced with new instancesOnly returned in GET requests
- * if view=FULL is set.
+ * Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
*/
livenessCheck?: Schema$LivenessCheck;
/**
- * A service with manual scaling runs continuously, allowing you to perform
- * complex initialization and rely on the state of its memory over time.
+ * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
*/
manualScaling?: Schema$ManualScaling;
/**
- * Full path to the Version resource in the API. Example:
- * apps/myapp/services/default/versions/v1.@OutputOnly
+ * Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
*/
name?: string;
/**
- * Extra network settings. Only applicable in the App Engine flexible
- * environment.
+ * Extra network settings. Only applicable in the App Engine flexible environment.
*/
network?: Schema$Network;
/**
- * Files that match this pattern will not be built into this version. Only
- * applicable for Go runtimes.Only returned in GET requests if view=FULL is
- * set.
+ * Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
*/
nobuildFilesRegex?: string;
/**
- * Configures readiness health checking for instances. Unhealthy instances
- * are not put into the backend traffic rotation.Only returned in GET
- * requests if view=FULL is set.
+ * Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
*/
readinessCheck?: Schema$ReadinessCheck;
/**
- * Machine resources for this version. Only applicable in the App Engine
- * flexible environment.
+ * Machine resources for this version. Only applicable in the App Engine flexible environment.
*/
resources?: Schema$Resources;
/**
@@ -1882,14 +1501,11 @@ export namespace appengine_v1 {
*/
runtime?: string;
/**
- * The version of the API in the given runtime environment. Please see the
- * app.yaml reference for valid values at
- * https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ * The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
*/
runtimeApiVersion?: string;
/**
- * The channel of the runtime to use. Only available for some runtimes.
- * Defaults to the default channel.
+ * The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
*/
runtimeChannel?: string;
/**
@@ -1897,9 +1513,7 @@ export namespace appengine_v1 {
*/
runtimeMainExecutablePath?: string;
/**
- * Current serving status of this version. Only the versions with a SERVING
- * status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is
- * an invalid value. Defaults to SERVING.
+ * Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
*/
servingStatus?: string;
/**
@@ -1907,8 +1521,7 @@ export namespace appengine_v1 {
*/
threadsafe?: boolean;
/**
- * Serving URL for this version. Example:
- * "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ * Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
*/
versionUrl?: string;
/**
@@ -1920,14 +1533,12 @@ export namespace appengine_v1 {
*/
vpcAccessConnector?: Schema$VpcAccessConnector;
/**
- * The Google Compute Engine zones that are supported by this version in the
- * App Engine flexible environment. Deprecated.
+ * The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
*/
zones?: string[];
}
/**
- * Volumes mounted within the app container. Only applicable in the App Engine
- * flexible environment.
+ * Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
*/
export interface Schema$Volume {
/**
@@ -1948,8 +1559,7 @@ export namespace appengine_v1 {
*/
export interface Schema$VpcAccessConnector {
/**
- * Full Serverless VPC Access Connector name e.g.
- * /projects/my-project/locations/us-central1/connectors/c1.
+ * Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
*/
name?: string;
}
@@ -1958,15 +1568,11 @@ export namespace appengine_v1 {
*/
export interface Schema$ZipInfo {
/**
- * An estimate of the number of files in a zip for a zip deployment. If set,
- * must be greater than or equal to the actual number of files. Used for
- * optimizing performance; if not provided, deployment may be slow.
+ * An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
*/
filesCount?: number;
/**
- * URL of the zip file to deploy from. Must be a URL to a resource in Google
- * Cloud Storage in the form
- * 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ * URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
*/
sourceUrl?: string;
}
@@ -1997,13 +1603,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.create
- * @desc Creates an App Engine application for a Google Cloud Platform
- * project. Required fields: id - The ID of the target Cloud Platform
- * project. location - The region
- * (https://cloud.google.com/appengine/docs/locations) where you want the
- * App Engine application located.For more information about App Engine
- * applications, see Managing Projects, Applications, and Billing
- * (https://cloud.google.com/appengine/docs/standard/python/console/).
+ * @desc Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/).
* @alias appengine.apps.create
* @memberOf! ()
*
@@ -2143,10 +1743,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.patch
- * @desc Updates the specified Application resource. You can update the
- * following fields: auth_domain - Google authentication domain for
- * controlling user access to the application. default_cookie_expiration -
- * Cookie expiration policy for the application.
+ * @desc Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.
* @alias appengine.apps.patch
* @memberOf! ()
*
@@ -2218,16 +1815,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.repair
- * @desc Recreates the required App Engine features for the specified App
- * Engine application, for example a Cloud Storage bucket or App Engine
- * service account. Use this method if you receive an error message about a
- * missing feature, for example, Error retrieving the App Engine service
- * account. If you have deleted your App Engine service account, this will
- * not be able to recreate it. Instead, you should attempt to use the IAM
- * undelete API if possible at
- * https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D
- * . If the deletion was recent, the numeric ID can be found in the Cloud
- * Console Activity Log.
+ * @desc Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.
* @alias appengine.apps.repair
* @memberOf! ()
*
@@ -2318,8 +1906,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Application resource to get. Example:
- * apps/myapp.
+ * Part of `name`. Name of the Application resource to get. Example: apps/myapp.
*/
appsId?: string;
}
@@ -2330,8 +1917,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Application resource to update. Example:
- * apps/myapp.
+ * Part of `name`. Name of the Application resource to update. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -2683,11 +2269,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.authorizedCertificates.patch
- * @desc Updates the specified SSL certificate. To renew a certificate and
- * maintain its existing domain mappings, update certificate_data with a new
- * certificate. The new certificate must be applicable to the same domains
- * as the original certificate. The certificate display_name may also be
- * updated.
+ * @desc Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
* @alias appengine.apps.authorizedCertificates.patch
* @memberOf! ()
*
@@ -2773,8 +2355,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
@@ -2791,8 +2372,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to delete. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -2808,8 +2388,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -2829,8 +2408,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -2854,8 +2432,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -2863,8 +2440,7 @@ export namespace appengine_v1 {
*/
authorizedCertificatesId?: string;
/**
- * Standard field mask for the set of fields to be updated. Updates are only
- * supported on the certificate_raw_data and display_name fields.
+ * Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
*/
updateMask?: string;
@@ -2974,8 +2550,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -2996,10 +2571,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.domainMappings.create
- * @desc Maps a domain to an application. A user must be authorized to
- * administer a domain in order to map it to an application. For a list of
- * available authorized domains, see
- * AuthorizedDomains.ListAuthorizedDomains.
+ * @desc Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.
* @alias appengine.apps.domainMappings.create
* @memberOf! ()
*
@@ -3075,9 +2647,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.domainMappings.delete
- * @desc Deletes the specified domain mapping. A user must be authorized to
- * administer the associated domain in order to delete a DomainMapping
- * resource.
+ * @desc Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
* @alias appengine.apps.domainMappings.delete
* @memberOf! ()
*
@@ -3308,10 +2878,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.domainMappings.patch
- * @desc Updates the specified domain mapping. To map an SSL certificate to
- * a domain mapping, update certificate_id to point to an
- * AuthorizedCertificate resource. A user must be authorized to administer
- * the associated domain in order to update a DomainMapping resource.
+ * @desc Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
* @alias appengine.apps.domainMappings.patch
* @memberOf! ()
*
@@ -3394,13 +2961,11 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
- * Whether the domain creation should override any existing mappings for
- * this domain. By default, overrides are rejected.
+ * Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
*/
overrideStrategy?: string;
@@ -3417,8 +2982,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to delete. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -3434,8 +2998,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -3451,8 +3014,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -3472,8 +3034,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -3508,11 +3069,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.firewall.ingressRules.batchUpdate
- * @desc Replaces the entire firewall ruleset in one bulk operation. This
- * overrides and replaces the rules of an existing firewall with the new
- * rules.If the final rule does not match traffic with the '*' wildcard IP
- * range, then an "allow all" rule is explicitly added to the end of the
- * list.
+ * @desc Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.
* @alias appengine.apps.firewall.ingressRules.batchUpdate
* @memberOf! ()
*
@@ -3981,8 +3538,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Firewall collection to set. Example:
- * apps/myapp/firewall/ingressRules.
+ * Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.
*/
appsId?: string;
@@ -3999,8 +3555,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Firewall collection in which to
- * create a new rule. Example: apps/myapp/firewall/ingressRules.
+ * Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.
*/
appsId?: string;
@@ -4017,8 +3572,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Firewall resource to delete. Example:
- * apps/myapp/firewall/ingressRules/100.
+ * Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
@@ -4034,8 +3588,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Firewall resource to retrieve. Example:
- * apps/myapp/firewall/ingressRules/100.
+ * Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
@@ -4051,14 +3604,11 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the Firewall collection to retrieve. Example:
- * apps/myapp/firewall/ingressRules.
+ * Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.
*/
appsId?: string;
/**
- * A valid IP Address. If set, only rules matching this address will be
- * returned. The first returned rule will be the rule that fires on requests
- * from this IP.
+ * A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.
*/
matchingAddress?: string;
/**
@@ -4078,8 +3628,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Firewall resource to update. Example:
- * apps/myapp/firewall/ingressRules/100.
+ * Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
@@ -4279,8 +3828,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. The resource that owns the locations collection, if
- * applicable.
+ * Part of `name`. The resource that owns the locations collection, if applicable.
*/
appsId?: string;
/**
@@ -4305,9 +3853,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.operations.get
- * @desc Gets the latest state of a long-running operation. Clients can use
- * this method to poll the operation result at intervals as recommended by
- * the API service.
+ * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias appengine.apps.operations.get
* @memberOf! ()
*
@@ -4381,15 +3927,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.operations.list
- * @desc Lists operations that match the specified filter in the request. If
- * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE:
- * the name binding allows API services to override the binding to use
- * different resource name schemes, such as users/x/operations. To override
- * the binding, API services can add a binding such as
- * "/v1/{name=users/x}/operations" to their service configuration. For
- * backwards compatibility, the default name includes the operations
- * collection id, however overriding users must ensure the name binding is
- * the parent resource, without the operations collection id.
+ * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @alias appengine.apps.operations.list
* @memberOf! ()
*
@@ -4829,8 +4367,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
@@ -4846,8 +4383,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
@@ -4863,8 +4399,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -4884,24 +4419,11 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/services/default.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
- * Set to true to gradually shift traffic to one or more versions that you
- * specify. By default, traffic is shifted immediately. For gradual traffic
- * migration, the target versions must be located within instances that are
- * configured for both warmup requests
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType)
- * and automatic scaling
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling).
- * You must specify the shardBy
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy)
- * field in the Service resource. Gradual traffic migration is not supported
- * in the App Engine flexible environment. For examples, see Migrating and
- * Splitting Traffic
- * (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
+ * Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
*/
migrateTraffic?: boolean;
/**
@@ -5082,9 +4604,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.services.versions.get
- * @desc Gets the specified Version resource. By default, only a BASIC_VIEW
- * will be returned. Specify the FULL_VIEW parameter to get the full
- * resource.
+ * @desc Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.
* @alias appengine.apps.services.versions.get
* @memberOf! ()
*
@@ -5238,36 +4758,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.services.versions.patch
- * @desc Updates the specified Version resource. You can specify the
- * following fields depending on the App Engine environment and type of
- * scaling that the version resource uses:Standard environment
- * instance_class
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic
- * scaling in the standard environment: automatic_scaling.min_idle_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automatic_scaling.max_idle_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automaticScaling.standard_scheduler_settings.max_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
- * automaticScaling.standard_scheduler_settings.min_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
- * automaticScaling.standard_scheduler_settings.target_cpu_utilization
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
- * automaticScaling.standard_scheduler_settings.target_throughput_utilization
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic
- * scaling or manual scaling in the standard environment: serving_status
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)Flexible
- * environment serving_status
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic
- * scaling in the flexible environment:
- * automatic_scaling.min_total_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automatic_scaling.max_total_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automatic_scaling.cool_down_period_sec
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automatic_scaling.cpu_utilization.target_utilization
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
+ * @desc Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
* @alias appengine.apps.services.versions.patch
* @memberOf! ()
*
@@ -5352,8 +4843,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent resource to create this version
- * under. Example: apps/myapp/services/default.
+ * Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
@@ -5374,8 +4864,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
@@ -5395,8 +4884,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
@@ -5420,8 +4908,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Service resource. Example:
- * apps/myapp/services/default.
+ * Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
@@ -5449,8 +4936,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/services/default/versions/1.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.
*/
appsId?: string;
/**
@@ -5480,12 +4966,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.services.versions.instances.debug
- * @desc Enables debugging on a VM instance. This allows you to use the SSH
- * command to connect to the virtual machine where the instance lives. While
- * in "debug mode", the instance continues to serve live traffic. You should
- * delete the instance when you are done debugging and then allow the system
- * to take over and determine if another instance should be started.Only
- * applicable for instances in App Engine flexible environment.
+ * @desc Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.
* @alias appengine.apps.services.versions.instances.debug
* @memberOf! ()
*
@@ -5715,9 +5196,7 @@ export namespace appengine_v1 {
/**
* appengine.apps.services.versions.instances.list
- * @desc Lists the instances of a version.Tip: To aggregate details about
- * instances over time, see the Stackdriver Monitoring API
- * (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
+ * @desc Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
* @alias appengine.apps.services.versions.instances.list
* @memberOf! ()
*
@@ -5804,8 +5283,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1/instances/instance-1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
@@ -5834,8 +5312,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1/instances/instance-1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
@@ -5859,8 +5336,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1/instances/instance-1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
@@ -5884,8 +5360,7 @@ export namespace appengine_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Version resource. Example:
- * apps/myapp/services/default/versions/v1.
+ * Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts
index 46460eb4efd..4d78e75687f 100644
--- a/src/apis/appengine/v1alpha.ts
+++ b/src/apis/appengine/v1alpha.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace appengine_v1alpha {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace appengine_v1alpha {
*/
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.
+ * 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;
/**
@@ -112,89 +108,66 @@ export namespace appengine_v1alpha {
apps: Resource$Apps;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.apps = new Resource$Apps(this.context);
}
}
/**
- * An SSL certificate that a user has been authorized to administer. A user is
- * authorized to administer any certificate that applies to one of their
- * authorized domains.
+ * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
*/
export interface Schema$AuthorizedCertificate {
/**
- * The SSL certificate serving the AuthorizedCertificate resource. This must
- * be obtained independently from a certificate authority.
+ * The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
*/
certificateRawData?: Schema$CertificateRawData;
/**
- * The user-specified display name of the certificate. This is not
- * guaranteed to be unique. Example: My Certificate.
+ * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
*/
displayName?: string;
/**
- * Aggregate count of the domain mappings with this certificate mapped. This
- * count includes domain mappings on applications for which the user does
- * not have VIEWER permissions.Only returned by GET or LIST requests when
- * specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+ * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
domainMappingsCount?: number;
/**
- * Topmost applicable domains of this certificate. This certificate applies
- * to these domains and their subdomains. Example: example.com.@OutputOnly
+ * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
*/
domainNames?: string[];
/**
- * The time when this certificate expires. To update the renewal time on
- * this certificate, upload an SSL certificate with a different expiration
- * time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
*/
expireTime?: string;
/**
- * Relative name of the certificate. This is a unique value autogenerated on
- * AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
*/
id?: string;
/**
- * Only applicable if this certificate is managed by App Engine. Managed
- * certificates are tied to the lifecycle of a DomainMapping and cannot be
- * updated or deleted via the AuthorizedCertificates API. If this
- * certificate is manually administered by the user, this field will be
- * empty.@OutputOnly
+ * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
*/
managedCertificate?: Schema$ManagedCertificate;
/**
- * Full path to the AuthorizedCertificate resource in the API. Example:
- * apps/myapp/authorizedCertificates/12345.@OutputOnly
+ * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
*/
name?: string;
/**
- * The full paths to user visible Domain Mapping resources that have this
- * certificate mapped. Example: apps/myapp/domainMappings/example.com.This
- * may not represent the full list of mapped domain mappings if the user
- * does not have VIEWER permissions on all of the applications that have
- * this certificate mapped. See domain_mappings_count for a complete
- * count.Only returned by GET or LIST requests when specifically requested
- * by the view=FULL_CERTIFICATE option.@OutputOnly
+ * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
visibleDomainMappings?: string[];
}
/**
- * A domain that a user has been authorized to administer. To authorize use of
- * a domain, verify ownership via Webmaster Central
- * (https://www.google.com/webmasters/verification/home).
+ * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).
*/
export interface Schema$AuthorizedDomain {
/**
- * Fully qualified domain name of the domain authorized for use. Example:
- * example.com.
+ * Fully qualified domain name of the domain authorized for use. Example: example.com.
*/
id?: string;
/**
- * Full path to the AuthorizedDomain resource in the API. Example:
- * apps/myapp/authorizedDomains/example.com.@OutputOnly
+ * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly
*/
name?: string;
}
@@ -203,51 +176,38 @@ export namespace appengine_v1alpha {
*/
export interface Schema$CertificateRawData {
/**
- * Unencrypted PEM encoded RSA private key. This field is set once on
- * certificate creation and then encrypted. The key size must be 2048 bits
- * or fewer. Must include the header and footer. Example: <pre>
- * -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END
- * RSA PRIVATE KEY----- </pre> @InputOnly
+ * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly
*/
privateKey?: string;
/**
- * PEM encoded x.509 public key certificate. This field is set once on
- * certificate creation. Must include the header and footer. Example:
- * <pre> -----BEGIN CERTIFICATE----- <certificate_value>
- * -----END CERTIFICATE----- </pre>
+ * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre>
*/
publicCertificate?: string;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1 {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1alpha.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1Alpha {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1beta.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1Beta {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
@@ -256,33 +216,24 @@ export namespace appengine_v1alpha {
*/
export interface Schema$DomainMapping {
/**
- * Relative name of the domain serving the application. Example:
- * example.com.
+ * Relative name of the domain serving the application. Example: example.com.
*/
id?: string;
/**
- * Full path to the DomainMapping resource in the API. Example:
- * apps/myapp/domainMapping/example.com.@OutputOnly
+ * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
*/
name?: string;
/**
- * The resource records required to configure this domain mapping. These
- * records must be added to the domain's DNS configuration in order to
- * serve the application via this domain mapping.@OutputOnly
+ * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
*/
resourceRecords?: Schema$ResourceRecord[];
/**
- * SSL configuration for this domain. If unconfigured, this domain will not
- * serve with SSL.
+ * SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
*/
sslSettings?: Schema$SslSettings;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for Empty is empty JSON object {}.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
*/
export interface Schema$Empty {}
/**
@@ -355,13 +306,11 @@ export namespace appengine_v1alpha {
*/
export interface Schema$Location {
/**
- * The friendly name for this location, typically a nearby city name. For
- * example, "Tokyo".
+ * The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string;
/**
- * Cross-service attributes for the location. For example
- * {"cloud.googleapis.com/region": "us-east1"}
+ * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {[key: string]: string};
/**
@@ -369,13 +318,11 @@ export namespace appengine_v1alpha {
*/
locationId?: string;
/**
- * Service-specific metadata. For example the available capacity at the
- * given location.
+ * Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {[key: string]: any};
/**
- * Resource name for the location, which may vary between implementations.
- * For example: "projects/example-project/locations/us-east1"
+ * Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
*/
name?: string;
}
@@ -384,13 +331,11 @@ export namespace appengine_v1alpha {
*/
export interface Schema$LocationMetadata {
/**
- * App Engine flexible environment is available in the given
- * location.@OutputOnly
+ * App Engine flexible environment is available in the given location.@OutputOnly
*/
flexibleEnvironmentAvailable?: boolean;
/**
- * App Engine standard environment is available in the given
- * location.@OutputOnly
+ * App Engine standard environment is available in the given location.@OutputOnly
*/
standardEnvironmentAvailable?: boolean;
}
@@ -399,27 +344,20 @@ export namespace appengine_v1alpha {
*/
export interface Schema$ManagedCertificate {
/**
- * Time at which the certificate was last renewed. The renewal process is
- * fully managed. Certificate renewal will automatically occur before the
- * certificate expires. Renewal errors can be tracked via
- * ManagementStatus.@OutputOnly
+ * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
*/
lastRenewalTime?: string;
/**
- * Status of certificate management. Refers to the most recent certificate
- * acquisition or renewal attempt.@OutputOnly
+ * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
*/
status?: string;
}
/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
+ * This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
- * If the value is false, it means the operation is still in progress. If
- * true, the operation is completed, and either error or response is
- * available.
+ * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
*/
done?: boolean;
/**
@@ -427,26 +365,15 @@ export namespace appengine_v1alpha {
*/
error?: Schema$Status;
/**
- * Service-specific metadata associated with the operation. It typically
- * contains progress information and common metadata such as create time.
- * Some services might not provide such metadata. Any method that returns a
- * long-running operation should document the metadata type, if any.
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any};
/**
- * The server-assigned name, which is only unique within the same service
- * that originally returns it. If you use the default HTTP mapping, the name
- * should have the format of operations/some/unique/name.
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
*/
name?: string;
/**
- * The normal response of the operation in case of success. If the original
- * method returns no data on success, such as Delete, the response is
- * google.protobuf.Empty. If the original method is standard
- * Get/Create/Update, the response should be the resource. For other
- * methods, the response should have the type XxxResponse, where Xxx is the
- * original method name. For example, if the original method name is
- * TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
*/
response?: {[key: string]: any};
}
@@ -460,8 +387,7 @@ export namespace appengine_v1alpha {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -469,13 +395,11 @@ export namespace appengine_v1alpha {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -497,8 +421,7 @@ export namespace appengine_v1alpha {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -506,13 +429,11 @@ export namespace appengine_v1alpha {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -534,8 +455,7 @@ export namespace appengine_v1alpha {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -543,13 +463,11 @@ export namespace appengine_v1alpha {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1beta.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -566,13 +484,11 @@ export namespace appengine_v1alpha {
*/
export interface Schema$ResourceRecord {
/**
- * Relative name of the object affected by this record. Only applicable for
- * CNAME records. Example: 'www'.
+ * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
*/
name?: string;
/**
- * Data for this record. Values vary by record type, as defined in RFC 1035
- * (section 5) and RFC 1034 (section 3.6.1).
+ * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
*/
rrdata?: string;
/**
@@ -585,57 +501,16 @@ export namespace appengine_v1alpha {
*/
export interface Schema$SslSettings {
/**
- * ID of the AuthorizedCertificate resource configuring SSL for the
- * application. Clearing this field will remove SSL support.By default, a
- * managed certificate is automatically created for every domain mapping. To
- * omit SSL support or to configure SSL manually, specify
- * no_managed_certificate on a CREATE or UPDATE request. You must be
- * authorized to administer the AuthorizedCertificate resource to manually
- * map it to a DomainMapping resource. Example: 12345.
+ * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
*/
certificateId?: string;
/**
- * Whether the mapped certificate is an App Engine managed certificate.
- * Managed certificates are created by default with a domain mapping. To opt
- * out, specify no_managed_certificate on a CREATE or UPDATE
- * request.@OutputOnly
+ * Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly
*/
isManagedCertificate?: boolean;
}
/**
- * The Status type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by gRPC (https://github.com/grpc). The error model is designed to be:
- * Simple to use and understand for most users Flexible enough to meet
- * unexpected needsOverviewThe Status message contains three pieces of data:
- * error code, error message, and error details. The error code should be an
- * enum value of google.rpc.Code, but it may accept additional error codes if
- * needed. The error message should be a developer-facing English message that
- * helps developers understand and resolve the error. If a localized
- * user-facing error message is needed, put the localized message in the error
- * details or localize it in the client. The optional error details may
- * contain arbitrary information about the error. There is a predefined set of
- * error detail types in the package google.rpc that can be used for common
- * error conditions.Language mappingThe Status message is the logical
- * representation of the error model, but it is not necessarily the actual
- * wire format. When the Status message is exposed in different client
- * libraries and different wire protocols, it can be mapped differently. For
- * example, it will likely be mapped to some exceptions in Java, but more
- * likely mapped to some error codes in C.Other usesThe error model and the
- * Status message can be used in a variety of environments, either with or
- * without APIs, to provide a consistent developer experience across different
- * environments.Example uses of this error model include: Partial errors. If a
- * service needs to return partial errors to the client, it may embed the
- * Status in the normal response to indicate the partial errors. Workflow
- * errors. A typical workflow has multiple steps. Each step may have a Status
- * message for error reporting. Batch operations. If a client uses batch
- * request and batch response, the Status message should be used directly
- * inside batch response, one for each error sub-response. Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the Status message. Logging. If some API errors are stored in logs,
- * the message Status could be used directly after any stripping needed for
- * security/privacy reasons.
+ * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -643,14 +518,11 @@ export namespace appengine_v1alpha {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set of
- * message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
@@ -996,11 +868,7 @@ export namespace appengine_v1alpha {
/**
* appengine.apps.authorizedCertificates.patch
- * @desc Updates the specified SSL certificate. To renew a certificate and
- * maintain its existing domain mappings, update certificate_data with a new
- * certificate. The new certificate must be applicable to the same domains
- * as the original certificate. The certificate display_name may also be
- * updated.
+ * @desc Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
* @alias appengine.apps.authorizedCertificates.patch
* @memberOf! ()
*
@@ -1086,8 +954,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
@@ -1104,8 +971,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to delete. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -1121,8 +987,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -1142,8 +1007,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -1167,8 +1031,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -1176,8 +1039,7 @@ export namespace appengine_v1alpha {
*/
authorizedCertificatesId?: string;
/**
- * Standard field mask for the set of fields to be updated. Updates are only
- * supported on the certificate_raw_data and display_name fields.
+ * Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
*/
updateMask?: string;
@@ -1287,8 +1149,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -1309,10 +1170,7 @@ export namespace appengine_v1alpha {
/**
* appengine.apps.domainMappings.create
- * @desc Maps a domain to an application. A user must be authorized to
- * administer a domain in order to map it to an application. For a list of
- * available authorized domains, see
- * AuthorizedDomains.ListAuthorizedDomains.
+ * @desc Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.
* @alias appengine.apps.domainMappings.create
* @memberOf! ()
*
@@ -1389,9 +1247,7 @@ export namespace appengine_v1alpha {
/**
* appengine.apps.domainMappings.delete
- * @desc Deletes the specified domain mapping. A user must be authorized to
- * administer the associated domain in order to delete a DomainMapping
- * resource.
+ * @desc Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
* @alias appengine.apps.domainMappings.delete
* @memberOf! ()
*
@@ -1624,10 +1480,7 @@ export namespace appengine_v1alpha {
/**
* appengine.apps.domainMappings.patch
- * @desc Updates the specified domain mapping. To map an SSL certificate to
- * a domain mapping, update certificate_id to point to an
- * AuthorizedCertificate resource. A user must be authorized to administer
- * the associated domain in order to update a DomainMapping resource.
+ * @desc Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
* @alias appengine.apps.domainMappings.patch
* @memberOf! ()
*
@@ -1712,20 +1565,15 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
- * Whether a managed certificate should be provided by App Engine. If true,
- * a certificate ID must be manaually set in the DomainMapping resource to
- * configure SSL for this domain. If false, a managed certificate will be
- * provisioned and a certificate ID will be automatically populated.
+ * Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.
*/
noManagedCertificate?: boolean;
/**
- * Whether the domain creation should override any existing mappings for
- * this domain. By default, overrides are rejected.
+ * Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
*/
overrideStrategy?: string;
@@ -1742,8 +1590,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to delete. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -1759,8 +1606,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -1776,8 +1622,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -1797,8 +1642,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -1806,12 +1650,7 @@ export namespace appengine_v1alpha {
*/
domainMappingsId?: string;
/**
- * Whether a managed certificate should be provided by App Engine. If true,
- * a certificate ID must be manually set in the DomainMapping resource to
- * configure SSL for this domain. If false, a managed certificate will be
- * provisioned and a certificate ID will be automatically populated. Only
- * applicable if ssl_settings.certificate_id is specified in the update
- * mask.
+ * Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.
*/
noManagedCertificate?: boolean;
/**
@@ -2007,8 +1846,7 @@ export namespace appengine_v1alpha {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. The resource that owns the locations collection, if
- * applicable.
+ * Part of `name`. The resource that owns the locations collection, if applicable.
*/
appsId?: string;
/**
@@ -2033,9 +1871,7 @@ export namespace appengine_v1alpha {
/**
* appengine.apps.operations.get
- * @desc Gets the latest state of a long-running operation. Clients can use
- * this method to poll the operation result at intervals as recommended by
- * the API service.
+ * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias appengine.apps.operations.get
* @memberOf! ()
*
@@ -2109,15 +1945,7 @@ export namespace appengine_v1alpha {
/**
* appengine.apps.operations.list
- * @desc Lists operations that match the specified filter in the request. If
- * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE:
- * the name binding allows API services to override the binding to use
- * different resource name schemes, such as users/x/operations. To override
- * the binding, API services can add a binding such as
- * "/v1/{name=users/x}/operations" to their service configuration. For
- * backwards compatibility, the default name includes the operations
- * collection id, however overriding users must ensure the name binding is
- * the parent resource, without the operations collection id.
+ * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @alias appengine.apps.operations.list
* @memberOf! ()
*
diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts
index 4922770e338..eae4690bf9b 100644
--- a/src/apis/appengine/v1beta.ts
+++ b/src/apis/appengine/v1beta.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace appengine_v1beta {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace appengine_v1beta {
*/
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.
+ * 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;
/**
@@ -112,21 +108,21 @@ export namespace appengine_v1beta {
apps: Resource$Apps;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.apps = new Resource$Apps(this.context);
}
}
/**
- * Google Cloud Endpoints
- * (https://cloud.google.com/appengine/docs/python/endpoints/) configuration
- * for API handlers.
+ * Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.
*/
export interface Schema$ApiConfigHandler {
/**
- * Action to take when users access resources that require authentication.
- * Defaults to redirect.
+ * Action to take when users access resources that require authentication. Defaults to redirect.
*/
authFailAction?: string;
/**
@@ -156,24 +152,19 @@ export namespace appengine_v1beta {
scriptPath?: string;
}
/**
- * An Application resource contains the top-level configuration of an App
- * Engine application.
+ * An Application resource contains the top-level configuration of an App Engine application.
*/
export interface Schema$Application {
/**
- * Google Apps authentication domain that controls which users can access
- * this application.Defaults to open access for any Google Account.
+ * Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
*/
authDomain?: string;
/**
- * Google Cloud Storage bucket that can be used for storing files associated
- * with this application. This bucket is associated with the application and
- * can be used by the gcloud deployment commands.@OutputOnly
+ * Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
*/
codeBucket?: string;
/**
- * Google Cloud Storage bucket that can be used by this application to store
- * content.@OutputOnly
+ * Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
*/
defaultBucket?: string;
/**
@@ -181,14 +172,11 @@ export namespace appengine_v1beta {
*/
defaultCookieExpiration?: string;
/**
- * Hostname used to reach this application, as resolved by App
- * Engine.@OutputOnly
+ * Hostname used to reach this application, as resolved by App Engine.@OutputOnly
*/
defaultHostname?: string;
/**
- * HTTP path dispatch rules for requests to the application that do not
- * explicitly target a service or version. Rules are order-dependent. Up to
- * 20 dispatch rules can be supported.
+ * HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
*/
dispatchRules?: Schema$UrlDispatchRule[];
/**
@@ -196,28 +184,20 @@ export namespace appengine_v1beta {
*/
featureSettings?: Schema$FeatureSettings;
/**
- * The Google Container Registry domain used for storing managed build
- * docker images for this application.
+ * The Google Container Registry domain used for storing managed build docker images for this application.
*/
gcrDomain?: string;
iap?: Schema$IdentityAwareProxy;
/**
- * Identifier of the Application resource. This identifier is equivalent to
- * the project ID of the Google Cloud Platform project where you want to
- * deploy your application. Example: myapp.
+ * Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
*/
id?: string;
/**
- * Location from which this application runs. Application instances run out
- * of the data centers in the specified location, which is also where all of
- * the application's end user content is stored.Defaults to
- * us-central.View the list of supported locations
- * (https://cloud.google.com/appengine/docs/locations).
+ * Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
*/
locationId?: string;
/**
- * Full path to the Application resource in the API. Example:
- * apps/myapp.@OutputOnly
+ * Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
*/
name?: string;
/**
@@ -226,97 +206,65 @@ export namespace appengine_v1beta {
servingStatus?: string;
}
/**
- * An SSL certificate that a user has been authorized to administer. A user is
- * authorized to administer any certificate that applies to one of their
- * authorized domains.
+ * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
*/
export interface Schema$AuthorizedCertificate {
/**
- * The SSL certificate serving the AuthorizedCertificate resource. This must
- * be obtained independently from a certificate authority.
+ * The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
*/
certificateRawData?: Schema$CertificateRawData;
/**
- * The user-specified display name of the certificate. This is not
- * guaranteed to be unique. Example: My Certificate.
+ * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
*/
displayName?: string;
/**
- * Aggregate count of the domain mappings with this certificate mapped. This
- * count includes domain mappings on applications for which the user does
- * not have VIEWER permissions.Only returned by GET or LIST requests when
- * specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+ * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
domainMappingsCount?: number;
/**
- * Topmost applicable domains of this certificate. This certificate applies
- * to these domains and their subdomains. Example: example.com.@OutputOnly
+ * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
*/
domainNames?: string[];
/**
- * The time when this certificate expires. To update the renewal time on
- * this certificate, upload an SSL certificate with a different expiration
- * time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
*/
expireTime?: string;
/**
- * Relative name of the certificate. This is a unique value autogenerated on
- * AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
*/
id?: string;
/**
- * Only applicable if this certificate is managed by App Engine. Managed
- * certificates are tied to the lifecycle of a DomainMapping and cannot be
- * updated or deleted via the AuthorizedCertificates API. If this
- * certificate is manually administered by the user, this field will be
- * empty.@OutputOnly
+ * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
*/
managedCertificate?: Schema$ManagedCertificate;
/**
- * Full path to the AuthorizedCertificate resource in the API. Example:
- * apps/myapp/authorizedCertificates/12345.@OutputOnly
+ * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
*/
name?: string;
/**
- * The full paths to user visible Domain Mapping resources that have this
- * certificate mapped. Example: apps/myapp/domainMappings/example.com.This
- * may not represent the full list of mapped domain mappings if the user
- * does not have VIEWER permissions on all of the applications that have
- * this certificate mapped. See domain_mappings_count for a complete
- * count.Only returned by GET or LIST requests when specifically requested
- * by the view=FULL_CERTIFICATE option.@OutputOnly
+ * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
visibleDomainMappings?: string[];
}
/**
- * A domain that a user has been authorized to administer. To authorize use of
- * a domain, verify ownership via Webmaster Central
- * (https://www.google.com/webmasters/verification/home).
+ * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).
*/
export interface Schema$AuthorizedDomain {
/**
- * Fully qualified domain name of the domain authorized for use. Example:
- * example.com.
+ * Fully qualified domain name of the domain authorized for use. Example: example.com.
*/
id?: string;
/**
- * Full path to the AuthorizedDomain resource in the API. Example:
- * apps/myapp/authorizedDomains/example.com.@OutputOnly
+ * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly
*/
name?: string;
}
/**
- * Automatic scaling is based on request rate, response latencies, and other
- * application metrics.
+ * Automatic scaling is based on request rate, response latencies, and other application metrics.
*/
export interface Schema$AutomaticScaling {
/**
- * The time period that the Autoscaler
- * (https://cloud.google.com/compute/docs/autoscaler/) should wait before it
- * starts collecting information from a new instance. This prevents the
- * autoscaler from collecting information when the instance is initializing,
- * during which the collected usage would not be reliable. Only applicable
- * in the App Engine flexible environment.
+ * The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
*/
coolDownPeriod?: string;
/**
@@ -324,7 +272,7 @@ export namespace appengine_v1beta {
*/
cpuUtilization?: Schema$CpuUtilization;
/**
- * Target scaling by user-provided metrics.
+ * Target scaling by user-provided metrics. Only applicable in the App Engine flexible environment.
*/
customMetrics?: Schema$CustomMetric[];
/**
@@ -332,39 +280,31 @@ export namespace appengine_v1beta {
*/
diskUtilization?: Schema$DiskUtilization;
/**
- * Number of concurrent requests an automatic scaling instance can accept
- * before the scheduler spawns a new instance.Defaults to a runtime-specific
- * value.
+ * Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
*/
maxConcurrentRequests?: number;
/**
- * Maximum number of idle instances that should be maintained for this
- * version.
+ * Maximum number of idle instances that should be maintained for this version.
*/
maxIdleInstances?: number;
/**
- * Maximum amount of time that a request should wait in the pending queue
- * before starting a new instance to handle it.
+ * Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
*/
maxPendingLatency?: string;
/**
- * Maximum number of instances that should be started to handle requests for
- * this version.
+ * Maximum number of instances that should be started to handle requests for this version.
*/
maxTotalInstances?: number;
/**
- * Minimum number of idle instances that should be maintained for this
- * version. Only applicable for the default version of a service.
+ * Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
*/
minIdleInstances?: number;
/**
- * Minimum amount of time a request should wait in the pending queue before
- * starting a new instance to handle it.
+ * Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
*/
minPendingLatency?: string;
/**
- * Minimum number of running instances that should be maintained for this
- * version.
+ * Minimum number of running instances that should be maintained for this version.
*/
minTotalInstances?: number;
/**
@@ -381,15 +321,11 @@ export namespace appengine_v1beta {
standardSchedulerSettings?: Schema$StandardSchedulerSettings;
}
/**
- * A service with basic scaling will create an instance when the application
- * receives a request. The instance will be turned down when the app becomes
- * idle. Basic scaling is ideal for work that is intermittent or driven by
- * user activity.
+ * A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
*/
export interface Schema$BasicScaling {
/**
- * Duration of time after the last request that an instance must wait before
- * the instance is shut down.
+ * Duration of time after the last request that an instance must wait before the instance is shut down.
*/
idleTimeout?: string;
/**
@@ -420,8 +356,7 @@ export namespace appengine_v1beta {
*/
export interface Schema$BuildInfo {
/**
- * The Google Cloud Build id. Example:
- * "f966068f-08b2-42c8-bdfe-74137dff2bf9"
+ * The Google Cloud Build id. Example: "f966068f-08b2-42c8-bdfe-74137dff2bf9"
*/
cloudBuildId?: string;
}
@@ -430,51 +365,33 @@ export namespace appengine_v1beta {
*/
export interface Schema$CertificateRawData {
/**
- * Unencrypted PEM encoded RSA private key. This field is set once on
- * certificate creation and then encrypted. The key size must be 2048 bits
- * or fewer. Must include the header and footer. Example: <pre>
- * -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END
- * RSA PRIVATE KEY----- </pre> @InputOnly
+ * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly
*/
privateKey?: string;
/**
- * PEM encoded x.509 public key certificate. This field is set once on
- * certificate creation. Must include the header and footer. Example:
- * <pre> -----BEGIN CERTIFICATE----- <certificate_value>
- * -----END CERTIFICATE----- </pre>
+ * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre>
*/
publicCertificate?: string;
}
/**
- * Options for the build operations performed as a part of the version
- * deployment. Only applicable for App Engine flexible environment when
- * creating a version using source code directly.
+ * Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.
*/
export interface Schema$CloudBuildOptions {
/**
- * Path to the yaml file used in deployment, used to determine runtime
- * configuration details.Required for flexible environment builds.See
- * https://cloud.google.com/appengine/docs/standard/python/config/appref for
- * more details.
+ * Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
*/
appYamlPath?: string;
/**
- * The Cloud Build timeout used as part of any dependent builds performed by
- * version creation. Defaults to 10 minutes.
+ * The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
*/
cloudBuildTimeout?: string;
}
/**
- * Docker image that is used to create a container and start a VM instance for
- * the version that you deploy. Only applicable for instances running in the
- * App Engine flexible environment.
+ * Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.
*/
export interface Schema$ContainerInfo {
/**
- * URI to the hosted container image in Google Container Registry. The URI
- * must be fully qualified and include a tag or digest. Examples:
- * "gcr.io/my-project/image:tag" or
- * "gcr.io/my-project/image@digest"
+ * URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
*/
image?: string;
}
@@ -487,41 +404,34 @@ export namespace appengine_v1beta {
*/
aggregationWindowLength?: string;
/**
- * Target CPU utilization ratio to maintain when scaling. Must be between 0
- * and 1.
+ * Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
*/
targetUtilization?: number;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1 {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1alpha.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1Alpha {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
/**
- * Metadata for the given google.longrunning.Operation during a
- * google.appengine.v1beta.CreateVersionRequest.
+ * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1Beta {
/**
- * The Cloud Build ID if one was created as part of the version create.
- * @OutputOnly
+ * The Cloud Build ID if one was created as part of the version create. @OutputOnly
*/
cloudBuildId?: string;
}
@@ -538,16 +448,11 @@ export namespace appengine_v1beta {
*/
metricName?: string;
/**
- * May be used instead of target_utilization when an instance can handle a
- * specific amount of work/resources and the metric value is equal to the
- * current amount of work remaining. The autoscaler will try to keep the
- * number of instances equal to the metric value divided by
- * single_instance_assignment.
+ * May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment.
*/
singleInstanceAssignment?: number;
/**
- * The type of the metric. Must be a string representing a Stackdriver
- * metric type e.g. GAGUE, DELTA_PER_SECOND, etc.
+ * The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.
*/
targetType?: string;
/**
@@ -560,11 +465,7 @@ export namespace appengine_v1beta {
*/
export interface Schema$DebugInstanceRequest {
/**
- * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa
- * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh
- * {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For
- * more information, see Adding and Removing SSH Keys
- * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
+ * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
*/
sshKey?: string;
}
@@ -573,26 +474,19 @@ export namespace appengine_v1beta {
*/
export interface Schema$Deployment {
/**
- * Google Cloud Build build information. Only applicable for instances
- * running in the App Engine flexible environment.
+ * Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
*/
build?: Schema$BuildInfo;
/**
- * Options for any Google Cloud Build builds created as a part of this
- * deployment.These options will only be used if a new build is created,
- * such as when deploying to the App Engine flexible environment using files
- * or zip.
+ * Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
*/
cloudBuildOptions?: Schema$CloudBuildOptions;
/**
- * The Docker image for the container that runs the version. Only applicable
- * for instances running in the App Engine flexible environment.
+ * The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
*/
container?: Schema$ContainerInfo;
/**
- * Manifest of the files stored in Google Cloud Storage that are included as
- * part of this version. All files must be readable using the credentials
- * supplied with this call.
+ * Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
*/
files?: {[key: string]: Schema$FileInfo};
/**
@@ -601,8 +495,7 @@ export namespace appengine_v1beta {
zip?: Schema$ZipInfo;
}
/**
- * Target scaling by disk usage. Only applicable in the App Engine flexible
- * environment.
+ * Target scaling by disk usage. Only applicable in the App Engine flexible environment.
*/
export interface Schema$DiskUtilization {
/**
@@ -627,71 +520,44 @@ export namespace appengine_v1beta {
*/
export interface Schema$DomainMapping {
/**
- * Relative name of the domain serving the application. Example:
- * example.com.
+ * Relative name of the domain serving the application. Example: example.com.
*/
id?: string;
/**
- * Full path to the DomainMapping resource in the API. Example:
- * apps/myapp/domainMapping/example.com.@OutputOnly
+ * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
*/
name?: string;
/**
- * The resource records required to configure this domain mapping. These
- * records must be added to the domain's DNS configuration in order to
- * serve the application via this domain mapping.@OutputOnly
+ * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
*/
resourceRecords?: Schema$ResourceRecord[];
/**
- * SSL configuration for this domain. If unconfigured, this domain will not
- * serve with SSL.
+ * SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
*/
sslSettings?: Schema$SslSettings;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for Empty is empty JSON object {}.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
*/
export interface Schema$Empty {}
/**
- * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The
- * Endpoints API Service provides tooling for serving Open API and gRPC
- * endpoints via an NGINX proxy. Only valid for App Engine Flexible
- * environment deployments.The fields here refer to the name and configuration
- * ID of a "service" resource in the Service Management API
- * (https://cloud.google.com/service-management/overview).
+ * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview).
*/
export interface Schema$EndpointsApiService {
/**
- * Endpoints service configuration ID as specified by the Service Management
- * API. For example "2016-09-19r1".By default, the rollout
- * strategy for Endpoints is RolloutStrategy.FIXED. This means that
- * Endpoints starts up with a particular configuration ID. When a new
- * configuration is rolled out, Endpoints must be given the new
- * configuration ID. The config_id field is used to give the configuration
- * ID and is required in this case.Endpoints also has a rollout strategy
- * called RolloutStrategy.MANAGED. When using this, Endpoints fetches the
- * latest configuration and does not need the configuration ID. In this
- * case, config_id must be omitted.
+ * Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
*/
configId?: string;
/**
- * Enable or disable trace sampling. By default, this is set to false for
- * enabled.
+ * Enable or disable trace sampling. By default, this is set to false for enabled.
*/
disableTraceSampling?: boolean;
/**
- * Endpoints service name which is the name of the "service"
- * resource in the Service Management API. For example
- * "myapi.endpoints.myproject.cloud.goog"
+ * Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
*/
name?: string;
/**
- * Endpoints rollout strategy. If FIXED, config_id must be specified. If
- * MANAGED, config_id must be omitted.
+ * Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
*/
rolloutStrategy?: string;
}
@@ -722,34 +588,24 @@ export namespace appengine_v1beta {
staticFile?: string;
}
/**
- * The feature specific settings to be used in the application. These define
- * behaviors that are user configurable.
+ * The feature specific settings to be used in the application. These define behaviors that are user configurable.
*/
export interface Schema$FeatureSettings {
/**
- * Boolean value indicating if split health checks should be used instead of
- * the legacy health checks. At an app.yaml level, this means defaulting to
- * 'readiness_check' and 'liveness_check' values instead of
- * 'health_check' ones. Once the legacy 'health_check'
- * behavior is deprecated, and this value is always true, this setting can
- * be removed.
+ * Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
*/
splitHealthChecks?: boolean;
/**
- * If true, use Container-Optimized OS
- * (https://cloud.google.com/container-optimized-os/) base image for VMs,
- * rather than a base Debian image.
+ * If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.
*/
useContainerOptimizedOs?: boolean;
}
/**
- * Single source file that is part of the version to be deployed. Each source
- * file that is deployed must be specified separately.
+ * Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
*/
export interface Schema$FileInfo {
/**
- * The MIME type of the file.Defaults to the value from Google Cloud
- * Storage.
+ * The MIME type of the file.Defaults to the value from Google Cloud Storage.
*/
mimeType?: string;
/**
@@ -757,15 +613,12 @@ export namespace appengine_v1beta {
*/
sha1Sum?: string;
/**
- * URL source to use to fetch this file. Must be a URL to a resource in
- * Google Cloud Storage in the form
- * 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ * URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
*/
sourceUrl?: string;
}
/**
- * A single firewall rule that is evaluated against incoming traffic and
- * provides an action to take on matched requests.
+ * A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
*/
export interface Schema$FirewallRule {
/**
@@ -773,35 +626,20 @@ export namespace appengine_v1beta {
*/
action?: string;
/**
- * An optional string description of this rule. This field has a maximum
- * length of 100 characters.
+ * An optional string description of this rule. This field has a maximum length of 100 characters.
*/
description?: string;
/**
- * A positive integer between 1, Int32.MaxValue-1 that defines the order of
- * rule evaluation. Rules with the lowest priority are evaluated first.A
- * default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic
- * when no previous rule matches. Only the action of this rule can be
- * modified by the user.
+ * A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
*/
priority?: number;
/**
- * IP address or range, defined using CIDR notation, of requests that this
- * rule applies to. You can use the wildcard character "*" to
- * match all IPs equivalent to "0/0" and "::/0"
- * together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or
- * 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be
- * silently performed on addresses which are not properly truncated. For
- * example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24.
- * Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as
- * 2001:db8::/32.
+ * IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
*/
sourceRange?: string;
}
/**
- * Health checking configuration for VM instances. Unhealthy instances are
- * killed and replaced with new instances. Only applicable for instances in
- * App Engine flexible environment.
+ * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
*/
export interface Schema$HealthCheck {
/**
@@ -813,18 +651,15 @@ export namespace appengine_v1beta {
*/
disableHealthCheck?: boolean;
/**
- * Number of consecutive successful health checks required before receiving
- * traffic.
+ * Number of consecutive successful health checks required before receiving traffic.
*/
healthyThreshold?: number;
/**
- * Host header to send when performing an HTTP health check. Example:
- * "myapp.appspot.com"
+ * Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
*/
host?: string;
/**
- * Number of consecutive failed health checks required before an instance is
- * restarted.
+ * Number of consecutive failed health checks required before an instance is restarted.
*/
restartThreshold?: number;
/**
@@ -832,8 +667,7 @@ export namespace appengine_v1beta {
*/
timeout?: string;
/**
- * Number of consecutive failed health checks required before removing
- * traffic.
+ * Number of consecutive failed health checks required before removing traffic.
*/
unhealthyThreshold?: number;
}
@@ -842,9 +676,7 @@ export namespace appengine_v1beta {
*/
export interface Schema$IdentityAwareProxy {
/**
- * Whether the serving infrastructure will authenticate and authorize all
- * incoming requests.If true, the oauth2_client_id and oauth2_client_secret
- * fields must be non-empty.
+ * Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
*/
enabled?: boolean;
/**
@@ -852,15 +684,11 @@ export namespace appengine_v1beta {
*/
oauth2ClientId?: string;
/**
- * InputOnly OAuth client info required to generate client id to be used for
- * IAP.
+ * InputOnly OAuth client info required to generate client id to be used for IAP.
*/
oauth2ClientInfo?: Schema$OAuth2ClientInfo;
/**
- * OAuth2 client secret to use for the authentication flow.For security
- * reasons, this value cannot be retrieved via the API. Instead, the SHA-256
- * hash of the value is returned in the oauth2_client_secret_sha256
- * field.@InputOnly
+ * OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
*/
oauth2ClientSecret?: string;
/**
@@ -869,8 +697,7 @@ export namespace appengine_v1beta {
oauth2ClientSecretSha256?: string;
}
/**
- * An Instance resource is the computing unit that App Engine uses to
- * automatically scale an application.
+ * An Instance resource is the computing unit that App Engine uses to automatically scale an application.
*/
export interface Schema$Instance {
/**
@@ -890,8 +717,7 @@ export namespace appengine_v1beta {
*/
errors?: number;
/**
- * Relative name of the instance within the version. Example:
- * instance-1.@OutputOnly
+ * Relative name of the instance within the version. Example: instance-1.@OutputOnly
*/
id?: string;
/**
@@ -899,8 +725,7 @@ export namespace appengine_v1beta {
*/
memoryUsage?: string;
/**
- * Full path to the Instance resource in the API. Example:
- * apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly
+ * Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly
*/
name?: string;
/**
@@ -916,33 +741,27 @@ export namespace appengine_v1beta {
*/
startTime?: string;
/**
- * Whether this instance is in debug mode. Only applicable for instances in
- * App Engine flexible environment.@OutputOnly
+ * Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmDebugEnabled?: boolean;
/**
- * Virtual machine ID of this instance. Only applicable for instances in App
- * Engine flexible environment.@OutputOnly
+ * Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmId?: string;
/**
- * The IP address of this instance. Only applicable for instances in App
- * Engine flexible environment.@OutputOnly
+ * The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmIp?: string;
/**
- * Name of the virtual machine where this instance lives. Only applicable
- * for instances in App Engine flexible environment.@OutputOnly
+ * Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmName?: string;
/**
- * Status of the virtual machine where this instance lives. Only applicable
- * for instances in App Engine flexible environment.@OutputOnly
+ * Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmStatus?: string;
/**
- * Zone where the virtual machine is located. Only applicable for instances
- * in App Engine flexible environment.@OutputOnly
+ * Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly
*/
vmZoneName?: string;
}
@@ -1077,8 +896,7 @@ export namespace appengine_v1beta {
versions?: Schema$Version[];
}
/**
- * Health checking configuration for VM instances. Unhealthy instances are
- * killed and replaced with new instances.
+ * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
*/
export interface Schema$LivenessCheck {
/**
@@ -1086,13 +904,11 @@ export namespace appengine_v1beta {
*/
checkInterval?: string;
/**
- * Number of consecutive failed checks required before considering the VM
- * unhealthy.
+ * Number of consecutive failed checks required before considering the VM unhealthy.
*/
failureThreshold?: number;
/**
- * Host header to send when performing a HTTP Liveness check. Example:
- * "myapp.appspot.com"
+ * Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
*/
host?: string;
/**
@@ -1104,8 +920,7 @@ export namespace appengine_v1beta {
*/
path?: string;
/**
- * Number of consecutive successful checks required before considering the
- * VM healthy.
+ * Number of consecutive successful checks required before considering the VM healthy.
*/
successThreshold?: number;
/**
@@ -1118,13 +933,11 @@ export namespace appengine_v1beta {
*/
export interface Schema$Location {
/**
- * The friendly name for this location, typically a nearby city name. For
- * example, "Tokyo".
+ * The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string;
/**
- * Cross-service attributes for the location. For example
- * {"cloud.googleapis.com/region": "us-east1"}
+ * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {[key: string]: string};
/**
@@ -1132,13 +945,11 @@ export namespace appengine_v1beta {
*/
locationId?: string;
/**
- * Service-specific metadata. For example the available capacity at the
- * given location.
+ * Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {[key: string]: any};
/**
- * Resource name for the location, which may vary between implementations.
- * For example: "projects/example-project/locations/us-east1"
+ * Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
*/
name?: string;
}
@@ -1147,13 +958,11 @@ export namespace appengine_v1beta {
*/
export interface Schema$LocationMetadata {
/**
- * App Engine flexible environment is available in the given
- * location.@OutputOnly
+ * App Engine flexible environment is available in the given location.@OutputOnly
*/
flexibleEnvironmentAvailable?: boolean;
/**
- * App Engine standard environment is available in the given
- * location.@OutputOnly
+ * App Engine standard environment is available in the given location.@OutputOnly
*/
standardEnvironmentAvailable?: boolean;
}
@@ -1162,78 +971,50 @@ export namespace appengine_v1beta {
*/
export interface Schema$ManagedCertificate {
/**
- * Time at which the certificate was last renewed. The renewal process is
- * fully managed. Certificate renewal will automatically occur before the
- * certificate expires. Renewal errors can be tracked via
- * ManagementStatus.@OutputOnly
+ * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
*/
lastRenewalTime?: string;
/**
- * Status of certificate management. Refers to the most recent certificate
- * acquisition or renewal attempt.@OutputOnly
+ * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
*/
status?: string;
}
/**
- * A service with manual scaling runs continuously, allowing you to perform
- * complex initialization and rely on the state of its memory over time.
+ * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
*/
export interface Schema$ManualScaling {
/**
- * Number of instances to assign to the service at the start. This number
- * can later be altered by using the Modules API
- * (https://cloud.google.com/appengine/docs/python/modules/functions)
- * set_num_instances() function.
+ * Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
*/
instances?: number;
}
/**
- * Extra network settings. Only applicable in the App Engine flexible
- * environment.
+ * Extra network settings. Only applicable in the App Engine flexible environment.
*/
export interface Schema$Network {
/**
- * List of ports, or port pairs, to forward from the virtual machine to the
- * application container. Only applicable in the App Engine flexible
- * environment.
+ * List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
*/
forwardedPorts?: string[];
/**
- * Tag to apply to the instance during creation. Only applicable in the App
- * Engine flexible environment.
+ * Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
*/
instanceTag?: string;
/**
- * Google Compute Engine network where the virtual machines are created.
- * Specify the short name, not the resource path.Defaults to default.
+ * Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
*/
name?: string;
/**
- * Enable session affinity. Only applicable in the App Engine flexible
- * environment.
+ * Enable session affinity. Only applicable in the App Engine flexible environment.
*/
sessionAffinity?: boolean;
/**
- * Google Cloud Platform sub-network where the virtual machines are created.
- * Specify the short name, not the resource path.If a subnetwork name is
- * specified, a network name will also be required unless it is for the
- * default network. If the network that the instance is being created in is
- * a Legacy network, then the IP address is allocated from the IPv4Range. If
- * the network that the instance is being created in is an auto Subnet Mode
- * Network, then only network name should be specified (not the
- * subnetwork_name) and the IP address is created from the IPCidrRange of
- * the subnetwork that exists in that zone for that network. If the network
- * that the instance is being created in is a custom Subnet Mode Network,
- * then the subnetwork_name must be specified and the IP address is created
- * from the IPCidrRange of the subnetwork.If specified, the subnetwork must
- * exist in the same region as the App Engine flexible environment
- * application.
+ * Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
*/
subnetworkName?: string;
}
/**
- * Target scaling by network usage. Only applicable in the App Engine flexible
- * environment.
+ * Target scaling by network usage. Only applicable in the App Engine flexible environment.
*/
export interface Schema$NetworkUtilization {
/**
@@ -1259,8 +1040,7 @@ export namespace appengine_v1beta {
*/
applicationName?: string;
/**
- * Nameof the client to be generated. Optional - If not provided, the name
- * will be autogenerated by the backend.
+ * Nameof the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.
*/
clientName?: string;
/**
@@ -1269,14 +1049,11 @@ export namespace appengine_v1beta {
developerEmailAddress?: string;
}
/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
+ * This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
- * If the value is false, it means the operation is still in progress. If
- * true, the operation is completed, and either error or response is
- * available.
+ * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
*/
done?: boolean;
/**
@@ -1284,26 +1061,15 @@ export namespace appengine_v1beta {
*/
error?: Schema$Status;
/**
- * Service-specific metadata associated with the operation. It typically
- * contains progress information and common metadata such as create time.
- * Some services might not provide such metadata. Any method that returns a
- * long-running operation should document the metadata type, if any.
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any};
/**
- * The server-assigned name, which is only unique within the same service
- * that originally returns it. If you use the default HTTP mapping, the name
- * should have the format of operations/some/unique/name.
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
*/
name?: string;
/**
- * The normal response of the operation in case of success. If the original
- * method returns no data on success, such as Delete, the response is
- * google.protobuf.Empty. If the original method is standard
- * Get/Create/Update, the response should be the resource. For other
- * methods, the response should have the type XxxResponse, where Xxx is the
- * original method name. For example, if the original method name is
- * TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
*/
response?: {[key: string]: any};
}
@@ -1317,8 +1083,7 @@ export namespace appengine_v1beta {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -1326,13 +1091,11 @@ export namespace appengine_v1beta {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -1354,8 +1117,7 @@ export namespace appengine_v1beta {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -1363,13 +1125,11 @@ export namespace appengine_v1beta {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -1391,8 +1151,7 @@ export namespace appengine_v1beta {
*/
endTime?: string;
/**
- * Ephemeral message that may change every time the operation is polled.
- * @OutputOnly
+ * Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string;
/**
@@ -1400,13 +1159,11 @@ export namespace appengine_v1beta {
*/
insertTime?: string;
/**
- * API method that initiated this operation. Example:
- * google.appengine.v1beta.Versions.CreateVersion.@OutputOnly
+ * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
- * Name of the resource that this operation is acting on. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
@@ -1419,14 +1176,11 @@ export namespace appengine_v1beta {
warning?: string[];
}
/**
- * Readiness checking configuration for VM instances. Unhealthy instances are
- * removed from traffic rotation.
+ * Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
*/
export interface Schema$ReadinessCheck {
/**
- * A maximum time limit on application initialization, measured from moment
- * the application successfully replies to a healthcheck until it is ready
- * to serve traffic.
+ * A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
*/
appStartTimeout?: string;
/**
@@ -1438,8 +1192,7 @@ export namespace appengine_v1beta {
*/
failureThreshold?: number;
/**
- * Host header to send when performing a HTTP Readiness check. Example:
- * "myapp.appspot.com"
+ * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
*/
host?: string;
/**
@@ -1447,8 +1200,7 @@ export namespace appengine_v1beta {
*/
path?: string;
/**
- * Number of consecutive successful checks required before receiving
- * traffic.
+ * Number of consecutive successful checks required before receiving traffic.
*/
successThreshold?: number;
/**
@@ -1461,8 +1213,7 @@ export namespace appengine_v1beta {
*/
export interface Schema$RepairApplicationRequest {}
/**
- * Target scaling by request utilization. Only applicable in the App Engine
- * flexible environment.
+ * Target scaling by request utilization. Only applicable in the App Engine flexible environment.
*/
export interface Schema$RequestUtilization {
/**
@@ -1479,13 +1230,11 @@ export namespace appengine_v1beta {
*/
export interface Schema$ResourceRecord {
/**
- * Relative name of the object affected by this record. Only applicable for
- * CNAME records. Example: 'www'.
+ * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
*/
name?: string;
/**
- * Data for this record. Values vary by record type, as defined in RFC 1035
- * (section 5) and RFC 1034 (section 3.6.1).
+ * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
*/
rrdata?: string;
/**
@@ -1524,27 +1273,19 @@ export namespace appengine_v1beta {
scriptPath?: string;
}
/**
- * A Service resource is a logical component of an application that can share
- * state and communicate in a secure fashion with other services. For example,
- * an application that handles customer requests might include separate
- * services to handle tasks such as backend data analysis or API requests from
- * mobile devices. Each service has a collection of versions that define a
- * specific set of code used to implement the functionality of that service.
+ * A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
*/
export interface Schema$Service {
/**
- * Relative name of the service within the application. Example:
- * default.@OutputOnly
+ * Relative name of the service within the application. Example: default.@OutputOnly
*/
id?: string;
/**
- * Full path to the Service resource in the API. Example:
- * apps/myapp/services/default.@OutputOnly
+ * Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
*/
name?: string;
/**
- * Mapping that defines fractional HTTP traffic diversion to different
- * versions within the service.
+ * Mapping that defines fractional HTTP traffic diversion to different versions within the service.
*/
split?: Schema$TrafficSplit;
}
@@ -1553,29 +1294,15 @@ export namespace appengine_v1beta {
*/
export interface Schema$SslSettings {
/**
- * ID of the AuthorizedCertificate resource configuring SSL for the
- * application. Clearing this field will remove SSL support.By default, a
- * managed certificate is automatically created for every domain mapping. To
- * omit SSL support or to configure SSL manually, specify
- * SslManagementType.MANUAL on a CREATE or UPDATE request. You must be
- * authorized to administer the AuthorizedCertificate resource to manually
- * map it to a DomainMapping resource. Example: 12345.
+ * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
*/
certificateId?: string;
/**
- * ID of the managed AuthorizedCertificate resource currently being
- * provisioned, if applicable. Until the new managed certificate has been
- * successfully provisioned, the previous SSL state will be preserved. Once
- * the provisioning process completes, the certificate_id field will reflect
- * the new managed certificate and this field will be left empty. To remove
- * SSL support while there is still a pending managed certificate, clear the
- * certificate_id field with an UpdateDomainMappingRequest.@OutputOnly
+ * ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly
*/
pendingManagedCertificateId?: string;
/**
- * SSL management type for this domain. If AUTOMATIC, a managed certificate
- * is automatically provisioned. If MANUAL, certificate_id must be manually
- * specified in order to configure SSL for this domain.
+ * SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
*/
sslManagementType?: string;
}
@@ -1584,13 +1311,11 @@ export namespace appengine_v1beta {
*/
export interface Schema$StandardSchedulerSettings {
/**
- * Maximum number of instances to run for this version. Set to zero to
- * disable max_instances configuration.
+ * Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.
*/
maxInstances?: number;
/**
- * Minimum number of instances to run for this version. Set to zero to
- * disable min_instances configuration.
+ * Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
*/
minInstances?: number;
/**
@@ -1603,23 +1328,15 @@ export namespace appengine_v1beta {
targetThroughputUtilization?: number;
}
/**
- * Files served directly to the user for a given URL, such as images, CSS
- * stylesheets, or JavaScript source files. Static file handlers describe
- * which files in the application directory are static files, and which URLs
- * serve them.
+ * Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.
*/
export interface Schema$StaticFilesHandler {
/**
- * Whether files should also be uploaded as code data. By default, files
- * declared in static file handlers are uploaded as static data and are only
- * served to end users; they cannot be read by the application. If enabled,
- * uploads are charged against both your code and static data storage
- * resource quotas.
+ * Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
*/
applicationReadable?: boolean;
/**
- * Time a static file served by this handler should be cached by web proxies
- * and browsers.
+ * Time a static file served by this handler should be cached by web proxies and browsers.
*/
expiration?: string;
/**
@@ -1627,62 +1344,24 @@ export namespace appengine_v1beta {
*/
httpHeaders?: {[key: string]: string};
/**
- * MIME type used to serve all files served by this handler.Defaults to
- * file-specific MIME types, which are derived from each file's filename
- * extension.
+ * MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
*/
mimeType?: string;
/**
- * Path to the static files matched by the URL pattern, from the application
- * root directory. The path can refer to text matched in groupings in the
- * URL pattern.
+ * Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
*/
path?: string;
/**
- * Whether this handler should match the request if the file referenced by
- * the handler does not exist.
+ * Whether this handler should match the request if the file referenced by the handler does not exist.
*/
requireMatchingFile?: boolean;
/**
- * Regular expression that matches the file paths for all files that should
- * be referenced by this handler.
+ * Regular expression that matches the file paths for all files that should be referenced by this handler.
*/
uploadPathRegex?: string;
}
/**
- * The Status type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by gRPC (https://github.com/grpc). The error model is designed to be:
- * Simple to use and understand for most users Flexible enough to meet
- * unexpected needsOverviewThe Status message contains three pieces of data:
- * error code, error message, and error details. The error code should be an
- * enum value of google.rpc.Code, but it may accept additional error codes if
- * needed. The error message should be a developer-facing English message that
- * helps developers understand and resolve the error. If a localized
- * user-facing error message is needed, put the localized message in the error
- * details or localize it in the client. The optional error details may
- * contain arbitrary information about the error. There is a predefined set of
- * error detail types in the package google.rpc that can be used for common
- * error conditions.Language mappingThe Status message is the logical
- * representation of the error model, but it is not necessarily the actual
- * wire format. When the Status message is exposed in different client
- * libraries and different wire protocols, it can be mapped differently. For
- * example, it will likely be mapped to some exceptions in Java, but more
- * likely mapped to some error codes in C.Other usesThe error model and the
- * Status message can be used in a variety of environments, either with or
- * without APIs, to provide a consistent developer experience across different
- * environments.Example uses of this error model include: Partial errors. If a
- * service needs to return partial errors to the client, it may embed the
- * Status in the normal response to indicate the partial errors. Workflow
- * errors. A typical workflow has multiple steps. Each step may have a Status
- * message for error reporting. Batch operations. If a client uses batch
- * request and batch response, the Status message should be used directly
- * inside batch response, one for each error sub-response. Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the Status message. Logging. If some API errors are stored in logs,
- * the message Status could be used directly after any stripping needed for
- * security/privacy reasons.
+ * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -1690,37 +1369,24 @@ export namespace appengine_v1beta {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set of
- * message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
- * Traffic routing configuration for versions within a single service. Traffic
- * splits define how traffic directed to the service is assigned to versions.
+ * Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
*/
export interface Schema$TrafficSplit {
/**
- * Mapping from version IDs within the service to fractional (0.000, 1]
- * allocations of traffic for that version. Each version can be specified
- * only once, but some versions in the service may not have any traffic
- * allocation. Services that have traffic allocated cannot be deleted until
- * either the service is deleted or their traffic allocation is removed.
- * Allocations must sum to 1. Up to two decimal place precision is supported
- * for IP-based splits and up to three decimal places is supported for
- * cookie-based splits.
+ * Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
*/
allocations?: {[key: string]: number};
/**
- * Mechanism used to determine which version a request is sent to. The
- * traffic selection algorithm will be stable for either type until
- * allocations are changed.
+ * Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
*/
shardBy?: string;
}
@@ -1729,27 +1395,20 @@ export namespace appengine_v1beta {
*/
export interface Schema$UrlDispatchRule {
/**
- * Domain name to match against. The wildcard "*" is supported if
- * specified before a period: "*.".Defaults to matching all
- * domains: "*".
+ * Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
*/
domain?: string;
/**
- * Pathname within the host. Must start with a "/". A single
- * "*" can be included at the end of the path.The sum of the
- * lengths of the domain and path may not exceed 100 characters.
+ * Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
*/
path?: string;
/**
- * Resource ID of a service in this application that should serve the
- * matched request. The service must already exist. Example: default.
+ * Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
*/
service?: string;
}
/**
- * URL pattern and description of how the URL should be handled. App Engine
- * can handle URLs by executing application code or by serving static files
- * uploaded with the version, such as images, CSS, or JavaScript.
+ * URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
*/
export interface Schema$UrlMap {
/**
@@ -1757,24 +1416,19 @@ export namespace appengine_v1beta {
*/
apiEndpoint?: Schema$ApiEndpointHandler;
/**
- * Action to take when users access resources that require authentication.
- * Defaults to redirect.
+ * Action to take when users access resources that require authentication. Defaults to redirect.
*/
authFailAction?: string;
/**
- * Level of login required to access this resource. Not supported for
- * Node.js in the App Engine standard environment.
+ * Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
*/
login?: string;
/**
- * 30x code to use when performing redirects for the secure field. Defaults
- * to 302.
+ * 30x code to use when performing redirects for the secure field. Defaults to 302.
*/
redirectHttpResponseCode?: string;
/**
- * Executes a script to handle the requests that match this URL pattern.
- * Only the auto value is supported for Node.js in the App Engine standard
- * environment, for example "script": "auto".
+ * Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
*/
script?: Schema$ScriptHandler;
/**
@@ -1786,39 +1440,28 @@ export namespace appengine_v1beta {
*/
staticFiles?: Schema$StaticFilesHandler;
/**
- * URL prefix. Uses regular expression syntax, which means regexp special
- * characters must be escaped, but should not contain groupings. All URLs
- * that begin with this prefix are handled by this handler, using the
- * portion of the URL after the prefix as part of the file path.
+ * URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
*/
urlRegex?: string;
}
/**
- * A Version resource is a specific set of source code and configuration files
- * that are deployed into a service.
+ * A Version resource is a specific set of source code and configuration files that are deployed into a service.
*/
export interface Schema$Version {
/**
- * Serving configuration for Google Cloud Endpoints
- * (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned
- * in GET requests if view=FULL is set.
+ * Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
*/
apiConfig?: Schema$ApiConfigHandler;
/**
- * Automatic scaling is based on request rate, response latencies, and other
- * application metrics.
+ * Automatic scaling is based on request rate, response latencies, and other application metrics.
*/
automaticScaling?: Schema$AutomaticScaling;
/**
- * A service with basic scaling will create an instance when the application
- * receives a request. The instance will be turned down when the app becomes
- * idle. Basic scaling is ideal for work that is intermittent or driven by
- * user activity.
+ * A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
*/
basicScaling?: Schema$BasicScaling;
/**
- * Metadata settings that are supplied to this version to enable beta
- * runtime features.
+ * Metadata settings that are supplied to this version to enable beta runtime features.
*/
betaSettings?: {[key: string]: string};
/**
@@ -1830,27 +1473,19 @@ export namespace appengine_v1beta {
*/
createTime?: string;
/**
- * Duration that static files should be cached by web proxies and browsers.
- * Only applicable if the corresponding StaticFilesHandler
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler)
- * does not specify its own expiration time.Only returned in GET requests if
- * view=FULL is set.
+ * Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
*/
defaultExpiration?: string;
/**
- * Code and application artifacts that make up this version.Only returned in
- * GET requests if view=FULL is set.
+ * Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
*/
deployment?: Schema$Deployment;
/**
- * Total size in bytes of all the files that are included in this version
- * and currently hosted on the App Engine disk.@OutputOnly
+ * Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
*/
diskUsageBytes?: string;
/**
- * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud
- * Endpoints Extensible Service Proxy will be provided to serve the API
- * implemented by the app.
+ * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
*/
endpointsApiService?: Schema$EndpointsApiService;
/**
@@ -1862,88 +1497,63 @@ export namespace appengine_v1beta {
*/
env?: string;
/**
- * Environment variables available to the application.Only returned in GET
- * requests if view=FULL is set.
+ * Environment variables available to the application.Only returned in GET requests if view=FULL is set.
*/
envVariables?: {[key: string]: string};
/**
- * Custom static error pages. Limited to 10KB per page.Only returned in GET
- * requests if view=FULL is set.
+ * Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
*/
errorHandlers?: Schema$ErrorHandler[];
/**
- * An ordered list of URL-matching patterns that should be applied to
- * incoming requests. The first matching URL handles the request and other
- * request handlers are not attempted.Only returned in GET requests if
- * view=FULL is set.
+ * An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
*/
handlers?: Schema$UrlMap[];
/**
- * Configures health checking for instances. Unhealthy instances are stopped
- * and replaced with new instances. Only applicable in the App Engine
- * flexible environment.Only returned in GET requests if view=FULL is set.
+ * Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.
*/
healthCheck?: Schema$HealthCheck;
/**
- * Relative name of the version within the service. Example: v1. Version
- * names can contain only lowercase letters, numbers, or hyphens. Reserved
- * names: "default", "latest", and any name with the
- * prefix "ah-".
+ * Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
*/
id?: string;
/**
- * Before an application can receive email or XMPP messages, the application
- * must be configured to enable the service.
+ * Before an application can receive email or XMPP messages, the application must be configured to enable the service.
*/
inboundServices?: string[];
/**
- * Instance class that is used to run this version. Valid values are:
- * AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1,
- * B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for
- * ManualScaling or BasicScaling.
+ * Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
*/
instanceClass?: string;
/**
- * Configuration for third-party Python runtime libraries that are required
- * by the application.Only returned in GET requests if view=FULL is set.
+ * Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
*/
libraries?: Schema$Library[];
/**
- * Configures liveness health checking for instances. Unhealthy instances
- * are stopped and replaced with new instancesOnly returned in GET requests
- * if view=FULL is set.
+ * Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
*/
livenessCheck?: Schema$LivenessCheck;
/**
- * A service with manual scaling runs continuously, allowing you to perform
- * complex initialization and rely on the state of its memory over time.
+ * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
*/
manualScaling?: Schema$ManualScaling;
/**
- * Full path to the Version resource in the API. Example:
- * apps/myapp/services/default/versions/v1.@OutputOnly
+ * Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
*/
name?: string;
/**
- * Extra network settings. Only applicable in the App Engine flexible
- * environment.
+ * Extra network settings. Only applicable in the App Engine flexible environment.
*/
network?: Schema$Network;
/**
- * Files that match this pattern will not be built into this version. Only
- * applicable for Go runtimes.Only returned in GET requests if view=FULL is
- * set.
+ * Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
*/
nobuildFilesRegex?: string;
/**
- * Configures readiness health checking for instances. Unhealthy instances
- * are not put into the backend traffic rotation.Only returned in GET
- * requests if view=FULL is set.
+ * Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
*/
readinessCheck?: Schema$ReadinessCheck;
/**
- * Machine resources for this version. Only applicable in the App Engine
- * flexible environment.
+ * Machine resources for this version. Only applicable in the App Engine flexible environment.
*/
resources?: Schema$Resources;
/**
@@ -1951,14 +1561,11 @@ export namespace appengine_v1beta {
*/
runtime?: string;
/**
- * The version of the API in the given runtime environment. Please see the
- * app.yaml reference for valid values at
- * https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ * The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
*/
runtimeApiVersion?: string;
/**
- * The channel of the runtime to use. Only available for some runtimes.
- * Defaults to the default channel.
+ * The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
*/
runtimeChannel?: string;
/**
@@ -1966,9 +1573,7 @@ export namespace appengine_v1beta {
*/
runtimeMainExecutablePath?: string;
/**
- * Current serving status of this version. Only the versions with a SERVING
- * status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is
- * an invalid value. Defaults to SERVING.
+ * Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
*/
servingStatus?: string;
/**
@@ -1976,8 +1581,7 @@ export namespace appengine_v1beta {
*/
threadsafe?: boolean;
/**
- * Serving URL for this version. Example:
- * "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ * Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
*/
versionUrl?: string;
/**
@@ -1989,14 +1593,12 @@ export namespace appengine_v1beta {
*/
vpcAccessConnector?: Schema$VpcAccessConnector;
/**
- * The Google Compute Engine zones that are supported by this version in the
- * App Engine flexible environment. Deprecated.
+ * The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
*/
zones?: string[];
}
/**
- * Volumes mounted within the app container. Only applicable in the App Engine
- * flexible environment.
+ * Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
*/
export interface Schema$Volume {
/**
@@ -2017,8 +1619,7 @@ export namespace appengine_v1beta {
*/
export interface Schema$VpcAccessConnector {
/**
- * Full Serverless VPC Access Connector name e.g.
- * /projects/my-project/locations/us-central1/connectors/c1.
+ * Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
*/
name?: string;
}
@@ -2027,15 +1628,11 @@ export namespace appengine_v1beta {
*/
export interface Schema$ZipInfo {
/**
- * An estimate of the number of files in a zip for a zip deployment. If set,
- * must be greater than or equal to the actual number of files. Used for
- * optimizing performance; if not provided, deployment may be slow.
+ * An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
*/
filesCount?: number;
/**
- * URL of the zip file to deploy from. Must be a URL to a resource in Google
- * Cloud Storage in the form
- * 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ * URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
*/
sourceUrl?: string;
}
@@ -2066,13 +1663,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.create
- * @desc Creates an App Engine application for a Google Cloud Platform
- * project. Required fields: id - The ID of the target Cloud Platform
- * project. location - The region
- * (https://cloud.google.com/appengine/docs/locations) where you want the
- * App Engine application located.For more information about App Engine
- * applications, see Managing Projects, Applications, and Billing
- * (https://cloud.google.com/appengine/docs/standard/python/console/).
+ * @desc Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/).
* @alias appengine.apps.create
* @memberOf! ()
*
@@ -2215,10 +1806,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.patch
- * @desc Updates the specified Application resource. You can update the
- * following fields: auth_domain - Google authentication domain for
- * controlling user access to the application. default_cookie_expiration -
- * Cookie expiration policy for the application.
+ * @desc Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.
* @alias appengine.apps.patch
* @memberOf! ()
*
@@ -2293,16 +1881,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.repair
- * @desc Recreates the required App Engine features for the specified App
- * Engine application, for example a Cloud Storage bucket or App Engine
- * service account. Use this method if you receive an error message about a
- * missing feature, for example, Error retrieving the App Engine service
- * account. If you have deleted your App Engine service account, this will
- * not be able to recreate it. Instead, you should attempt to use the IAM
- * undelete API if possible at
- * https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D
- * . If the deletion was recent, the numeric ID can be found in the Cloud
- * Console Activity Log.
+ * @desc Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.
* @alias appengine.apps.repair
* @memberOf! ()
*
@@ -2393,8 +1972,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Application resource to get. Example:
- * apps/myapp.
+ * Part of `name`. Name of the Application resource to get. Example: apps/myapp.
*/
appsId?: string;
}
@@ -2405,8 +1983,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Application resource to update. Example:
- * apps/myapp.
+ * Part of `name`. Name of the Application resource to update. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -2756,11 +2333,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.authorizedCertificates.patch
- * @desc Updates the specified SSL certificate. To renew a certificate and
- * maintain its existing domain mappings, update certificate_data with a new
- * certificate. The new certificate must be applicable to the same domains
- * as the original certificate. The certificate display_name may also be
- * updated.
+ * @desc Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
* @alias appengine.apps.authorizedCertificates.patch
* @memberOf! ()
*
@@ -2846,8 +2419,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
@@ -2864,8 +2436,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to delete. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -2881,8 +2452,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -2902,8 +2472,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -2927,8 +2496,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/authorizedCertificates/12345.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
@@ -2936,8 +2504,7 @@ export namespace appengine_v1beta {
*/
authorizedCertificatesId?: string;
/**
- * Standard field mask for the set of fields to be updated. Updates are only
- * supported on the certificate_raw_data and display_name fields.
+ * Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
*/
updateMask?: string;
@@ -3047,8 +2614,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -3069,10 +2635,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.domainMappings.create
- * @desc Maps a domain to an application. A user must be authorized to
- * administer a domain in order to map it to an application. For a list of
- * available authorized domains, see
- * AuthorizedDomains.ListAuthorizedDomains.
+ * @desc Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.
* @alias appengine.apps.domainMappings.create
* @memberOf! ()
*
@@ -3148,9 +2711,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.domainMappings.delete
- * @desc Deletes the specified domain mapping. A user must be authorized to
- * administer the associated domain in order to delete a DomainMapping
- * resource.
+ * @desc Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
* @alias appengine.apps.domainMappings.delete
* @memberOf! ()
*
@@ -3383,10 +2944,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.domainMappings.patch
- * @desc Updates the specified domain mapping. To map an SSL certificate to
- * a domain mapping, update certificate_id to point to an
- * AuthorizedCertificate resource. A user must be authorized to administer
- * the associated domain in order to update a DomainMapping resource.
+ * @desc Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
* @alias appengine.apps.domainMappings.patch
* @memberOf! ()
*
@@ -3470,13 +3028,11 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
- * Whether the domain creation should override any existing mappings for
- * this domain. By default, overrides are rejected.
+ * Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
*/
overrideStrategy?: string;
@@ -3493,8 +3049,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to delete. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -3510,8 +3065,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -3527,8 +3081,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -3548,8 +3101,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/domainMappings/example.com.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
@@ -3584,11 +3136,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.firewall.ingressRules.batchUpdate
- * @desc Replaces the entire firewall ruleset in one bulk operation. This
- * overrides and replaces the rules of an existing firewall with the new
- * rules.If the final rule does not match traffic with the '*' wildcard IP
- * range, then an "allow all" rule is explicitly added to the end of the
- * list.
+ * @desc Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.
* @alias appengine.apps.firewall.ingressRules.batchUpdate
* @memberOf! ()
*
@@ -4056,8 +3604,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Firewall collection to set. Example:
- * apps/myapp/firewall/ingressRules.
+ * Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.
*/
appsId?: string;
@@ -4074,8 +3621,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Firewall collection in which to
- * create a new rule. Example: apps/myapp/firewall/ingressRules.
+ * Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.
*/
appsId?: string;
@@ -4092,8 +3638,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Firewall resource to delete. Example:
- * apps/myapp/firewall/ingressRules/100.
+ * Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
@@ -4109,8 +3654,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Firewall resource to retrieve. Example:
- * apps/myapp/firewall/ingressRules/100.
+ * Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
@@ -4126,14 +3670,11 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the Firewall collection to retrieve. Example:
- * apps/myapp/firewall/ingressRules.
+ * Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.
*/
appsId?: string;
/**
- * A valid IP Address. If set, only rules matching this address will be
- * returned. The first returned rule will be the rule that fires on requests
- * from this IP.
+ * A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.
*/
matchingAddress?: string;
/**
@@ -4153,8 +3694,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the Firewall resource to update. Example:
- * apps/myapp/firewall/ingressRules/100.
+ * Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
@@ -4354,8 +3894,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. The resource that owns the locations collection, if
- * applicable.
+ * Part of `name`. The resource that owns the locations collection, if applicable.
*/
appsId?: string;
/**
@@ -4380,9 +3919,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.operations.get
- * @desc Gets the latest state of a long-running operation. Clients can use
- * this method to poll the operation result at intervals as recommended by
- * the API service.
+ * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias appengine.apps.operations.get
* @memberOf! ()
*
@@ -4456,15 +3993,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.operations.list
- * @desc Lists operations that match the specified filter in the request. If
- * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE:
- * the name binding allows API services to override the binding to use
- * different resource name schemes, such as users/x/operations. To override
- * the binding, API services can add a binding such as
- * "/v1/{name=users/x}/operations" to their service configuration. For
- * backwards compatibility, the default name includes the operations
- * collection id, however overriding users must ensure the name binding is
- * the parent resource, without the operations collection id.
+ * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @alias appengine.apps.operations.list
* @memberOf! ()
*
@@ -4901,8 +4430,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
@@ -4918,8 +4446,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
@@ -4935,8 +4462,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Application resource. Example:
- * apps/myapp.
+ * Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
*/
appsId?: string;
/**
@@ -4956,24 +4482,11 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/services/default.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
- * Set to true to gradually shift traffic to one or more versions that you
- * specify. By default, traffic is shifted immediately. For gradual traffic
- * migration, the target versions must be located within instances that are
- * configured for both warmup requests
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType)
- * and automatic scaling
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling).
- * You must specify the shardBy
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy)
- * field in the Service resource. Gradual traffic migration is not supported
- * in the App Engine flexible environment. For examples, see Migrating and
- * Splitting Traffic
- * (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
+ * Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
*/
migrateTraffic?: boolean;
/**
@@ -5154,9 +4667,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.services.versions.get
- * @desc Gets the specified Version resource. By default, only a BASIC_VIEW
- * will be returned. Specify the FULL_VIEW parameter to get the full
- * resource.
+ * @desc Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.
* @alias appengine.apps.services.versions.get
* @memberOf! ()
*
@@ -5310,36 +4821,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.services.versions.patch
- * @desc Updates the specified Version resource. You can specify the
- * following fields depending on the App Engine environment and type of
- * scaling that the version resource uses:Standard environment
- * instance_class
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic
- * scaling in the standard environment: automatic_scaling.min_idle_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automatic_scaling.max_idle_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automaticScaling.standard_scheduler_settings.max_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)
- * automaticScaling.standard_scheduler_settings.min_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)
- * automaticScaling.standard_scheduler_settings.target_cpu_utilization
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)
- * automaticScaling.standard_scheduler_settings.target_throughput_utilization
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic
- * scaling or manual scaling in the standard environment: serving_status
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)Flexible
- * environment serving_status
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic
- * scaling in the flexible environment:
- * automatic_scaling.min_total_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automatic_scaling.max_total_instances
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automatic_scaling.cool_down_period_sec
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)
- * automatic_scaling.cpu_utilization.target_utilization
- * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)
+ * @desc Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)
* @alias appengine.apps.services.versions.patch
* @memberOf! ()
*
@@ -5424,8 +4906,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent resource to create this version
- * under. Example: apps/myapp/services/default.
+ * Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
@@ -5446,8 +4927,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
@@ -5467,8 +4947,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
@@ -5492,8 +4971,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Service resource. Example:
- * apps/myapp/services/default.
+ * Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
@@ -5521,8 +4999,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource to update. Example:
- * apps/myapp/services/default/versions/1.
+ * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.
*/
appsId?: string;
/**
@@ -5552,12 +5029,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.services.versions.instances.debug
- * @desc Enables debugging on a VM instance. This allows you to use the SSH
- * command to connect to the virtual machine where the instance lives. While
- * in "debug mode", the instance continues to serve live traffic. You should
- * delete the instance when you are done debugging and then allow the system
- * to take over and determine if another instance should be started.Only
- * applicable for instances in App Engine flexible environment.
+ * @desc Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.
* @alias appengine.apps.services.versions.instances.debug
* @memberOf! ()
*
@@ -5787,9 +5259,7 @@ export namespace appengine_v1beta {
/**
* appengine.apps.services.versions.instances.list
- * @desc Lists the instances of a version.Tip: To aggregate details about
- * instances over time, see the Stackdriver Monitoring API
- * (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
+ * @desc Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
* @alias appengine.apps.services.versions.instances.list
* @memberOf! ()
*
@@ -5876,8 +5346,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1/instances/instance-1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
@@ -5906,8 +5375,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1/instances/instance-1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
@@ -5931,8 +5399,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `name`. Name of the resource requested. Example:
- * apps/myapp/services/default/versions/v1/instances/instance-1.
+ * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
@@ -5956,8 +5423,7 @@ export namespace appengine_v1beta {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Part of `parent`. Name of the parent Version resource. Example:
- * apps/myapp/services/default/versions/v1.
+ * Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
diff --git a/src/apis/appsactivity/package.json b/src/apis/appsactivity/package.json
index ca3d71e1e0c..c61fb91ddad 100644
--- a/src/apis/appsactivity/package.json
+++ b/src/apis/appsactivity/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/appsactivity/v1.ts b/src/apis/appsactivity/v1.ts
index cc323219eba..89c633aedfd 100644
--- a/src/apis/appsactivity/v1.ts
+++ b/src/apis/appsactivity/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace appsactivity_v1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace appsactivity_v1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -95,16 +92,17 @@ export namespace appsactivity_v1 {
activities: Resource$Activities;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.activities = new Resource$Activities(this.context);
}
}
/**
- * An Activity resource is a combined view of multiple events. An activity has
- * a list of individual events and a combined view of the common fields among
- * all events.
+ * An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.
*/
export interface Schema$Activity {
/**
@@ -121,14 +119,11 @@ export namespace appsactivity_v1 {
*/
export interface Schema$Event {
/**
- * Additional event types. Some events may have multiple types when multiple
- * actions are part of a single event. For example, creating a document,
- * renaming it, and sharing it may be part of a single file-creation event.
+ * Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.
*/
additionalEventTypes?: string[];
/**
- * The time at which the event occurred formatted as Unix time in
- * milliseconds.
+ * The time at which the event occurred formatted as Unix time in milliseconds.
*/
eventTimeMillis?: string;
/**
@@ -136,13 +131,11 @@ export namespace appsactivity_v1 {
*/
fromUserDeletion?: boolean;
/**
- * Extra information for move type events, such as changes in an
- * object's parents.
+ * Extra information for move type events, such as changes in an object's parents.
*/
move?: Schema$Move;
/**
- * Extra information for permissionChange type events, such as the user or
- * group the new permission applies to.
+ * Extra information for permissionChange type events, such as the user or group the new permission applies to.
*/
permissionChanges?: Schema$PermissionChange[];
/**
@@ -163,8 +156,7 @@ export namespace appsactivity_v1 {
user?: Schema$User;
}
/**
- * The response from the list request. Contains a list of activities and a
- * token to retrieve the next page of results.
+ * The response from the list request. Contains a list of activities and a token to retrieve the next page of results.
*/
export interface Schema$ListActivitiesResponse {
/**
@@ -177,8 +169,7 @@ export namespace appsactivity_v1 {
nextPageToken?: string;
}
/**
- * Contains information about changes in an object's parents as a result
- * of a move type event.
+ * Contains information about changes in an object's parents as a result of a move type event.
*/
export interface Schema$Move {
/**
@@ -191,8 +182,7 @@ export namespace appsactivity_v1 {
removedParents?: Schema$Parent[];
}
/**
- * Contains information about a parent object. For example, a folder in Drive
- * is a parent for all files within it.
+ * Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
*/
export interface Schema$Parent {
/**
@@ -209,9 +199,7 @@ export namespace appsactivity_v1 {
title?: string;
}
/**
- * Contains information about the permissions and type of access allowed with
- * regards to a Google Drive object. This is a subset of the fields contained
- * in a corresponding Drive Permissions object.
+ * Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
*/
export interface Schema$Permission {
/**
@@ -219,13 +207,11 @@ export namespace appsactivity_v1 {
*/
name?: string;
/**
- * The ID for this permission. Corresponds to the Drive API's permission
- * ID returned as part of the Drive Permissions resource.
+ * The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
*/
permissionId?: string;
/**
- * Indicates the Google Drive permissions role. The role determines a
- * user's ability to read, write, or comment on the file.
+ * Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
*/
role?: string;
/**
@@ -242,8 +228,7 @@ export namespace appsactivity_v1 {
withLink?: boolean;
}
/**
- * Contains information about a Drive object's permissions that changed as
- * a result of a permissionChange type event.
+ * Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
*/
export interface Schema$PermissionChange {
/**
@@ -282,8 +267,7 @@ export namespace appsactivity_v1 {
*/
export interface Schema$Target {
/**
- * The ID of the target. For example, in Google Drive, this is the file or
- * folder ID.
+ * The ID of the target. For example, in Google Drive, this is the file or folder ID.
*/
id?: string;
/**
@@ -291,8 +275,7 @@ export namespace appsactivity_v1 {
*/
mimeType?: string;
/**
- * The name of the target. For example, in Google Drive, this is the title
- * of the file.
+ * The name of the target. For example, in Google Drive, this is the title of the file.
*/
name?: string;
}
@@ -301,8 +284,7 @@ export namespace appsactivity_v1 {
*/
export interface Schema$User {
/**
- * A boolean which indicates whether the specified User was deleted. If
- * true, name, photo and permission_id will be omitted.
+ * A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
*/
isDeleted?: boolean;
/**
@@ -314,14 +296,11 @@ export namespace appsactivity_v1 {
*/
name?: string;
/**
- * The permission ID associated with this user. Equivalent to the Drive
- * API's permission ID for this user, returned as part of the Drive
- * Permissions resource.
+ * The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
*/
permissionId?: string;
/**
- * The profile photo of the user. Not present if the user has no profile
- * photo.
+ * The profile photo of the user. Not present if the user has no profile photo.
*/
photo?: Schema$Photo;
}
@@ -334,12 +313,7 @@ export namespace appsactivity_v1 {
/**
* appsactivity.activities.list
- * @desc Returns a list of activities visible to the current logged in user.
- * Visible activities are determined by the visibility settings of the
- * object that was acted on, e.g. Drive files a user can see. An activity is
- * a record of past events. Multiple events may be merged if they are
- * similar. A request is scoped to activities from a given Google service
- * using the source parameter.
+ * @desc Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.
* @alias appsactivity.activities.list
* @memberOf! ()
*
@@ -426,8 +400,7 @@ export namespace appsactivity_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifies the Drive folder containing the items for which to return
- * activities.
+ * Identifies the Drive folder containing the items for which to return activities.
*/
'drive.ancestorId'?: string;
/**
@@ -435,13 +408,11 @@ export namespace appsactivity_v1 {
*/
'drive.fileId'?: string;
/**
- * Indicates the strategy to use when grouping singleEvents items in the
- * associated combinedEvent object.
+ * Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.
*/
groupingStrategy?: string;
/**
- * The maximum number of events to return on a page. The response includes a
- * continuation token if there are more events.
+ * The maximum number of events to return on a page. The response includes a continuation token if there are more events.
*/
pageSize?: number;
/**
@@ -449,14 +420,11 @@ export namespace appsactivity_v1 {
*/
pageToken?: string;
/**
- * The Google service from which to return activities. Possible values of
- * source are: - drive.google.com
+ * The Google service from which to return activities. Possible values of source are: - drive.google.com
*/
source?: string;
/**
- * The ID used for ACL checks (does not filter the resulting event list by
- * the assigned value). Use the special value me to indicate the currently
- * authenticated user.
+ * The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.
*/
userId?: string;
}
diff --git a/src/apis/appstate/package.json b/src/apis/appstate/package.json
index 48d8f085480..57c7c150ee8 100644
--- a/src/apis/appstate/package.json
+++ b/src/apis/appstate/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/appstate/v1.ts b/src/apis/appstate/v1.ts
index cf5f98d952a..453499a00d8 100644
--- a/src/apis/appstate/v1.ts
+++ b/src/apis/appstate/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace appstate_v1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace appstate_v1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -95,7 +92,10 @@ export namespace appstate_v1 {
states: Resource$States;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.states = new Resource$States(this.context);
}
@@ -114,8 +114,7 @@ export namespace appstate_v1 {
*/
data?: string;
/**
- * Uniquely identifies the type of this resource. Value is always the fixed
- * string appstate#getResponse.
+ * Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.
*/
kind?: string;
/**
@@ -132,8 +131,7 @@ export namespace appstate_v1 {
*/
items?: Schema$GetResponse[];
/**
- * Uniquely identifies the type of this resource. Value is always the fixed
- * string appstate#listResponse.
+ * Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse.
*/
kind?: string;
/**
@@ -150,8 +148,7 @@ export namespace appstate_v1 {
*/
data?: string;
/**
- * Uniquely identifies the type of this resource. Value is always the fixed
- * string appstate#updateRequest.
+ * Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest.
*/
kind?: string;
}
@@ -164,8 +161,7 @@ export namespace appstate_v1 {
*/
currentStateVersion?: string;
/**
- * Uniquely identifies the type of this resource. Value is always the fixed
- * string appstate#writeResult.
+ * Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.
*/
kind?: string;
/**
@@ -182,9 +178,7 @@ export namespace appstate_v1 {
/**
* appstate.states.clear
- * @desc Clears (sets to empty) the data for the passed key if and only if
- * the passed version matches the currently stored version. This method
- * results in a conflict error on version mismatch.
+ * @desc Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.
* @alias appstate.states.clear
* @memberOf! ()
*
@@ -258,11 +252,7 @@ export namespace appstate_v1 {
/**
* appstate.states.delete
- * @desc Deletes a key and the data associated with it. The key is removed
- * and no longer counts against the key quota. Note that since this method
- * is not safe in the face of concurrent modifications, it should only be
- * used for development and testing purposes. Invoking this method in
- * shipping code can result in data loss and data corruption.
+ * @desc Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.
* @alias appstate.states.delete
* @memberOf! ()
*
@@ -333,8 +323,7 @@ export namespace appstate_v1 {
/**
* appstate.states.get
- * @desc Retrieves the data corresponding to the passed key. If the key does
- * not exist on the server, an HTTP 404 will be returned.
+ * @desc Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned.
* @alias appstate.states.get
* @memberOf! ()
*
@@ -480,9 +469,7 @@ export namespace appstate_v1 {
/**
* appstate.states.update
- * @desc Update the data associated with the input key if and only if the
- * passed version matches the currently stored version. This method is safe
- * in the face of concurrent writes. Maximum per-key size is 128KB.
+ * @desc Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.
* @alias appstate.states.update
* @memberOf! ()
*
@@ -563,8 +550,7 @@ export namespace appstate_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version of the data to be cleared. Version strings are returned by
- * the server.
+ * The version of the data to be cleared. Version strings are returned by the server.
*/
currentDataVersion?: string;
/**
@@ -612,10 +598,7 @@ export namespace appstate_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The version of the app state your application is attempting to update. If
- * this does not match the current version, this method will return a
- * conflict error. If there is no data stored on the server for this key,
- * the update will succeed irrespective of the value of this parameter.
+ * The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter.
*/
currentStateVersion?: string;
/**
diff --git a/src/apis/bigquery/package.json b/src/apis/bigquery/package.json
index e18eb555bbf..4b036fa724e 100644
--- a/src/apis/bigquery/package.json
+++ b/src/apis/bigquery/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts
index ea33a52b687..0cc60148c5f 100644
--- a/src/apis/bigquery/v2.ts
+++ b/src/apis/bigquery/v2.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace bigquery_v2 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace bigquery_v2 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -94,95 +91,99 @@ export namespace bigquery_v2 {
context: APIRequestContext;
datasets: Resource$Datasets;
jobs: Resource$Jobs;
+ models: Resource$Models;
projects: Resource$Projects;
tabledata: Resource$Tabledata;
tables: Resource$Tables;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.datasets = new Resource$Datasets(this.context);
this.jobs = new Resource$Jobs(this.context);
+ this.models = new Resource$Models(this.context);
this.projects = new Resource$Projects(this.context);
this.tabledata = new Resource$Tabledata(this.context);
this.tables = new Resource$Tables(this.context);
}
}
+ /**
+ * Aggregate metrics for classification models. For multi-class models, the metrics are either macro-averaged: metrics are calculated for each label and then an unweighted average is taken of those values or micro-averaged: the metric is calculated globally by counting the total number of correctly predicted rows.
+ */
+ export interface Schema$AggregateClassificationMetrics {
+ /**
+ * Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
+ */
+ accuracy?: number;
+ /**
+ * The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
+ */
+ f1Score?: number;
+ /**
+ * Logarithmic Loss. For multiclass this is a macro-averaged metric.
+ */
+ logLoss?: number;
+ /**
+ * Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
+ */
+ precision?: number;
+ /**
+ * Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
+ */
+ recall?: number;
+ /**
+ * Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
+ */
+ rocAuc?: number;
+ /**
+ * Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
+ */
+ threshold?: number;
+ }
export interface Schema$BigQueryModelTraining {
/**
- * [Output-only, Beta] Index of current ML training iteration. Updated
- * during create model query job to show job progress.
+ * [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
*/
currentIteration?: number;
/**
- * [Output-only, Beta] Expected number of iterations for the create model
- * query job specified as num_iterations in the input query. The actual
- * total number of iterations may be less than this number due to early
- * stop.
+ * [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
*/
expectedTotalIterations?: string;
}
export interface Schema$BigtableColumn {
/**
- * [Optional] The encoding of the values when the type is not STRING.
- * Acceptable encoding values are: TEXT - indicates values are alphanumeric
- * text strings. BINARY - indicates values are encoded using HBase
- * Bytes.toBytes family of functions. 'encoding' can also be set at
- * the column family level. However, the setting at this level takes
- * precedence if 'encoding' is set at both levels.
+ * [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
*/
encoding?: string;
/**
- * [Optional] If the qualifier is not a valid BigQuery field identifier i.e.
- * does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided
- * as the column field name and is used as field name in queries.
+ * [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
*/
fieldName?: string;
/**
- * [Optional] If this is set, only the latest version of value in this
- * column are exposed. 'onlyReadLatest' can also be set at the
- * column family level. However, the setting at this level takes precedence
- * if 'onlyReadLatest' is set at both levels.
+ * [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
*/
onlyReadLatest?: boolean;
/**
- * [Required] Qualifier of the column. Columns in the parent column family
- * that has this exact qualifier are exposed as . field. If the qualifier is
- * valid UTF-8 string, it can be specified in the qualifier_string field.
- * Otherwise, a base-64 encoded value must be set to qualifier_encoded. The
- * column field name is the same as the column qualifier. However, if the
- * qualifier is not a valid BigQuery field identifier i.e. does not match
- * [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
+ * [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
*/
qualifierEncoded?: string;
qualifierString?: string;
/**
- * [Optional] The type to convert the value in cells of this column. The
- * values are expected to be encoded using HBase Bytes.toBytes function when
- * using the BINARY encoding value. Following BigQuery types are allowed
- * (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is
- * BYTES. 'type' can also be set at the column family level.
- * However, the setting at this level takes precedence if 'type' is
- * set at both levels.
+ * [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
*/
type?: string;
}
export interface Schema$BigtableColumnFamily {
/**
- * [Optional] Lists of columns that should be exposed as individual fields
- * as opposed to a list of (column name, value) pairs. All columns whose
- * qualifier matches a qualifier in this list can be accessed as .. Other
- * columns can be accessed as a list through .Column field.
+ * [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
*/
columns?: Schema$BigtableColumn[];
/**
- * [Optional] The encoding of the values when the type is not STRING.
- * Acceptable encoding values are: TEXT - indicates values are alphanumeric
- * text strings. BINARY - indicates values are encoded using HBase
- * Bytes.toBytes family of functions. This can be overridden for a specific
- * column by listing that column in 'columns' and specifying an
- * encoding for it.
+ * [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
*/
encoding?: string;
/**
@@ -190,76 +191,93 @@ export namespace bigquery_v2 {
*/
familyId?: string;
/**
- * [Optional] If this is set only the latest version of value are exposed
- * for all columns in this column family. This can be overridden for a
- * specific column by listing that column in 'columns' and
- * specifying a different setting for that column.
+ * [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
*/
onlyReadLatest?: boolean;
/**
- * [Optional] The type to convert the value in cells of this column family.
- * The values are expected to be encoded using HBase Bytes.toBytes function
- * when using the BINARY encoding value. Following BigQuery types are
- * allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default
- * type is BYTES. This can be overridden for a specific column by listing
- * that column in 'columns' and specifying a type for it.
+ * [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
*/
type?: string;
}
export interface Schema$BigtableOptions {
/**
- * [Optional] List of column families to expose in the table schema along
- * with their types. This list restricts the column families that can be
- * referenced in queries and specifies their value types. You can use this
- * list to do type conversions - see the 'type' field for more
- * details. If you leave this list empty, all column families are present in
- * the table schema and their values are read as BYTES. During a query only
- * the column families referenced in that query are read from Bigtable.
+ * [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
*/
columnFamilies?: Schema$BigtableColumnFamily[];
/**
- * [Optional] If field is true, then the column families that are not
- * specified in columnFamilies list are not exposed in the table schema.
- * Otherwise, they are read with BYTES type values. The default value is
- * false.
+ * [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
*/
ignoreUnspecifiedColumnFamilies?: boolean;
/**
- * [Optional] If field is true, then the rowkey column families will be read
- * and converted to string. Otherwise they are read with BYTES type values
- * and users need to manually cast them with CAST if necessary. The default
- * value is false.
+ * [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
*/
readRowkeyAsString?: boolean;
}
+ /**
+ * Evaluation metrics for binary classification models.
+ */
+ export interface Schema$BinaryClassificationMetrics {
+ /**
+ * Aggregate classification metrics.
+ */
+ aggregateClassificationMetrics?: Schema$AggregateClassificationMetrics;
+ /**
+ * Binary confusion matrix at multiple thresholds.
+ */
+ binaryConfusionMatrixList?: Schema$BinaryConfusionMatrix[];
+ }
+ /**
+ * Confusion matrix for binary classification models.
+ */
+ export interface Schema$BinaryConfusionMatrix {
+ /**
+ * Number of false samples predicted as false.
+ */
+ falseNegatives?: string;
+ /**
+ * Number of false samples predicted as true.
+ */
+ falsePositives?: string;
+ /**
+ * Threshold value used when computing each of the following metric.
+ */
+ positiveClassThreshold?: number;
+ /**
+ * Aggregate precision.
+ */
+ precision?: number;
+ /**
+ * Aggregate recall.
+ */
+ recall?: number;
+ /**
+ * Number of true samples predicted as false.
+ */
+ trueNegatives?: string;
+ /**
+ * Number of true samples predicted as true.
+ */
+ truePositives?: string;
+ }
export interface Schema$BqmlIterationResult {
/**
- * [Output-only, Beta] Time taken to run the training iteration in
- * milliseconds.
+ * [Output-only, Beta] Time taken to run the training iteration in milliseconds.
*/
durationMs?: string;
/**
- * [Output-only, Beta] Eval loss computed on the eval data at the end of the
- * iteration. The eval loss is used for early stopping to avoid overfitting.
- * No eval loss if eval_split_method option is specified as no_split or
- * auto_split with input data size less than 500 rows.
+ * [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.
*/
evalLoss?: number;
/**
- * [Output-only, Beta] Index of the ML training iteration, starting from
- * zero for each training run.
+ * [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.
*/
index?: number;
/**
- * [Output-only, Beta] Learning rate used for this iteration, it varies for
- * different training iterations if learn_rate_strategy option is not
- * constant.
+ * [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.
*/
learnRate?: number;
/**
- * [Output-only, Beta] Training loss computed on the training data at the
- * end of the iteration. The training loss function is defined by model
- * type.
+ * [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.
*/
trainingLoss?: number;
}
@@ -269,116 +287,118 @@ export namespace bigquery_v2 {
*/
iterationResults?: Schema$BqmlIterationResult[];
/**
- * [Output-only, Beta] Training run start time in milliseconds since the
- * epoch.
+ * [Output-only, Beta] Training run start time in milliseconds since the epoch.
*/
startTime?: string;
/**
- * [Output-only, Beta] Different state applicable for a training run. IN
- * PROGRESS: Training run is in progress. FAILED: Training run ended due to
- * a non-retryable failure. SUCCEEDED: Training run successfully completed.
- * CANCELLED: Training run cancelled by the user.
+ * [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.
*/
state?: string;
/**
- * [Output-only, Beta] Training options used by this training run. These
- * options are mutable for subsequent training runs. Default values are
- * explicitly stored for options not specified in the input query of the
- * first training run. For subsequent training runs, any option not
- * explicitly specified in the input query will be copied from the previous
- * training run.
+ * [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.
*/
trainingOptions?: {
- earlyStop?: boolean;
- l1Reg?: number;
+ minRelProgress?: number;
l2Reg?: number;
- learnRate?: number;
learnRateStrategy?: string;
+ warmStart?: boolean;
lineSearchInitLearnRate?: number;
+ earlyStop?: boolean;
+ l1Reg?: number;
maxIteration?: string;
- minRelProgress?: number;
- warmStart?: boolean;
+ learnRate?: number;
};
}
+ /**
+ * Information about a single cluster for clustering model.
+ */
+ export interface Schema$ClusterInfo {
+ /**
+ * Centroid id.
+ */
+ centroidId?: string;
+ /**
+ * Cluster radius, the average distance from centroid to each point assigned to the cluster.
+ */
+ clusterRadius?: number;
+ /**
+ * Cluster size, the total number of points assigned to the cluster.
+ */
+ clusterSize?: string;
+ }
export interface Schema$Clustering {
/**
- * [Repeated] One or more fields on which data should be clustered. Only
- * top-level, non-repeated, simple-type fields are supported. When you
- * cluster a table using multiple columns, the order of columns you specify
- * is important. The order of the specified columns determines the sort
- * order of the data.
+ * [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
*/
fields?: string[];
}
+ /**
+ * Evaluation metrics for clustering models.
+ */
+ export interface Schema$ClusteringMetrics {
+ /**
+ * Davies-Bouldin index.
+ */
+ daviesBouldinIndex?: number;
+ /**
+ * Mean of squared distances between each sample to its cluster centroid.
+ */
+ meanSquaredDistance?: number;
+ }
+ /**
+ * Confusion matrix for multi-class classification models.
+ */
+ export interface Schema$ConfusionMatrix {
+ /**
+ * Confidence threshold used when computing the entries of the confusion matrix.
+ */
+ confidenceThreshold?: number;
+ /**
+ * One row per actual label.
+ */
+ rows?: Schema$Row[];
+ }
export interface Schema$CsvOptions {
/**
- * [Optional] Indicates if BigQuery should accept rows that are missing
- * trailing optional columns. If true, BigQuery treats missing trailing
- * columns as null values. If false, records with missing trailing columns
- * are treated as bad records, and if there are too many bad records, an
- * invalid error is returned in the job result. The default value is false.
+ * [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
*/
allowJaggedRows?: boolean;
/**
- * [Optional] Indicates if BigQuery should allow quoted data sections that
- * contain newline characters in a CSV file. The default value is false.
+ * [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
*/
allowQuotedNewlines?: boolean;
/**
- * [Optional] The character encoding of the data. The supported values are
- * UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the
- * data after the raw, binary data has been split using the values of the
- * quote and fieldDelimiter properties.
+ * [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
*/
encoding?: string;
/**
- * [Optional] The separator for fields in a CSV file. BigQuery converts the
- * string to ISO-8859-1 encoding, and then uses the first byte of the
- * encoded string to split the data in its raw, binary state. BigQuery also
- * supports the escape sequence "\t" to specify a tab separator.
- * The default value is a comma (',').
+ * [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
*/
fieldDelimiter?: string;
/**
- * [Optional] The value that is used to quote data sections in a CSV file.
- * BigQuery converts the string to ISO-8859-1 encoding, and then uses the
- * first byte of the encoded string to split the data in its raw, binary
- * state. The default value is a double-quote ('"'). If your
- * data does not contain quoted sections, set the property value to an empty
- * string. If your data contains quoted newline characters, you must also
- * set the allowQuotedNewlines property to true.
+ * [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
*/
quote?: string;
/**
- * [Optional] The number of rows at the top of a CSV file that BigQuery will
- * skip when reading the data. The default value is 0. This property is
- * useful if you have header rows in the file that should be skipped.
+ * [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
*/
skipLeadingRows?: string;
}
export interface Schema$Dataset {
/**
- * [Optional] An array of objects that define dataset access for one or more
- * entities. You can set this property when inserting or updating a dataset
- * in order to control who is allowed to access the data. If unspecified at
- * dataset creation time, BigQuery adds default dataset access for the
- * following entities: access.specialGroup: projectReaders; access.role:
- * READER; access.specialGroup: projectWriters; access.role: WRITER;
- * access.specialGroup: projectOwners; access.role: OWNER;
- * access.userByEmail: [dataset creator email]; access.role: OWNER;
+ * [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
*/
access?: Array<{
domain?: string;
- groupByEmail?: string;
+ userByEmail?: string;
iamMember?: string;
- role?: string;
specialGroup?: string;
- userByEmail?: string;
+ role?: string;
view?: Schema$TableReference;
+ groupByEmail?: string;
}>;
/**
- * [Output-only] The time when this dataset was created, in milliseconds
- * since the epoch.
+ * [Output-only] The time when this dataset was created, in milliseconds since the epoch.
*/
creationTime?: string;
/**
@@ -386,32 +406,11 @@ export namespace bigquery_v2 {
*/
datasetReference?: Schema$DatasetReference;
/**
- * [Optional] The default partition expiration for all partitioned tables in
- * the dataset, in milliseconds. Once this property is set, all
- * newly-created partitioned tables in the dataset will have an expirationMs
- * property in the timePartitioning settings set to this value, and changing
- * the value will only affect new tables, not existing ones. The storage in
- * a partition will have an expiration time of its partition time plus this
- * value. Setting this property overrides the use of
- * defaultTableExpirationMs for partitioned tables: only one of
- * defaultTableExpirationMs and defaultPartitionExpirationMs will be used
- * for any new partitioned table. If you provide an explicit
- * timePartitioning.expirationMs when creating or updating a partitioned
- * table, that value takes precedence over the default partition expiration
- * time indicated by this property.
+ * [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
*/
defaultPartitionExpirationMs?: string;
/**
- * [Optional] The default lifetime of all tables in the dataset, in
- * milliseconds. The minimum value is 3600000 milliseconds (one hour). Once
- * this property is set, all newly-created tables in the dataset will have
- * an expirationTime property set to the creation time plus the value in
- * this property, and changing the value will only affect new tables, not
- * existing ones. When the expirationTime for a given table is reached, that
- * table will be deleted automatically. If a table's expirationTime is
- * modified or removed before the table expires, or if you provide an
- * explicit expirationTime when creating a table, that value takes
- * precedence over the default expiration time indicated by this property.
+ * [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
*/
defaultTableExpirationMs?: string;
/**
@@ -427,10 +426,7 @@ export namespace bigquery_v2 {
*/
friendlyName?: string;
/**
- * [Output-only] The fully-qualified unique name of the dataset in the
- * format projectId:datasetId. The dataset name without the project name is
- * given in the datasetId field. When creating a new dataset, leave this
- * field blank, and instead specify the datasetId field.
+ * [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
*/
id?: string;
/**
@@ -438,65 +434,50 @@ export namespace bigquery_v2 {
*/
kind?: string;
/**
- * The labels associated with this dataset. You can use these to organize
- * and group your datasets. You can set this property when inserting or
- * updating a dataset. See Creating and Updating Dataset Labels for more
- * information.
+ * The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
*/
labels?: {[key: string]: string};
/**
- * [Output-only] The date when this dataset or any of its tables was last
- * modified, in milliseconds since the epoch.
+ * [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
*/
lastModifiedTime?: string;
/**
- * The geographic location where the dataset should reside. The default
- * value is US. See details at
- * https://cloud.google.com/bigquery/docs/locations.
+ * The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
*/
location?: string;
/**
- * [Output-only] A URL that can be used to access the resource again. You
- * can use this URL in Get or Update requests to the resource.
+ * [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
*/
selfLink?: string;
}
export interface Schema$DatasetList {
/**
- * An array of the dataset resources in the project. Each resource contains
- * basic information. For full information about a particular dataset
- * resource, use the Datasets: get method. This property is omitted when
- * there are no datasets in the project.
+ * An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
*/
datasets?: Array<{
- datasetReference?: Schema$DatasetReference;
- friendlyName?: string;
- id?: string;
kind?: string;
labels?: {[key: string]: string};
+ datasetReference?: Schema$DatasetReference;
+ id?: string;
location?: string;
+ friendlyName?: string;
}>;
/**
- * A hash value of the results page. You can use this property to determine
- * if the page has changed since the last request.
+ * A hash value of the results page. You can use this property to determine if the page has changed since the last request.
*/
etag?: string;
/**
- * The list type. This property always returns the value
- * "bigquery#datasetList".
+ * The list type. This property always returns the value "bigquery#datasetList".
*/
kind?: string;
/**
- * A token that can be used to request the next results page. This property
- * is omitted on the final results page.
+ * A token that can be used to request the next results page. This property is omitted on the final results page.
*/
nextPageToken?: string;
}
export interface Schema$DatasetReference {
/**
- * [Required] A unique ID for this dataset, without the project name. The ID
- * must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
- * The maximum length is 1,024 characters.
+ * [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
*/
datasetId?: string;
/**
@@ -506,39 +487,40 @@ export namespace bigquery_v2 {
}
export interface Schema$DestinationTableProperties {
/**
- * [Optional] The description for the destination table. This will only be
- * used if the destination table is newly created. If the table already
- * exists and a value different than the current description is provided,
- * the job will fail.
+ * [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
*/
description?: string;
/**
- * [Optional] The friendly name for the destination table. This will only be
- * used if the destination table is newly created. If the table already
- * exists and a value different than the current friendly name is provided,
- * the job will fail.
+ * [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
*/
friendlyName?: string;
/**
- * [Optional] The labels associated with this table. You can use these to
- * organize and group your tables. This will only be used if the destination
- * table is newly created. If the table already exists and labels are
- * different than the current labels are provided, the job will fail.
+ * [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
*/
labels?: {[key: string]: string};
}
export interface Schema$EncryptionConfiguration {
/**
- * [Optional] Describes the Cloud KMS encryption key that will be used to
- * protect destination BigQuery table. The BigQuery Service Account
- * associated with your project requires access to this encryption key.
+ * [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
*/
kmsKeyName?: string;
}
+ /**
+ * A single entry in the confusion matrix.
+ */
+ export interface Schema$Entry {
+ /**
+ * Number of items being predicted as this label.
+ */
+ itemCount?: string;
+ /**
+ * The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
+ */
+ predictedLabel?: string;
+ }
export interface Schema$ErrorProto {
/**
- * Debugging information. This property is internal to Google and should not
- * be used.
+ * Debugging information. This property is internal to Google and should not be used.
*/
debugInfo?: string;
/**
@@ -554,6 +536,27 @@ export namespace bigquery_v2 {
*/
reason?: string;
}
+ /**
+ * Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training.
+ */
+ export interface Schema$EvaluationMetrics {
+ /**
+ * Populated for binary classification models.
+ */
+ binaryClassificationMetrics?: Schema$BinaryClassificationMetrics;
+ /**
+ * [Beta] Populated for clustering models.
+ */
+ clusteringMetrics?: Schema$ClusteringMetrics;
+ /**
+ * Populated for multi-class classification models.
+ */
+ multiClassClassificationMetrics?: Schema$MultiClassClassificationMetrics;
+ /**
+ * Populated for regression models.
+ */
+ regressionMetrics?: Schema$RegressionMetrics;
+ }
export interface Schema$ExplainQueryStage {
/**
* Number of parallel input segments completed.
@@ -636,8 +639,7 @@ export namespace bigquery_v2 {
*/
status?: string;
/**
- * List of operations within the stage in dependency order (approximately
- * chronological).
+ * List of operations within the stage in dependency order (approximately chronological).
*/
steps?: Schema$ExplainQueryStep[];
/**
@@ -685,8 +687,7 @@ export namespace bigquery_v2 {
}
export interface Schema$ExternalDataConfiguration {
/**
- * Try to detect schema and format options automatically. Any option
- * specified explicitly will be honored.
+ * Try to detect schema and format options automatically. Any option specified explicitly will be honored.
*/
autodetect?: boolean;
/**
@@ -694,10 +695,7 @@ export namespace bigquery_v2 {
*/
bigtableOptions?: Schema$BigtableOptions;
/**
- * [Optional] The compression type of the data source. Possible values
- * include GZIP and NONE. The default value is NONE. This setting is ignored
- * for Google Cloud Bigtable, Google Cloud Datastore backups and Avro
- * formats.
+ * [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
*/
compression?: string;
/**
@@ -709,60 +707,27 @@ export namespace bigquery_v2 {
*/
googleSheetsOptions?: Schema$GoogleSheetsOptions;
/**
- * [Optional, Experimental] If hive partitioning is enabled, which mode to
- * use. Two modes are supported: - AUTO: automatically infer partition key
- * name(s) and type(s). - STRINGS: automatic infer partition key name(s).
- * All types are strings. Not all storage formats support hive partitioning
- * -- requesting hive partitioning on an unsupported format will lead to an
- * error.
+ * [Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error.
*/
hivePartitioningMode?: string;
/**
- * [Optional] Indicates if BigQuery should allow extra values that are not
- * represented in the table schema. If true, the extra values are ignored.
- * If false, records with extra columns are treated as bad records, and if
- * there are too many bad records, an invalid error is returned in the job
- * result. The default value is false. The sourceFormat property determines
- * what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named
- * values that don't match any column names Google Cloud Bigtable: This
- * setting is ignored. Google Cloud Datastore backups: This setting is
- * ignored. Avro: This setting is ignored.
+ * [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
*/
ignoreUnknownValues?: boolean;
/**
- * [Optional] The maximum number of bad records that BigQuery can ignore
- * when reading data. If the number of bad records exceeds this value, an
- * invalid error is returned in the job result. This is only valid for CSV,
- * JSON, and Google Sheets. The default value is 0, which requires that all
- * records are valid. This setting is ignored for Google Cloud Bigtable,
- * Google Cloud Datastore backups and Avro formats.
+ * [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
*/
maxBadRecords?: number;
/**
- * [Optional] The schema for the data. Schema is required for CSV and JSON
- * formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore
- * backups, and Avro formats.
+ * [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
*/
schema?: Schema$TableSchema;
/**
- * [Required] The data format. For CSV files, specify "CSV". For
- * Google sheets, specify "GOOGLE_SHEETS". For newline-delimited
- * JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify
- * "AVRO". For Google Cloud Datastore backups, specify
- * "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify
- * "BIGTABLE".
+ * [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
*/
sourceFormat?: string;
/**
- * [Required] The fully-qualified URIs that point to your data in Google
- * Cloud. For Google Cloud Storage URIs: Each URI can contain one
- * '*' wildcard character and it must come after the
- * 'bucket' name. Size limits related to load jobs apply to external
- * data sources. For Google Cloud Bigtable URIs: Exactly one URI can be
- * specified and it has be a fully specified and valid HTTPS URL for a
- * Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly
- * one URI can be specified. Also, the '*' wildcard character is not
- * allowed.
+ * [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
*/
sourceUris?: string[];
}
@@ -772,10 +737,7 @@ export namespace bigquery_v2 {
*/
cacheHit?: boolean;
/**
- * [Output-only] The first errors or warnings encountered during the running
- * of the job. The final message includes the number of errors that caused
- * the process to stop. Errors here do not necessarily mean that the job has
- * completed or was unsuccessful.
+ * [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
*/
errors?: Schema$ErrorProto[];
/**
@@ -783,17 +745,11 @@ export namespace bigquery_v2 {
*/
etag?: string;
/**
- * Whether the query has completed or not. If rows or totalRows are present,
- * this will always be true. If this is false, totalRows will not be
- * available.
+ * Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
*/
jobComplete?: boolean;
/**
- * Reference to the BigQuery Job that was created to run the query. This
- * field will be present even if the original request timed out, in which
- * case GetQueryResults can be used to read the results once the query has
- * completed. Since this API only returns the first page of results,
- * subsequent pages can be fetched via the same mechanism (GetQueryResults).
+ * Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
*/
jobReference?: Schema$JobReference;
/**
@@ -801,8 +757,7 @@ export namespace bigquery_v2 {
*/
kind?: string;
/**
- * [Output-only] The number of rows affected by a DML statement. Present
- * only for DML statements INSERT, UPDATE or DELETE.
+ * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
*/
numDmlAffectedRows?: string;
/**
@@ -810,15 +765,11 @@ export namespace bigquery_v2 {
*/
pageToken?: string;
/**
- * An object with as many results as can be contained within the maximum
- * permitted reply size. To get any additional rows, you can call
- * GetQueryResults and specify the jobReference returned above. Present only
- * when the query completes successfully.
+ * An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
*/
rows?: Schema$TableRow[];
/**
- * The schema of the results. Present only when the query completes
- * successfully.
+ * The schema of the results. Present only when the query completes successfully.
*/
schema?: Schema$TableSchema;
/**
@@ -826,9 +777,7 @@ export namespace bigquery_v2 {
*/
totalBytesProcessed?: string;
/**
- * The total number of rows in the complete query result set, which can be
- * more than the number of rows in this single page of results. Present only
- * when the query completes successfully.
+ * The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
*/
totalRows?: string;
}
@@ -844,27 +793,43 @@ export namespace bigquery_v2 {
}
export interface Schema$GoogleSheetsOptions {
/**
- * [Beta] [Optional] Range of a sheet to query from. Only used when
- * non-empty. Typical format:
- * sheet_name!top_left_cell_id:bottom_right_cell_id For example:
- * sheet1!A1:B20
+ * [Beta] [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
*/
range?: string;
/**
- * [Optional] The number of rows at the top of a sheet that BigQuery will
- * skip when reading the data. The default value is 0. This property is
- * useful if you have header rows that should be skipped. When autodetect is
- * on, behavior is the following: * skipLeadingRows unspecified - Autodetect
- * tries to detect headers in the first row. If they are not detected, the
- * row is read as data. Otherwise data is read starting from the second row.
- * * skipLeadingRows is 0 - Instructs autodetect that there are no headers
- * and data should be read starting from the first row. * skipLeadingRows =
- * N > 0 - Autodetect skips N-1 rows and tries to detect headers in row
- * N. If headers are not detected, row N is just skipped. Otherwise row N is
- * used to extract column names for the detected schema.
+ * [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
*/
skipLeadingRows?: string;
}
+ /**
+ * Information about a single iteration of the training run.
+ */
+ export interface Schema$IterationResult {
+ /**
+ * [Beta] Information about top clusters for clustering models.
+ */
+ clusterInfos?: Schema$ClusterInfo[];
+ /**
+ * Time taken to run the iteration in milliseconds.
+ */
+ durationMs?: string;
+ /**
+ * Loss computed on the eval data at the end of iteration.
+ */
+ evalLoss?: number;
+ /**
+ * Index of the iteration, 0 based.
+ */
+ index?: number;
+ /**
+ * Learn rate used for this iteration.
+ */
+ learnRate?: number;
+ /**
+ * Loss computed on the training data at the end of iteration.
+ */
+ trainingLoss?: number;
+ }
export interface Schema$Job {
/**
* [Required] Describes the job configuration.
@@ -891,13 +856,11 @@ export namespace bigquery_v2 {
*/
selfLink?: string;
/**
- * [Output-only] Information about the job, including starting time and
- * ending time of the job.
+ * [Output-only] Information about the job, including starting time and ending time of the job.
*/
statistics?: Schema$JobStatistics;
/**
- * [Output-only] The status of this job. Examine this value when polling an
- * asynchronous job to see if the job is complete.
+ * [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
*/
status?: Schema$JobStatus;
/**
@@ -921,10 +884,7 @@ export namespace bigquery_v2 {
*/
copy?: Schema$JobConfigurationTableCopy;
/**
- * [Optional] If set, don't actually run this job. A valid query will
- * return a mostly empty response with some processing statistics, while an
- * invalid query will return the same error it would if it wasn't a dry
- * run. Behavior of non-query jobs is undefined.
+ * [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
*/
dryRun?: boolean;
/**
@@ -932,22 +892,15 @@ export namespace bigquery_v2 {
*/
extract?: Schema$JobConfigurationExtract;
/**
- * [Optional] Job timeout in milliseconds. If this time limit is exceeded,
- * BigQuery may attempt to terminate the job.
+ * [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
*/
jobTimeoutMs?: string;
/**
- * [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or
- * UNKNOWN.
+ * [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
*/
jobType?: string;
/**
- * The labels associated with this job. You can use these to organize and
- * group your jobs. Label keys and values can be no longer than 63
- * characters, can only contain lowercase letters, numeric characters,
- * underscores and dashes. International characters are allowed. Label
- * values are optional. Label keys must start with a letter and each label
- * in the list must have a different key.
+ * The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
*/
labels?: {[key: string]: string};
/**
@@ -961,36 +914,27 @@ export namespace bigquery_v2 {
}
export interface Schema$JobConfigurationExtract {
/**
- * [Optional] The compression type to use for exported files. Possible
- * values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is
- * NONE. DEFLATE and SNAPPY are only supported for Avro.
+ * [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro.
*/
compression?: string;
/**
- * [Optional] The exported file format. Possible values include CSV,
- * NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with
- * nested or repeated fields cannot be exported as CSV.
+ * [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
*/
destinationFormat?: string;
/**
- * [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI
- * as necessary. The fully-qualified Google Cloud Storage URI where the
- * extracted table should be written.
+ * [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
*/
destinationUri?: string;
/**
- * [Pick one] A list of fully-qualified Google Cloud Storage URIs where the
- * extracted table should be written.
+ * [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
*/
destinationUris?: string[];
/**
- * [Optional] Delimiter to use between fields in the exported data. Default
- * is ','
+ * [Optional] Delimiter to use between fields in the exported data. Default is ','
*/
fieldDelimiter?: string;
/**
- * [Optional] Whether to print out a header row in the results. Default is
- * true.
+ * [Optional] Whether to print out a header row in the results. Default is true.
*/
printHeader?: boolean;
/**
@@ -1000,36 +944,23 @@ export namespace bigquery_v2 {
}
export interface Schema$JobConfigurationLoad {
/**
- * [Optional] Accept rows that are missing trailing optional columns. The
- * missing values are treated as nulls. If false, records with missing
- * trailing columns are treated as bad records, and if there are too many
- * bad records, an invalid error is returned in the job result. The default
- * value is false. Only applicable to CSV, ignored for other formats.
+ * [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
*/
allowJaggedRows?: boolean;
/**
- * Indicates if BigQuery should allow quoted data sections that contain
- * newline characters in a CSV file. The default value is false.
+ * Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
*/
allowQuotedNewlines?: boolean;
/**
- * [Optional] Indicates if we should automatically infer the options and
- * schema for CSV and JSON sources.
+ * [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
*/
autodetect?: boolean;
/**
- * [Beta] Clustering specification for the destination table. Must be
- * specified with time-based partitioning, data in the table will be first
- * partitioned and subsequently clustered.
+ * [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
*/
clustering?: Schema$Clustering;
/**
- * [Optional] Specifies whether the job is allowed to create new tables. The
- * following values are supported: CREATE_IF_NEEDED: If the table does not
- * exist, BigQuery creates the table. CREATE_NEVER: The table must already
- * exist. If it does not, a 'notFound' error is returned in the job
- * result. The default value is CREATE_IF_NEEDED. Creation, truncation and
- * append actions occur as one atomic update upon job completion.
+ * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
createDisposition?: string;
/**
@@ -1041,98 +972,51 @@ export namespace bigquery_v2 {
*/
destinationTable?: Schema$TableReference;
/**
- * [Beta] [Optional] Properties with which to create the destination table
- * if it is new.
+ * [Beta] [Optional] Properties with which to create the destination table if it is new.
*/
destinationTableProperties?: Schema$DestinationTableProperties;
/**
- * [Optional] The character encoding of the data. The supported values are
- * UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the
- * data after the raw, binary data has been split using the values of the
- * quote and fieldDelimiter properties.
+ * [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
*/
encoding?: string;
/**
- * [Optional] The separator for fields in a CSV file. The separator can be
- * any ISO-8859-1 single-byte character. To use a character in the range
- * 128-255, you must encode the character as UTF8. BigQuery converts the
- * string to ISO-8859-1 encoding, and then uses the first byte of the
- * encoded string to split the data in its raw, binary state. BigQuery also
- * supports the escape sequence "\t" to specify a tab separator.
- * The default value is a comma (',').
+ * [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
*/
fieldDelimiter?: string;
/**
- * [Optional, Experimental] If hive partitioning is enabled, which mode to
- * use. Two modes are supported: - AUTO: automatically infer partition key
- * name(s) and type(s). - STRINGS: automatic infer partition key name(s).
- * All types are strings. Not all storage formats support hive partitioning
- * -- requesting hive partitioning on an unsupported format will lead to an
- * error.
+ * [Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error.
*/
hivePartitioningMode?: string;
/**
- * [Optional] Indicates if BigQuery should allow extra values that are not
- * represented in the table schema. If true, the extra values are ignored.
- * If false, records with extra columns are treated as bad records, and if
- * there are too many bad records, an invalid error is returned in the job
- * result. The default value is false. The sourceFormat property determines
- * what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named
- * values that don't match any column names
+ * [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
*/
ignoreUnknownValues?: boolean;
/**
- * [Optional] The maximum number of bad records that BigQuery can ignore
- * when running the job. If the number of bad records exceeds this value, an
- * invalid error is returned in the job result. This is only valid for CSV
- * and JSON. The default value is 0, which requires that all records are
- * valid.
+ * [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
*/
maxBadRecords?: number;
/**
- * [Optional] Specifies a string that represents a null value in a CSV file.
- * For example, if you specify "x/", BigQuery interprets
- * "x/" as a null value when loading a CSV file. The default value
- * is the empty string. If you set this property to a custom value, BigQuery
- * throws an error if an empty string is present for all data types except
- * for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the
- * empty string as an empty value.
+ * [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "x/", BigQuery interprets "x/" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
*/
nullMarker?: string;
/**
- * If sourceFormat is set to "DATASTORE_BACKUP", indicates which
- * entity properties to load into BigQuery from a Cloud Datastore backup.
- * Property names are case sensitive and must be top-level properties. If no
- * properties are specified, BigQuery loads all properties. If any named
- * property isn't found in the Cloud Datastore backup, an invalid error
- * is returned in the job result.
+ * If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
*/
projectionFields?: string[];
/**
- * [Optional] The value that is used to quote data sections in a CSV file.
- * BigQuery converts the string to ISO-8859-1 encoding, and then uses the
- * first byte of the encoded string to split the data in its raw, binary
- * state. The default value is a double-quote ('"'). If your
- * data does not contain quoted sections, set the property value to an empty
- * string. If your data contains quoted newline characters, you must also
- * set the allowQuotedNewlines property to true.
+ * [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
*/
quote?: string;
/**
- * [TrustedTester] Range partitioning specification for this table. Only one
- * of timePartitioning and rangePartitioning should be specified.
+ * [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
*/
rangePartitioning?: Schema$RangePartitioning;
/**
- * [Optional] The schema for the destination table. The schema can be
- * omitted if the destination table already exists, or if you're loading
- * data from Google Cloud Datastore.
+ * [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
*/
schema?: Schema$TableSchema;
/**
- * [Deprecated] The inline schema. For CSV schemas, specify as
- * "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING,
- * bar:INTEGER, baz:FLOAT".
+ * [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
*/
schemaInline?: string;
/**
@@ -1140,98 +1024,49 @@ export namespace bigquery_v2 {
*/
schemaInlineFormat?: string;
/**
- * Allows the schema of the destination table to be updated as a side effect
- * of the load job if a schema is autodetected or supplied in the job
- * configuration. Schema update options are supported in two cases: when
- * writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE
- * and the destination table is a partition of a table, specified by
- * partition decorators. For normal tables, WRITE_TRUNCATE will always
- * overwrite the schema. One or more of the following values are specified:
- * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema.
- * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original
- * schema to nullable.
+ * Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
*/
schemaUpdateOptions?: string[];
/**
- * [Optional] The number of rows at the top of a CSV file that BigQuery will
- * skip when loading the data. The default value is 0. This property is
- * useful if you have header rows in the file that should be skipped.
+ * [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
*/
skipLeadingRows?: number;
/**
- * [Optional] The format of the data files. For CSV files, specify
- * "CSV". For datastore backups, specify
- * "DATASTORE_BACKUP". For newline-delimited JSON, specify
- * "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO".
- * For parquet, specify "PARQUET". For orc, specify
- * "ORC". The default value is CSV.
+ * [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
*/
sourceFormat?: string;
/**
- * [Required] The fully-qualified URIs that point to your data in Google
- * Cloud. For Google Cloud Storage URIs: Each URI can contain one
- * '*' wildcard character and it must come after the
- * 'bucket' name. Size limits related to load jobs apply to external
- * data sources. For Google Cloud Bigtable URIs: Exactly one URI can be
- * specified and it has be a fully specified and valid HTTPS URL for a
- * Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly
- * one URI can be specified. Also, the '*' wildcard character is not
- * allowed.
+ * [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
*/
sourceUris?: string[];
/**
- * Time-based partitioning specification for the destination table. Only one
- * of timePartitioning and rangePartitioning should be specified.
+ * Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
*/
timePartitioning?: Schema$TimePartitioning;
/**
- * [Optional] If sourceFormat is set to "AVRO", indicates whether
- * to enable interpreting logical types into their corresponding types (ie.
- * TIMESTAMP), instead of only using their raw types (ie. INTEGER).
+ * [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
*/
useAvroLogicalTypes?: boolean;
/**
- * [Optional] Specifies the action that occurs if the destination table
- * already exists. The following values are supported: WRITE_TRUNCATE: If
- * the table already exists, BigQuery overwrites the table data.
- * WRITE_APPEND: If the table already exists, BigQuery appends the data to
- * the table. WRITE_EMPTY: If the table already exists and contains data, a
- * 'duplicate' error is returned in the job result. The default
- * value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery
- * is able to complete the job successfully. Creation, truncation and append
- * actions occur as one atomic update upon job completion.
+ * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
writeDisposition?: string;
}
export interface Schema$JobConfigurationQuery {
/**
- * [Optional] If true and query uses legacy SQL dialect, allows the query to
- * produce arbitrarily large result tables at a slight cost in performance.
- * Requires destinationTable to be set. For standard SQL queries, this flag
- * is ignored and large results are always allowed. However, you must still
- * set destinationTable when result size exceeds the allowed maximum
- * response size.
+ * [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
*/
allowLargeResults?: boolean;
/**
- * [Beta] Clustering specification for the destination table. Must be
- * specified with time-based partitioning, data in the table will be first
- * partitioned and subsequently clustered.
+ * [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
*/
clustering?: Schema$Clustering;
/**
- * [Optional] Specifies whether the job is allowed to create new tables. The
- * following values are supported: CREATE_IF_NEEDED: If the table does not
- * exist, BigQuery creates the table. CREATE_NEVER: The table must already
- * exist. If it does not, a 'notFound' error is returned in the job
- * result. The default value is CREATE_IF_NEEDED. Creation, truncation and
- * append actions occur as one atomic update upon job completion.
+ * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
createDisposition?: string;
/**
- * [Optional] Specifies the default dataset to use for unqualified table
- * names in the query. Note that this does not alter behavior of unqualified
- * dataset names.
+ * [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
*/
defaultDataset?: Schema$DatasetReference;
/**
@@ -1239,35 +1074,23 @@ export namespace bigquery_v2 {
*/
destinationEncryptionConfiguration?: Schema$EncryptionConfiguration;
/**
- * [Optional] Describes the table where the query results should be stored.
- * If not present, a new table will be created to store the results. This
- * property must be set for large results that exceed the maximum response
- * size.
+ * [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
*/
destinationTable?: Schema$TableReference;
/**
- * [Optional] If true and query uses legacy SQL dialect, flattens all nested
- * and repeated fields in the query results. allowLargeResults must be true
- * if this is set to false. For standard SQL queries, this flag is ignored
- * and results are never flattened.
+ * [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
*/
flattenResults?: boolean;
/**
- * [Optional] Limits the billing tier for this job. Queries that have
- * resource usage beyond this tier will fail (without incurring a charge).
- * If unspecified, this will be set to your project default.
+ * [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
*/
maximumBillingTier?: number;
/**
- * [Optional] Limits the bytes billed for this job. Queries that will have
- * bytes billed beyond this limit will fail (without incurring a charge). If
- * unspecified, this will be set to your project default.
+ * [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
*/
maximumBytesBilled?: string;
/**
- * Standard SQL only. Set to POSITIONAL to use positional (?) query
- * parameters or to NAMED to use named (@myparam) query parameters in this
- * query.
+ * Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
*/
parameterMode?: string;
/**
@@ -1275,13 +1098,11 @@ export namespace bigquery_v2 {
*/
preserveNulls?: boolean;
/**
- * [Optional] Specifies a priority for the query. Possible values include
- * INTERACTIVE and BATCH. The default value is INTERACTIVE.
+ * [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
*/
priority?: string;
/**
- * [Required] SQL query text to execute. The useLegacySql field can be used
- * to indicate whether the query uses legacy SQL or standard SQL.
+ * [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
*/
query?: string;
/**
@@ -1289,49 +1110,27 @@ export namespace bigquery_v2 {
*/
queryParameters?: Schema$QueryParameter[];
/**
- * [TrustedTester] Range partitioning specification for this table. Only one
- * of timePartitioning and rangePartitioning should be specified.
+ * [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
*/
rangePartitioning?: Schema$RangePartitioning;
/**
- * Allows the schema of the destination table to be updated as a side effect
- * of the query job. Schema update options are supported in two cases: when
- * writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE
- * and the destination table is a partition of a table, specified by
- * partition decorators. For normal tables, WRITE_TRUNCATE will always
- * overwrite the schema. One or more of the following values are specified:
- * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema.
- * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original
- * schema to nullable.
+ * Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
*/
schemaUpdateOptions?: string[];
/**
- * [Optional] If querying an external data source outside of BigQuery,
- * describes the data format, location and other properties of the data
- * source. By defining these properties, the data source can then be queried
- * as if it were a standard BigQuery table.
+ * [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
*/
tableDefinitions?: {[key: string]: Schema$ExternalDataConfiguration};
/**
- * Time-based partitioning specification for the destination table. Only one
- * of timePartitioning and rangePartitioning should be specified.
+ * Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
*/
timePartitioning?: Schema$TimePartitioning;
/**
- * Specifies whether to use BigQuery's legacy SQL dialect for this
- * query. The default value is true. If set to false, the query will use
- * BigQuery's standard SQL:
- * https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set
- * to false, the value of flattenResults is ignored; query will be run as if
- * flattenResults is false.
+ * Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
*/
useLegacySql?: boolean;
/**
- * [Optional] Whether to look for the result in the query cache. The query
- * cache is a best-effort cache that will be flushed whenever tables in the
- * query are modified. Moreover, the query cache is only available when a
- * query does not have a destination table specified. The default value is
- * true.
+ * [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
*/
useQueryCache?: boolean;
/**
@@ -1339,27 +1138,13 @@ export namespace bigquery_v2 {
*/
userDefinedFunctionResources?: Schema$UserDefinedFunctionResource[];
/**
- * [Optional] Specifies the action that occurs if the destination table
- * already exists. The following values are supported: WRITE_TRUNCATE: If
- * the table already exists, BigQuery overwrites the table data and uses the
- * schema from the query result. WRITE_APPEND: If the table already exists,
- * BigQuery appends the data to the table. WRITE_EMPTY: If the table already
- * exists and contains data, a 'duplicate' error is returned in the
- * job result. The default value is WRITE_EMPTY. Each action is atomic and
- * only occurs if BigQuery is able to complete the job successfully.
- * Creation, truncation and append actions occur as one atomic update upon
- * job completion.
+ * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
writeDisposition?: string;
}
export interface Schema$JobConfigurationTableCopy {
/**
- * [Optional] Specifies whether the job is allowed to create new tables. The
- * following values are supported: CREATE_IF_NEEDED: If the table does not
- * exist, BigQuery creates the table. CREATE_NEVER: The table must already
- * exist. If it does not, a 'notFound' error is returned in the job
- * result. The default value is CREATE_IF_NEEDED. Creation, truncation and
- * append actions occur as one atomic update upon job completion.
+ * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
createDisposition?: string;
/**
@@ -1379,15 +1164,7 @@ export namespace bigquery_v2 {
*/
sourceTables?: Schema$TableReference[];
/**
- * [Optional] Specifies the action that occurs if the destination table
- * already exists. The following values are supported: WRITE_TRUNCATE: If
- * the table already exists, BigQuery overwrites the table data.
- * WRITE_APPEND: If the table already exists, BigQuery appends the data to
- * the table. WRITE_EMPTY: If the table already exists and contains data, a
- * 'duplicate' error is returned in the job result. The default
- * value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery
- * is able to complete the job successfully. Creation, truncation and append
- * actions occur as one atomic update upon job completion.
+ * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
*/
writeDisposition?: string;
}
@@ -1400,15 +1177,15 @@ export namespace bigquery_v2 {
* List of jobs that were requested.
*/
jobs?: Array<{
- configuration?: Schema$JobConfiguration;
+ user_email?: string;
errorResult?: Schema$ErrorProto;
- id?: string;
- jobReference?: Schema$JobReference;
kind?: string;
+ jobReference?: Schema$JobReference;
+ status?: Schema$JobStatus;
state?: string;
statistics?: Schema$JobStatistics;
- status?: Schema$JobStatus;
- user_email?: string;
+ id?: string;
+ configuration?: Schema$JobConfiguration;
}>;
/**
* The resource type of the response.
@@ -1421,14 +1198,11 @@ export namespace bigquery_v2 {
}
export interface Schema$JobReference {
/**
- * [Required] The ID of the job. The ID must contain only letters (a-z,
- * A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length
- * is 1,024 characters.
+ * [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
*/
jobId?: string;
/**
- * The geographic location of the job. See details at
- * https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
+ * The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string;
/**
@@ -1438,18 +1212,15 @@ export namespace bigquery_v2 {
}
export interface Schema$JobStatistics {
/**
- * [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and
- * EXTRACT jobs.
+ * [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
*/
completionRatio?: number;
/**
- * [Output-only] Creation time of this job, in milliseconds since the epoch.
- * This field will be present on all jobs.
+ * [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
*/
creationTime?: string;
/**
- * [Output-only] End time of this job, in milliseconds since the epoch. This
- * field will be present whenever a job is in the DONE state.
+ * [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
*/
endTime?: string;
/**
@@ -1479,16 +1250,13 @@ export namespace bigquery_v2 {
/**
* [Output-only] Job resource usage breakdown by reservation.
*/
- reservationUsage?: Array<{name?: string; slotMs?: string}>;
+ reservationUsage?: Array<{slotMs?: string; name?: string}>;
/**
- * [Output-only] Start time of this job, in milliseconds since the epoch.
- * This field will be present when the job transitions from the PENDING
- * state to either RUNNING or DONE.
+ * [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
*/
startTime?: string;
/**
- * [Output-only] [Deprecated] Use the bytes processed in the query
- * statistics instead.
+ * [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
*/
totalBytesProcessed?: string;
/**
@@ -1506,20 +1274,11 @@ export namespace bigquery_v2 {
*/
cacheHit?: boolean;
/**
- * The DDL operation performed, possibly dependent on the pre-existence of
- * the DDL target. Possible values (new values might be added in the
- * future): "CREATE": The query created the DDL target.
- * "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT
- * EXISTS while the table already exists, or the query is DROP TABLE IF
- * EXISTS while the table does not exist. "REPLACE": The query
- * replaced the DDL target. Example case: the query is CREATE OR REPLACE
- * TABLE, and the table already exists. "DROP": The query deleted
- * the DDL target.
+ * The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
*/
ddlOperationPerformed?: string;
/**
- * The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE
- * queries.
+ * The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
*/
ddlTargetRoutine?: Schema$RoutineReference;
/**
@@ -1543,8 +1302,7 @@ export namespace bigquery_v2 {
*/
modelTrainingExpectedTotalIteration?: string;
/**
- * [Output-only] The number of rows affected by a DML statement. Present
- * only for DML statements INSERT, UPDATE or DELETE.
+ * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
*/
numDmlAffectedRows?: string;
/**
@@ -1552,8 +1310,7 @@ export namespace bigquery_v2 {
*/
queryPlan?: Schema$ExplainQueryStage[];
/**
- * [Output-only] Referenced tables for the job. Queries that reference more
- * than 50 tables will not have a complete list.
+ * [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
*/
referencedTables?: Schema$TableReference[];
/**
@@ -1561,29 +1318,11 @@ export namespace bigquery_v2 {
*/
reservationUsage?: Array<{name?: string; slotMs?: string}>;
/**
- * [Output-only] The schema of the results. Present only for successful dry
- * run of non-legacy SQL queries.
+ * [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
*/
schema?: Schema$TableSchema;
/**
- * The type of query statement, if valid. Possible values (new values might
- * be added in the future): "SELECT": SELECT query.
- * "INSERT": INSERT query; see
- * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language.
- * "UPDATE": UPDATE query; see
- * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language.
- * "DELETE": DELETE query; see
- * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language.
- * "MERGE": MERGE query; see
- * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language.
- * "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT.
- * "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS
- * SELECT ... . "DROP_TABLE": DROP TABLE query.
- * "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... .
- * "DROP_VIEW": DROP VIEW query. "CREATE_FUNCTION":
- * CREATE FUNCTION query. "DROP_FUNCTION" : DROP FUNCTION query.
- * "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER
- * VIEW query.
+ * The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
*/
statementType?: string;
/**
@@ -1599,16 +1338,11 @@ export namespace bigquery_v2 {
*/
totalBytesProcessed?: string;
/**
- * [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and
- * this field specifies the accuracy of the estimate. Possible values can
- * be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is
- * precise. LOWER_BOUND: estimate is lower bound of what the query would
- * cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
+ * [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
*/
totalBytesProcessedAccuracy?: string;
/**
- * [Output-only] Total number of partitions processed from all partitioned
- * tables referenced in the job.
+ * [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.
*/
totalPartitionsProcessed?: string;
/**
@@ -1616,17 +1350,13 @@ export namespace bigquery_v2 {
*/
totalSlotMs?: string;
/**
- * Standard SQL only: list of undeclared query parameters detected during a
- * dry run validation.
+ * Standard SQL only: list of undeclared query parameters detected during a dry run validation.
*/
undeclaredQueryParameters?: Schema$QueryParameter[];
}
export interface Schema$JobStatistics3 {
/**
- * [Output-only] The number of bad records encountered. Note that if the job
- * has failed because of more bad records encountered than the maximum
- * allowed in the load job configuration, then this number can be less than
- * the total number of bad records present in the input data.
+ * [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
*/
badRecords?: string;
/**
@@ -1638,40 +1368,31 @@ export namespace bigquery_v2 {
*/
inputFiles?: string;
/**
- * [Output-only] Size of the loaded data in bytes. Note that while a load
- * job is in the running state, this value may change.
+ * [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
*/
outputBytes?: string;
/**
- * [Output-only] Number of rows imported in a load job. Note that while an
- * import job is in the running state, this value may change.
+ * [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
*/
outputRows?: string;
}
export interface Schema$JobStatistics4 {
/**
- * [Output-only] Number of files per destination URI or URI pattern
- * specified in the extract configuration. These values will be in the same
- * order as the URIs specified in the 'destinationUris' field.
+ * [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
*/
destinationUriFileCounts?: string[];
/**
- * [Output-only] Number of user bytes extracted into the result. This is the
- * byte count as computed by BigQuery for billing purposes.
+ * [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
*/
inputBytes?: string;
}
export interface Schema$JobStatus {
/**
- * [Output-only] Final error result of the job. If present, indicates that
- * the job has completed and was unsuccessful.
+ * [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
*/
errorResult?: Schema$ErrorProto;
/**
- * [Output-only] The first errors encountered during the running of the job.
- * The final message includes the number of errors that caused the process
- * to stop. Errors here do not necessarily mean that the job has completed
- * or was unsuccessful.
+ * [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
*/
errors?: Schema$ErrorProto[];
/**
@@ -1684,10 +1405,28 @@ export namespace bigquery_v2 {
*/
export interface Schema$JsonObject {}
export interface Schema$JsonValue {}
+ export interface Schema$ListModelsResponse {
+ /**
+ * Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.
+ */
+ models?: Schema$Model[];
+ /**
+ * A token to request the next page of results.
+ */
+ nextPageToken?: string;
+ }
+ /**
+ * BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.
+ */
+ export interface Schema$LocationMetadata {
+ /**
+ * The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations.
+ */
+ legacyLocationId?: string;
+ }
export interface Schema$MaterializedViewDefinition {
/**
- * [Output-only] [TrustedTester] The time when this materialized view was
- * last modified, in milliseconds since the epoch.
+ * [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
*/
lastRefreshTime?: string;
/**
@@ -1695,21 +1434,100 @@ export namespace bigquery_v2 {
*/
query?: string;
}
+ export interface Schema$Model {
+ /**
+ * Output only. The time when this model was created, in millisecs since the epoch.
+ */
+ creationTime?: string;
+ /**
+ * [Optional] A user-friendly description of this model. @mutable bigquery.models.patch
+ */
+ description?: string;
+ /**
+ * Output only. A hash of this resource.
+ */
+ etag?: string;
+ /**
+ * [Optional] The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. @mutable bigquery.models.patch
+ */
+ expirationTime?: string;
+ /**
+ * Output only. Input feature columns that were used to train this model.
+ */
+ featureColumns?: Schema$StandardSqlField[];
+ /**
+ * [Optional] A descriptive name for this model. @mutable bigquery.models.patch
+ */
+ friendlyName?: string;
+ /**
+ * Output only. Label columns that were used to train this model. The output of the model will have a “predicted_” prefix to these columns.
+ */
+ labelColumns?: Schema$StandardSqlField[];
+ /**
+ * [Optional] The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. @mutable bigquery.models.patch
+ */
+ labels?: {[key: string]: string};
+ /**
+ * Output only. The time when this model was last modified, in millisecs since the epoch.
+ */
+ lastModifiedTime?: string;
+ /**
+ * Output only. The geographic location where the model resides. This value is inherited from the dataset.
+ */
+ location?: string;
+ /**
+ * Required. Unique identifier for this model.
+ */
+ modelReference?: Schema$ModelReference;
+ /**
+ * Output only. Type of the model resource.
+ */
+ modelType?: string;
+ /**
+ * Output only. Information for all training runs in increasing order of start_time.
+ */
+ trainingRuns?: Schema$TrainingRun[];
+ }
export interface Schema$ModelDefinition {
/**
- * [Output-only, Beta] Model options used for the first training run. These
- * options are immutable for subsequent training runs. Default values are
- * used for any options not specified in the input query.
+ * [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.
*/
- modelOptions?: {labels?: string[]; lossType?: string; modelType?: string};
+ modelOptions?: {lossType?: string; modelType?: string; labels?: string[]};
/**
- * [Output-only, Beta] Information about ml training runs, each training run
- * comprises of multiple iterations and there may be multiple training runs
- * for the model if warm start is used or if a user decides to continue a
- * previously cancelled query.
+ * [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.
*/
trainingRuns?: Schema$BqmlTrainingRun[];
}
+ /**
+ * Id path of a model.
+ */
+ export interface Schema$ModelReference {
+ /**
+ * [Required] The ID of the dataset containing this model.
+ */
+ datasetId?: string;
+ /**
+ * [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ */
+ modelId?: string;
+ /**
+ * [Required] The ID of the project containing this model.
+ */
+ projectId?: string;
+ }
+ /**
+ * Evaluation metrics for multi-class classification models.
+ */
+ export interface Schema$MultiClassClassificationMetrics {
+ /**
+ * Aggregate classification metrics.
+ */
+ aggregateClassificationMetrics?: Schema$AggregateClassificationMetrics;
+ /**
+ * Confusion matrix at different thresholds.
+ */
+ confusionMatrixList?: Schema$ConfusionMatrix[];
+ }
export interface Schema$ProjectList {
/**
* A hash of the page of results
@@ -1727,11 +1545,11 @@ export namespace bigquery_v2 {
* Projects to which you have at least READ access.
*/
projects?: Array<{
- friendlyName?: string;
id?: string;
- kind?: string;
- numericId?: string;
projectReference?: Schema$ProjectReference;
+ friendlyName?: string;
+ numericId?: string;
+ kind?: string;
}>;
/**
* The total number of projects in the list.
@@ -1740,15 +1558,13 @@ export namespace bigquery_v2 {
}
export interface Schema$ProjectReference {
/**
- * [Required] ID of the project. Can be either the numeric ID or the
- * assigned ID of the project.
+ * [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.
*/
projectId?: string;
}
export interface Schema$QueryParameter {
/**
- * [Optional] If unset, this is a positional parameter. Otherwise, should be
- * unique within a query.
+ * [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
*/
name?: string;
/**
@@ -1766,12 +1582,11 @@ export namespace bigquery_v2 {
*/
arrayType?: Schema$QueryParameterType;
/**
- * [Optional] The types of the fields of this struct, in order, if this is a
- * struct.
+ * [Optional] The types of the fields of this struct, in order, if this is a struct.
*/
structTypes?: Array<{
- description?: string;
name?: string;
+ description?: string;
type?: Schema$QueryParameterType;
}>;
/**
@@ -1785,8 +1600,7 @@ export namespace bigquery_v2 {
*/
arrayValues?: Schema$QueryParameterValue[];
/**
- * [Optional] The struct field values, in order of the struct type's
- * declaration.
+ * [Optional] The struct field values, in order of the struct type's declaration.
*/
structValues?: {[key: string]: Schema$QueryParameterValue};
/**
@@ -1796,17 +1610,11 @@ export namespace bigquery_v2 {
}
export interface Schema$QueryRequest {
/**
- * [Optional] Specifies the default datasetId and projectId to assume for
- * any unqualified table names in the query. If not set, all table names in
- * the query string must be qualified in the format
- * 'datasetId.tableId'.
+ * [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.
*/
defaultDataset?: Schema$DatasetReference;
/**
- * [Optional] If set to true, BigQuery doesn't run the job. Instead, if
- * the query is valid, BigQuery returns statistics about the job such as how
- * many bytes would be processed. If the query is invalid, an error returns.
- * The default value is false.
+ * [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.
*/
dryRun?: boolean;
/**
@@ -1814,22 +1622,15 @@ export namespace bigquery_v2 {
*/
kind?: string;
/**
- * The geographic location where the job should run. See details at
- * https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
+ * The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string;
/**
- * [Optional] The maximum number of rows of data to return per page of
- * results. Setting this flag to a small value such as 1000 and then paging
- * through results might improve reliability when the query result set is
- * large. In addition to this limit, responses are also limited to 10 MB. By
- * default, there is no maximum row count, and only the byte limit applies.
+ * [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.
*/
maxResults?: number;
/**
- * Standard SQL only. Set to POSITIONAL to use positional (?) query
- * parameters or to NAMED to use named (@myparam) query parameters in this
- * query.
+ * Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
*/
parameterMode?: string;
/**
@@ -1837,9 +1638,7 @@ export namespace bigquery_v2 {
*/
preserveNulls?: boolean;
/**
- * [Required] A query string, following the BigQuery query syntax, of the
- * query to execute. Example: "SELECT count(f1) FROM
- * [myProjectId:myDatasetId.myTableId]".
+ * [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".
*/
query?: string;
/**
@@ -1847,28 +1646,15 @@ export namespace bigquery_v2 {
*/
queryParameters?: Schema$QueryParameter[];
/**
- * [Optional] How long to wait for the query to complete, in milliseconds,
- * before the request times out and returns. Note that this is only a
- * timeout for the request, not the query. If the query takes longer to run
- * than the timeout value, the call returns without any results and with the
- * 'jobComplete' flag set to false. You can call GetQueryResults()
- * to wait for the query to complete and read the results. The default value
- * is 10000 milliseconds (10 seconds).
+ * [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).
*/
timeoutMs?: number;
/**
- * Specifies whether to use BigQuery's legacy SQL dialect for this
- * query. The default value is true. If set to false, the query will use
- * BigQuery's standard SQL:
- * https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set
- * to false, the value of flattenResults is ignored; query will be run as if
- * flattenResults is false.
+ * Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
*/
useLegacySql?: boolean;
/**
- * [Optional] Whether to look for the result in the query cache. The query
- * cache is a best-effort cache that will be flushed whenever tables in the
- * query are modified. The default value is true.
+ * [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.
*/
useQueryCache?: boolean;
}
@@ -1878,24 +1664,15 @@ export namespace bigquery_v2 {
*/
cacheHit?: boolean;
/**
- * [Output-only] The first errors or warnings encountered during the running
- * of the job. The final message includes the number of errors that caused
- * the process to stop. Errors here do not necessarily mean that the job has
- * completed or was unsuccessful.
+ * [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
*/
errors?: Schema$ErrorProto[];
/**
- * Whether the query has completed or not. If rows or totalRows are present,
- * this will always be true. If this is false, totalRows will not be
- * available.
+ * Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
*/
jobComplete?: boolean;
/**
- * Reference to the Job that was created to run the query. This field will
- * be present even if the original request timed out, in which case
- * GetQueryResults can be used to read the results once the query has
- * completed. Since this API only returns the first page of results,
- * subsequent pages can be fetched via the same mechanism (GetQueryResults).
+ * Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
*/
jobReference?: Schema$JobReference;
/**
@@ -1903,8 +1680,7 @@ export namespace bigquery_v2 {
*/
kind?: string;
/**
- * [Output-only] The number of rows affected by a DML statement. Present
- * only for DML statements INSERT, UPDATE or DELETE.
+ * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
*/
numDmlAffectedRows?: string;
/**
@@ -1912,33 +1688,25 @@ export namespace bigquery_v2 {
*/
pageToken?: string;
/**
- * An object with as many results as can be contained within the maximum
- * permitted reply size. To get any additional rows, you can call
- * GetQueryResults and specify the jobReference returned above.
+ * An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
*/
rows?: Schema$TableRow[];
/**
- * The schema of the results. Present only when the query completes
- * successfully.
+ * The schema of the results. Present only when the query completes successfully.
*/
schema?: Schema$TableSchema;
/**
- * The total number of bytes processed for this query. If this query was a
- * dry run, this is the number of bytes that would be processed if the query
- * were run.
+ * The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.
*/
totalBytesProcessed?: string;
/**
- * The total number of rows in the complete query result set, which can be
- * more than the number of rows in this single page of results.
+ * The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
*/
totalRows?: string;
}
export interface Schema$QueryTimelineSample {
/**
- * Total number of units currently being processed by workers. This does not
- * correspond directly to slot usage. This is the largest value observed
- * since the last sample.
+ * Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
*/
activeUnits?: string;
/**
@@ -1960,15 +1728,38 @@ export namespace bigquery_v2 {
}
export interface Schema$RangePartitioning {
/**
- * [TrustedTester] [Required] The table is partitioned by this field. The
- * field must be a top-level NULLABLE/REQUIRED field. The only supported
- * type is INTEGER/INT64.
+ * [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
*/
field?: string;
/**
* [TrustedTester] [Required] Defines the ranges for range partitioning.
*/
- range?: {end?: string; interval?: string; start?: string};
+ range?: {interval?: string; start?: string; end?: string};
+ }
+ /**
+ * Evaluation metrics for regression models.
+ */
+ export interface Schema$RegressionMetrics {
+ /**
+ * Mean absolute error.
+ */
+ meanAbsoluteError?: number;
+ /**
+ * Mean squared error.
+ */
+ meanSquaredError?: number;
+ /**
+ * Mean squared log error.
+ */
+ meanSquaredLogError?: number;
+ /**
+ * Median absolute error.
+ */
+ medianAbsoluteError?: number;
+ /**
+ * R^2 score.
+ */
+ rSquared?: number;
}
export interface Schema$RoutineReference {
/**
@@ -1980,69 +1771,97 @@ export namespace bigquery_v2 {
*/
projectId?: string;
/**
- * [Required] The ID of the routine. The ID must contain only letters (a-z,
- * A-Z), numbers (0-9), or underscores (_). The maximum length is 256
- * characters.
+ * [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
*/
routineId?: string;
}
- export interface Schema$Streamingbuffer {
+ /**
+ * A single row in the confusion matrix.
+ */
+ export interface Schema$Row {
/**
- * [Output-only] A lower-bound estimate of the number of bytes currently in
- * the streaming buffer.
+ * The original label of this row.
*/
- estimatedBytes?: string;
+ actualLabel?: string;
/**
- * [Output-only] A lower-bound estimate of the number of rows currently in
- * the streaming buffer.
+ * Info describing predicted label distribution.
*/
- estimatedRows?: string;
+ entries?: Schema$Entry[];
+ }
+ /**
+ * The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY<DATE>>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}
+ */
+ export interface Schema$StandardSqlDataType {
/**
- * [Output-only] Contains the timestamp of the oldest entry in the streaming
- * buffer, in milliseconds since the epoch, if the streaming buffer is
- * available.
+ * The type of the array's elements, if type_kind = "ARRAY".
*/
- oldestEntryTime?: string;
- }
- export interface Schema$Table {
+ arrayElementType?: Schema$StandardSqlDataType;
/**
- * [Beta] Clustering specification for the table. Must be specified with
- * partitioning, data in the table will be first partitioned and
- * subsequently clustered.
+ * The fields of this struct, in order, if type_kind = "STRUCT".
*/
- clustering?: Schema$Clustering;
+ structType?: Schema$StandardSqlStructType;
/**
- * [Output-only] The time when this table was created, in milliseconds since
- * the epoch.
+ * Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
*/
- creationTime?: string;
+ typeKind?: string;
+ }
+ /**
+ * A field or a column.
+ */
+ export interface Schema$StandardSqlField {
/**
- * [Optional] A user-friendly description of this table.
+ * Optional. The name of this field. Can be absent for struct fields.
*/
- description?: string;
+ name?: string;
/**
- * Custom encryption configuration (e.g., Cloud KMS keys).
+ * Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
+ */
+ type?: Schema$StandardSqlDataType;
+ }
+ export interface Schema$StandardSqlStructType {
+ fields?: Schema$StandardSqlField[];
+ }
+ export interface Schema$Streamingbuffer {
+ /**
+ * [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
+ */
+ estimatedBytes?: string;
+ /**
+ * [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
+ */
+ estimatedRows?: string;
+ /**
+ * [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
+ */
+ oldestEntryTime?: string;
+ }
+ export interface Schema$Table {
+ /**
+ * [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.
+ */
+ clustering?: Schema$Clustering;
+ /**
+ * [Output-only] The time when this table was created, in milliseconds since the epoch.
+ */
+ creationTime?: string;
+ /**
+ * [Optional] A user-friendly description of this table.
+ */
+ description?: string;
+ /**
+ * Custom encryption configuration (e.g., Cloud KMS keys).
*/
encryptionConfiguration?: Schema$EncryptionConfiguration;
/**
- * [Output-only] A hash of the table metadata. Used to ensure there were no
- * concurrent modifications to the resource when attempting an update. Not
- * guaranteed to change when the table contents or the fields numRows,
- * numBytes, numLongTermBytes or lastModifiedTime change.
+ * [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.
*/
etag?: string;
/**
- * [Optional] The time when this table expires, in milliseconds since the
- * epoch. If not present, the table will persist indefinitely. Expired
- * tables will be deleted and their storage reclaimed. The
- * defaultTableExpirationMs property of the encapsulating dataset can be
- * used to set a default expirationTime on newly created tables.
+ * [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.
*/
expirationTime?: string;
/**
- * [Optional] Describes the data format, location, and other properties of a
- * table stored outside of BigQuery. By defining these properties, the data
- * source can then be queried as if it were a standard BigQuery table.
+ * [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
*/
externalDataConfiguration?: Schema$ExternalDataConfiguration;
/**
@@ -2058,22 +1877,15 @@ export namespace bigquery_v2 {
*/
kind?: string;
/**
- * The labels associated with this table. You can use these to organize and
- * group your tables. Label keys and values can be no longer than 63
- * characters, can only contain lowercase letters, numeric characters,
- * underscores and dashes. International characters are allowed. Label
- * values are optional. Label keys must start with a letter and each label
- * in the list must have a different key.
+ * The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
*/
labels?: {[key: string]: string};
/**
- * [Output-only] The time when this table was last modified, in milliseconds
- * since the epoch.
+ * [Output-only] The time when this table was last modified, in milliseconds since the epoch.
*/
lastModifiedTime?: string;
/**
- * [Output-only] The geographic location where the table resides. This value
- * is inherited from the dataset.
+ * [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
*/
location?: string;
/**
@@ -2081,41 +1893,31 @@ export namespace bigquery_v2 {
*/
materializedView?: Schema$MaterializedViewDefinition;
/**
- * [Output-only, Beta] Present iff this table represents a ML model.
- * Describes the training information for the model, and it is required to
- * run 'PREDICT' queries.
+ * [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.
*/
model?: Schema$ModelDefinition;
/**
- * [Output-only] The size of this table in bytes, excluding any data in the
- * streaming buffer.
+ * [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
*/
numBytes?: string;
/**
- * [Output-only] The number of bytes in the table that are considered
- * "long-term storage".
+ * [Output-only] The number of bytes in the table that are considered "long-term storage".
*/
numLongTermBytes?: string;
/**
- * [Output-only] [TrustedTester] The physical size of this table in bytes,
- * excluding any data in the streaming buffer. This includes compression and
- * storage used for time travel.
+ * [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.
*/
numPhysicalBytes?: string;
/**
- * [Output-only] The number of rows of data in this table, excluding any
- * data in the streaming buffer.
+ * [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
*/
numRows?: string;
/**
- * [TrustedTester] Range partitioning specification for this table. Only one
- * of timePartitioning and rangePartitioning should be specified.
+ * [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
*/
rangePartitioning?: Schema$RangePartitioning;
/**
- * [Beta] [Optional] If set to true, queries over this table require a
- * partition filter that can be used for partition elimination to be
- * specified.
+ * [Beta] [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
*/
requirePartitionFilter?: boolean;
/**
@@ -2127,9 +1929,7 @@ export namespace bigquery_v2 {
*/
selfLink?: string;
/**
- * [Output-only] Contains information regarding this table's streaming
- * buffer, if one is present. This field will be absent if the table is not
- * being streamed to or if there is no data in the streaming buffer.
+ * [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
*/
streamingBuffer?: Schema$Streamingbuffer;
/**
@@ -2137,17 +1937,11 @@ export namespace bigquery_v2 {
*/
tableReference?: Schema$TableReference;
/**
- * Time-based partitioning specification for this table. Only one of
- * timePartitioning and rangePartitioning should be specified.
+ * Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
*/
timePartitioning?: Schema$TimePartitioning;
/**
- * [Output-only] Describes the table type. The following values are
- * supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined
- * by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result
- * is persisted. EXTERNAL: A table that references data stored in an
- * external storage system, such as Google Cloud Storage. The default value
- * is TABLE.
+ * [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
*/
type?: string;
/**
@@ -2160,9 +1954,7 @@ export namespace bigquery_v2 {
}
export interface Schema$TableDataInsertAllRequest {
/**
- * [Optional] Accept rows that contain values that do not match the schema.
- * The unknown values are ignored. Default is false, which treats unknown
- * values as errors.
+ * [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
*/
ignoreUnknownValues?: boolean;
/**
@@ -2174,18 +1966,11 @@ export namespace bigquery_v2 {
*/
rows?: Array<{insertId?: string; json?: Schema$JsonObject}>;
/**
- * [Optional] Insert all valid rows of a request, even if invalid rows
- * exist. The default value is false, which causes the entire request to
- * fail if any invalid rows exist.
+ * [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
*/
skipInvalidRows?: boolean;
/**
- * If specified, treats the destination table as a base template, and
- * inserts the rows into an instance table named
- * "{destination}{templateSuffix}". BigQuery will manage creation
- * of the instance table, using the schema of the base template table. See
- * https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables
- * for considerations when working with templates tables.
+ * If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
*/
templateSuffix?: string;
}
@@ -2209,9 +1994,7 @@ export namespace bigquery_v2 {
*/
kind?: string;
/**
- * A token used for paging results. Providing this token instead of the
- * startIndex parameter can help you retrieve stable results when an
- * underlying table is changing.
+ * A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.
*/
pageToken?: string;
/**
@@ -2225,8 +2008,7 @@ export namespace bigquery_v2 {
}
export interface Schema$TableFieldSchema {
/**
- * [Optional] The categories attached to this field, used for field-level
- * access control.
+ * [Optional] The categories attached to this field, used for field-level access control.
*/
categories?: {names?: string[]};
/**
@@ -2234,27 +2016,19 @@ export namespace bigquery_v2 {
*/
description?: string;
/**
- * [Optional] Describes the nested schema fields if the type property is set
- * to RECORD.
+ * [Optional] Describes the nested schema fields if the type property is set to RECORD.
*/
fields?: Schema$TableFieldSchema[];
/**
- * [Optional] The field mode. Possible values include NULLABLE, REQUIRED and
- * REPEATED. The default value is NULLABLE.
+ * [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
*/
mode?: string;
/**
- * [Required] The field name. The name must contain only letters (a-z, A-Z),
- * numbers (0-9), or underscores (_), and must start with a letter or
- * underscore. The maximum length is 128 characters.
+ * [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
*/
name?: string;
/**
- * [Required] The field data type. Possible values include STRING, BYTES,
- * INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT),
- * BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD
- * (where RECORD indicates that the field contains a nested schema) or
- * STRUCT (same as RECORD).
+ * [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
*/
type?: string;
}
@@ -2276,16 +2050,16 @@ export namespace bigquery_v2 {
*/
tables?: Array<{
clustering?: Schema$Clustering;
- creationTime?: string;
- expirationTime?: string;
- friendlyName?: string;
+ type?: string;
id?: string;
- kind?: string;
- labels?: {[key: string]: string};
+ expirationTime?: string;
tableReference?: Schema$TableReference;
timePartitioning?: Schema$TimePartitioning;
- type?: string;
+ friendlyName?: string;
+ kind?: string;
view?: {useLegacySql?: boolean};
+ creationTime?: string;
+ labels?: {[key: string]: string};
}>;
/**
* The total number of tables in the dataset.
@@ -2302,16 +2076,13 @@ export namespace bigquery_v2 {
*/
projectId?: string;
/**
- * [Required] The ID of the table. The ID must contain only letters (a-z,
- * A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024
- * characters.
+ * [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
*/
tableId?: string;
}
export interface Schema$TableRow {
/**
- * Represents a single row in the result set, consisting of one or more
- * fields.
+ * Represents a single row in the result set, consisting of one or more fields.
*/
f?: Schema$TableCell[];
}
@@ -2323,36 +2094,117 @@ export namespace bigquery_v2 {
}
export interface Schema$TimePartitioning {
/**
- * [Optional] Number of milliseconds for which to keep the storage for
- * partitions in the table. The storage in a partition will have an
- * expiration time of its partition time plus this value.
+ * [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
*/
expirationMs?: string;
/**
- * [Beta] [Optional] If not set, the table is partitioned by pseudo column,
- * referenced via either '_PARTITIONTIME' as TIMESTAMP type, or
- * '_PARTITIONDATE' as DATE type. If field is specified, the table
- * is instead partitioned by this field. The field must be a top-level
- * TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
+ * [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
*/
field?: string;
requirePartitionFilter?: boolean;
/**
- * [Required] The only type supported is DAY, which will generate one
- * partition per day.
+ * [Required] The only type supported is DAY, which will generate one partition per day.
*/
type?: string;
}
+ export interface Schema$TrainingOptions {
+ /**
+ * The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
+ */
+ dataSplitColumn?: string;
+ /**
+ * The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
+ */
+ dataSplitEvalFraction?: number;
+ /**
+ * The data split type for training and evaluation, e.g. RANDOM.
+ */
+ dataSplitMethod?: string;
+ /**
+ * [Beta] Distance type for clustering models.
+ */
+ distanceType?: string;
+ /**
+ * Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress).
+ */
+ earlyStop?: boolean;
+ /**
+ * Specifies the initial learning rate for line search to start at.
+ */
+ initialLearnRate?: number;
+ /**
+ * Name of input label columns in training data.
+ */
+ inputLabelColumns?: string[];
+ /**
+ * L1 regularization coefficient.
+ */
+ l1Regularization?: number;
+ /**
+ * L2 regularization coefficient.
+ */
+ l2Regularization?: number;
+ /**
+ * Weights associated with each label class, for rebalancing the training data.
+ */
+ labelClassWeights?: {[key: string]: number};
+ /**
+ * Learning rate in training.
+ */
+ learnRate?: number;
+ /**
+ * The strategy to determine learning rate.
+ */
+ learnRateStrategy?: string;
+ /**
+ * Type of loss function used during training run.
+ */
+ lossType?: string;
+ /**
+ * The maximum number of iterations in training.
+ */
+ maxIterations?: string;
+ /**
+ * When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'.
+ */
+ minRelativeProgress?: number;
+ /**
+ * [Beta] Number of clusters for clustering models.
+ */
+ numClusters?: string;
+ /**
+ * Whether to train a model from the last checkpoint.
+ */
+ warmStart?: boolean;
+ }
+ /**
+ * Information about a single training query run for the model.
+ */
+ export interface Schema$TrainingRun {
+ /**
+ * The evaluation metrics over training/eval data that were computed at the end of training.
+ */
+ evaluationMetrics?: Schema$EvaluationMetrics;
+ /**
+ * Output of each iteration run, results.size() <= max_iterations.
+ */
+ results?: Schema$IterationResult[];
+ /**
+ * The start time of this training run.
+ */
+ startTime?: string;
+ /**
+ * Options that were used for this training run, includes user specified and default options that were used.
+ */
+ trainingOptions?: Schema$TrainingOptions;
+ }
export interface Schema$UserDefinedFunctionResource {
/**
- * [Pick one] An inline resource that contains code for a user-defined
- * function (UDF). Providing a inline code resource is equivalent to
- * providing a URI for a file containing the same code.
+ * [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
*/
inlineCode?: string;
/**
- * [Pick one] A code resource to load from a Google Cloud Storage URI
- * (gs://bucket/path).
+ * [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
*/
resourceUri?: string;
}
@@ -2362,10 +2214,7 @@ export namespace bigquery_v2 {
*/
query?: string;
/**
- * Specifies whether to use BigQuery's legacy SQL for this view. The
- * default value is true. If set to false, the view will use BigQuery's
- * standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries
- * and views that reference this view must use the same flag value.
+ * Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
*/
useLegacySql?: boolean;
/**
@@ -2382,24 +2231,19 @@ export namespace bigquery_v2 {
/**
* bigquery.datasets.delete
- * @desc Deletes the dataset specified by the datasetId value. Before you
- * can delete a dataset, you must delete all its tables, either manually or
- * by specifying deleteContents. Immediately after deletion, you can create
- * another dataset with the same name.
+ * @desc Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -2431,10 +2275,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -2517,14 +2360,12 @@ export namespace bigquery_v2 {
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -2559,10 +2400,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -2644,14 +2484,12 @@ export namespace bigquery_v2 {
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -2687,10 +2525,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -2765,22 +2602,19 @@ export namespace bigquery_v2 {
/**
* bigquery.datasets.list
- * @desc Lists all datasets in the specified project to which you have been
- * granted the READER dataset role.
+ * @desc Lists all datasets in the specified project to which you have been granted the READER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -2806,8 +2640,8 @@ export namespace bigquery_v2 {
* return;
* }
* for (var i = 0; i < datasetsPage.length; i++) {
- * // TODO: Change code below to process each resource in
- * `datasetsPage`: console.log(JSON.stringify(datasetsPage[i], null, 2));
+ * // TODO: Change code below to process each resource in `datasetsPage`:
+ * console.log(JSON.stringify(datasetsPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
@@ -2825,10 +2659,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -2908,24 +2741,19 @@ export namespace bigquery_v2 {
/**
* bigquery.datasets.patch
- * @desc Updates information in an existing dataset. The update method
- * replaces the entire dataset resource, whereas the patch method only
- * replaces fields that are provided in the submitted dataset resource. This
- * method supports patch semantics.
+ * @desc Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -2941,8 +2769,7 @@ export namespace bigquery_v2 {
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* resource: {
- * // TODO: Add desired properties to the request body. Only these
- * properties
+ * // TODO: Add desired properties to the request body. Only these properties
* // will be changed.
* },
*
@@ -2966,10 +2793,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -3045,23 +2871,19 @@ export namespace bigquery_v2 {
/**
* bigquery.datasets.update
- * @desc Updates information in an existing dataset. The update method
- * replaces the entire dataset resource, whereas the patch method only
- * replaces fields that are provided in the submitted dataset resource.
+ * @desc Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -3077,8 +2899,7 @@ export namespace bigquery_v2 {
* datasetId: 'my-dataset-id', // TODO: Update placeholder value.
*
* resource: {
- * // TODO: Add desired properties to the request body. All existing
- * properties
+ * // TODO: Add desired properties to the request body. All existing properties
* // will be replaced.
* },
*
@@ -3102,10 +2923,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -3191,8 +3011,7 @@ export namespace bigquery_v2 {
*/
datasetId?: string;
/**
- * If True, delete all the tables in the dataset. If False and the dataset
- * contains tables, the request will fail. Default is False
+ * If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
*/
deleteContents?: boolean;
/**
@@ -3242,11 +3061,7 @@ export namespace bigquery_v2 {
*/
all?: boolean;
/**
- * An expression for filtering the results of the request by label. The
- * syntax is "labels.[:]". Multiple filters can be ANDed
- * together by connecting with a space. Example:
- * "labels.department:receiving labels.active". See Filtering datasets using
- * labels for details.
+ * An expression for filtering the results of the request by label. The syntax is "labels.[:]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
*/
filter?: string;
/**
@@ -3254,8 +3069,7 @@ export namespace bigquery_v2 {
*/
maxResults?: number;
/**
- * Page token, returned by a previous call, to request the next page of
- * results
+ * Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
@@ -3312,24 +3126,19 @@ export namespace bigquery_v2 {
/**
* bigquery.jobs.cancel
- * @desc Requests that a job be cancelled. This call will return
- * immediately, and the client will need to poll for the job status to see
- * if the cancel completed successfully. Cancelled jobs may still incur
- * costs.
+ * @desc Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -3364,10 +3173,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -3445,23 +3253,19 @@ export namespace bigquery_v2 {
/**
* bigquery.jobs.get
- * @desc Returns information about a specific job. Job information is
- * available for a six month period after creation. Requires that you're the
- * person who ran the job, or have the Is Owner project role.
+ * @desc Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -3496,10 +3300,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -3582,14 +3385,12 @@ export namespace bigquery_v2 {
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -3618,8 +3419,8 @@ export namespace bigquery_v2 {
* return;
* }
* for (var i = 0; i < errorsPage.length; i++) {
- * // TODO: Change code below to process each resource in
- * `errorsPage`: console.log(JSON.stringify(errorsPage[i], null, 2));
+ * // TODO: Change code below to process each resource in `errorsPage`:
+ * console.log(JSON.stringify(errorsPage[i], null, 2));
* }
*
* if (response.pageToken) {
@@ -3637,10 +3438,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -3734,14 +3534,12 @@ export namespace bigquery_v2 {
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -3760,8 +3558,8 @@ export namespace bigquery_v2 {
* media: {
* // TODO: Add desired media content for upload. See
* // https://github.com/google/google-api-nodejs-client#media-uploads
- * mimeType: '', // See
- * https://www.w3.org/Protocols/rfc1341/4_Content-Type.html body: '',
+ * mimeType: '', // See https://www.w3.org/Protocols/rfc1341/4_Content-Type.html
+ * body: '',
* },
*
* auth: authClient,
@@ -3784,10 +3582,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -3869,25 +3666,19 @@ export namespace bigquery_v2 {
/**
* bigquery.jobs.list
- * @desc Lists all jobs that you started in the specified project. Job
- * information is available for a six month period after creation. The job
- * list is sorted in reverse chronological order, by job creation time.
- * Requires the Can View project role, or the Is Owner project role if you
- * set the allUsers property.
+ * @desc Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -3932,10 +3723,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -4017,22 +3807,19 @@ export namespace bigquery_v2 {
/**
* bigquery.jobs.query
- * @desc Runs a BigQuery SQL query synchronously and returns query results
- * if the query completes within a specified timeout.
+ * @desc Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -4068,10 +3855,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -4158,9 +3944,7 @@ export namespace bigquery_v2 {
*/
jobId?: string;
/**
- * The geographic location of the job. Required except for US and EU. See
- * details at
- * https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
+ * The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string;
/**
@@ -4179,9 +3963,7 @@ export namespace bigquery_v2 {
*/
jobId?: string;
/**
- * The geographic location of the job. Required except for US and EU. See
- * details at
- * https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
+ * The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string;
/**
@@ -4201,9 +3983,7 @@ export namespace bigquery_v2 {
*/
jobId?: string;
/**
- * The geographic location where the job should run. Required except for US
- * and EU. See details at
- * https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
+ * The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
*/
location?: string;
/**
@@ -4211,8 +3991,7 @@ export namespace bigquery_v2 {
*/
maxResults?: number;
/**
- * Page token, returned by a previous call, to request the next page of
- * results
+ * Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
@@ -4224,9 +4003,7 @@ export namespace bigquery_v2 {
*/
startIndex?: string;
/**
- * How long to wait for the query to complete, in milliseconds, before
- * returning. Default is 10 seconds. If the timeout passes before the job
- * completes, the 'jobComplete' field in the response will be false
+ * How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false
*/
timeoutMs?: number;
}
@@ -4272,8 +4049,7 @@ export namespace bigquery_v2 {
*/
allUsers?: boolean;
/**
- * Max value for job creation time, in milliseconds since the POSIX epoch.
- * If set, only jobs created before or at this timestamp are returned
+ * Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned
*/
maxCreationTime?: string;
/**
@@ -4281,13 +4057,11 @@ export namespace bigquery_v2 {
*/
maxResults?: number;
/**
- * Min value for job creation time, in milliseconds since the POSIX epoch.
- * If set, only jobs created after or at this timestamp are returned
+ * Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned
*/
minCreationTime?: string;
/**
- * Page token, returned by a previous call, to request the next page of
- * results
+ * Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
@@ -4320,6 +4094,395 @@ export namespace bigquery_v2 {
requestBody?: Schema$QueryRequest;
}
+ export class Resource$Models {
+ context: APIRequestContext;
+ constructor(context: APIRequestContext) {
+ this.context = context;
+ }
+
+ /**
+ * bigquery.models.delete
+ * @desc Deletes the model specified by modelId from the dataset.
+ * @alias bigquery.models.delete
+ * @memberOf! ()
+ *
+ * @param {object} params Parameters for request
+ * @param {string} params.datasetId Dataset ID of the model to delete.
+ * @param {string} params.modelId Model ID of the model to delete.
+ * @param {string} params.projectId Project ID of the model to delete.
+ * @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
+ */
+ delete(
+ params?: Params$Resource$Models$Delete,
+ options?: MethodOptions
+ ): GaxiosPromise;
+ delete(
+ params: Params$Resource$Models$Delete,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ delete(
+ params: Params$Resource$Models$Delete,
+ callback: BodyResponseCallback
+ ): void;
+ delete(callback: BodyResponseCallback): void;
+ delete(
+ paramsOrCallback?:
+ | Params$Resource$Models$Delete
+ | BodyResponseCallback,
+ optionsOrCallback?: MethodOptions | BodyResponseCallback,
+ callback?: BodyResponseCallback
+ ): void | GaxiosPromise {
+ let params = (paramsOrCallback || {}) as Params$Resource$Models$Delete;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Models$Delete;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (
+ rootUrl +
+ '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ method: 'DELETE',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['projectId', 'datasetId', 'modelId'],
+ pathParams: ['datasetId', 'modelId', 'projectId'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(parameters, callback);
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * bigquery.models.get
+ * @desc Gets the specified model resource by model ID.
+ * @alias bigquery.models.get
+ * @memberOf! ()
+ *
+ * @param {object} params Parameters for request
+ * @param {string} params.datasetId Dataset ID of the requested model.
+ * @param {string} params.modelId Model ID of the requested model.
+ * @param {string} params.projectId Project ID of the requested model.
+ * @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
+ */
+ get(
+ params?: Params$Resource$Models$Get,
+ options?: MethodOptions
+ ): GaxiosPromise;
+ get(
+ params: Params$Resource$Models$Get,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ get(
+ params: Params$Resource$Models$Get,
+ callback: BodyResponseCallback
+ ): void;
+ get(callback: BodyResponseCallback): void;
+ get(
+ paramsOrCallback?:
+ | Params$Resource$Models$Get
+ | BodyResponseCallback,
+ optionsOrCallback?: MethodOptions | BodyResponseCallback,
+ callback?: BodyResponseCallback
+ ): void | GaxiosPromise {
+ let params = (paramsOrCallback || {}) as Params$Resource$Models$Get;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Models$Get;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (
+ rootUrl +
+ '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ method: 'GET',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['projectId', 'datasetId', 'modelId'],
+ pathParams: ['datasetId', 'modelId', 'projectId'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(parameters, callback);
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * bigquery.models.list
+ * @desc Lists all models in the specified dataset. Requires the READER dataset role.
+ * @alias bigquery.models.list
+ * @memberOf! ()
+ *
+ * @param {object} params Parameters for request
+ * @param {string} params.datasetId Dataset ID of the models to list.
+ * @param {integer=} params.maxResults The maximum number of results per page.
+ * @param {string=} params.pageToken Page token, returned by a previous call to request the next page of results
+ * @param {string} params.projectId Project ID of the models to list.
+ * @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
+ */
+ list(
+ params?: Params$Resource$Models$List,
+ options?: MethodOptions
+ ): GaxiosPromise;
+ list(
+ params: Params$Resource$Models$List,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ list(
+ params: Params$Resource$Models$List,
+ callback: BodyResponseCallback
+ ): void;
+ list(callback: BodyResponseCallback): void;
+ list(
+ paramsOrCallback?:
+ | Params$Resource$Models$List
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | BodyResponseCallback,
+ callback?: BodyResponseCallback
+ ): void | GaxiosPromise {
+ let params = (paramsOrCallback || {}) as Params$Resource$Models$List;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Models$List;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (
+ rootUrl +
+ '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ method: 'GET',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['projectId', 'datasetId'],
+ pathParams: ['datasetId', 'projectId'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(parameters, callback);
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * bigquery.models.patch
+ * @desc Patch specific fields in the specified model.
+ * @alias bigquery.models.patch
+ * @memberOf! ()
+ *
+ * @param {object} params Parameters for request
+ * @param {string} params.datasetId Dataset ID of the model to patch.
+ * @param {string} params.modelId Model ID of the model to patch.
+ * @param {string} params.projectId Project ID of the model to patch.
+ * @param {().Model} 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
+ */
+ patch(
+ params?: Params$Resource$Models$Patch,
+ options?: MethodOptions
+ ): GaxiosPromise;
+ patch(
+ params: Params$Resource$Models$Patch,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ patch(
+ params: Params$Resource$Models$Patch,
+ callback: BodyResponseCallback
+ ): void;
+ patch(callback: BodyResponseCallback): void;
+ patch(
+ paramsOrCallback?:
+ | Params$Resource$Models$Patch
+ | BodyResponseCallback,
+ optionsOrCallback?: MethodOptions | BodyResponseCallback,
+ callback?: BodyResponseCallback
+ ): void | GaxiosPromise {
+ let params = (paramsOrCallback || {}) as Params$Resource$Models$Patch;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Models$Patch;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (
+ rootUrl +
+ '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}'
+ ).replace(/([^:]\/)\/+/g, '$1'),
+ method: 'PATCH',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['projectId', 'datasetId', 'modelId'],
+ pathParams: ['datasetId', 'modelId', 'projectId'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(parameters, callback);
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+ }
+
+ export interface Params$Resource$Models$Delete extends StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
+
+ /**
+ * Dataset ID of the model to delete.
+ */
+ datasetId?: string;
+ /**
+ * Model ID of the model to delete.
+ */
+ modelId?: string;
+ /**
+ * Project ID of the model to delete.
+ */
+ projectId?: string;
+ }
+ export interface Params$Resource$Models$Get extends StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
+
+ /**
+ * Dataset ID of the requested model.
+ */
+ datasetId?: string;
+ /**
+ * Model ID of the requested model.
+ */
+ modelId?: string;
+ /**
+ * Project ID of the requested model.
+ */
+ projectId?: string;
+ }
+ export interface Params$Resource$Models$List extends StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
+
+ /**
+ * Dataset ID of the models to list.
+ */
+ datasetId?: string;
+ /**
+ * The maximum number of results per page.
+ */
+ maxResults?: number;
+ /**
+ * Page token, returned by a previous call to request the next page of results
+ */
+ pageToken?: string;
+ /**
+ * Project ID of the models to list.
+ */
+ projectId?: string;
+ }
+ export interface Params$Resource$Models$Patch extends StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
+
+ /**
+ * Dataset ID of the model to patch.
+ */
+ datasetId?: string;
+ /**
+ * Model ID of the model to patch.
+ */
+ modelId?: string;
+ /**
+ * Project ID of the model to patch.
+ */
+ projectId?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$Model;
+ }
+
export class Resource$Projects {
context: APIRequestContext;
constructor(context: APIRequestContext) {
@@ -4328,22 +4491,19 @@ export namespace bigquery_v2 {
/**
* bigquery.projects.getServiceAccount
- * @desc Returns the email address of the service account for your project
- * used for interactions with Google Cloud KMS.
+ * @desc Returns the email address of the service account for your project used for interactions with Google Cloud KMS.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -4375,10 +4535,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -4469,14 +4628,12 @@ export namespace bigquery_v2 {
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -4499,8 +4656,8 @@ export namespace bigquery_v2 {
* return;
* }
* for (var i = 0; i < projectsPage.length; i++) {
- * // TODO: Change code below to process each resource in
- * `projectsPage`: console.log(JSON.stringify(projectsPage[i], null, 2));
+ * // TODO: Change code below to process each resource in `projectsPage`:
+ * console.log(JSON.stringify(projectsPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
@@ -4518,10 +4675,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -4621,8 +4777,7 @@ export namespace bigquery_v2 {
*/
maxResults?: number;
/**
- * Page token, returned by a previous call, to request the next page of
- * results
+ * Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
}
@@ -4635,22 +4790,19 @@ export namespace bigquery_v2 {
/**
* bigquery.tabledata.insertAll
- * @desc Streams data into BigQuery one record at a time without needing to
- * run a load job. Requires the WRITER dataset role.
+ * @desc Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -4692,10 +4844,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -4783,22 +4934,19 @@ export namespace bigquery_v2 {
/**
* bigquery.tabledata.list
- * @desc Retrieves table data from a specified set of rows. Requires the
- * READER dataset role.
+ * @desc Retrieves table data from a specified set of rows. Requires the READER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -4849,10 +4997,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -4982,8 +5129,7 @@ export namespace bigquery_v2 {
*/
projectId?: string;
/**
- * List of fields to return (comma-separated). If unspecified, all fields
- * are returned
+ * List of fields to return (comma-separated). If unspecified, all fields are returned
*/
selectedFields?: string;
/**
@@ -5004,22 +5150,19 @@ export namespace bigquery_v2 {
/**
* bigquery.tables.delete
- * @desc Deletes the table specified by tableId from the dataset. If the
- * table contains data, all the data will be deleted.
+ * @desc Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -5054,10 +5197,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -5134,23 +5276,19 @@ export namespace bigquery_v2 {
/**
* bigquery.tables.get
- * @desc Gets the specified table resource by table ID. This method does not
- * return the data in the table, it only returns the table resource, which
- * describes the structure of this table.
+ * @desc Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -5188,10 +5326,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -5276,14 +5413,12 @@ export namespace bigquery_v2 {
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -5322,10 +5457,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -5402,22 +5536,19 @@ export namespace bigquery_v2 {
/**
* bigquery.tables.list
- * @desc Lists all tables in the specified dataset. Requires the READER
- * dataset role.
+ * @desc Lists all tables in the specified dataset. Requires the READER dataset role.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -5446,8 +5577,8 @@ export namespace bigquery_v2 {
* return;
* }
* for (var i = 0; i < tablesPage.length; i++) {
- * // TODO: Change code below to process each resource in
- * `tablesPage`: console.log(JSON.stringify(tablesPage[i], null, 2));
+ * // TODO: Change code below to process each resource in `tablesPage`:
+ * console.log(JSON.stringify(tablesPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
@@ -5465,10 +5596,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -5548,24 +5678,19 @@ export namespace bigquery_v2 {
/**
* bigquery.tables.patch
- * @desc Updates information in an existing table. The update method
- * replaces the entire table resource, whereas the patch method only
- * replaces fields that are provided in the submitted table resource. This
- * method supports patch semantics.
+ * @desc Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -5584,8 +5709,7 @@ export namespace bigquery_v2 {
* tableId: 'my-table-id', // TODO: Update placeholder value.
*
* resource: {
- * // TODO: Add desired properties to the request body. Only these
- * properties
+ * // TODO: Add desired properties to the request body. Only these properties
* // will be changed.
* },
*
@@ -5609,10 +5733,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -5690,23 +5813,19 @@ export namespace bigquery_v2 {
/**
* bigquery.tables.update
- * @desc Updates information in an existing table. The update method
- * replaces the entire table resource, whereas the patch method only
- * replaces fields that are provided in the submitted table resource.
+ * @desc Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the BigQuery API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/bigquery
- * // 2. This sample uses Application Default Credentials for
- * authentication.
+ * // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
- * //
- * https://developers.google.com/identity/protocols/application-default-credentials
+ * // https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
@@ -5725,8 +5844,7 @@ export namespace bigquery_v2 {
* tableId: 'my-table-id', // TODO: Update placeholder value.
*
* resource: {
- * // TODO: Add desired properties to the request body. All existing
- * properties
+ * // TODO: Add desired properties to the request body. All existing properties
* // will be replaced.
* },
*
@@ -5750,10 +5868,9 @@ export namespace bigquery_v2 {
* console.error('authentication failed: ', err);
* return;
* }
- * if (authClient.createScopedRequired &&
- * authClient.createScopedRequired()) { var scopes =
- * ['https://www.googleapis.com/auth/cloud-platform']; authClient =
- * authClient.createScoped(scopes);
+ * if (authClient.createScopedRequired && authClient.createScopedRequired()) {
+ * var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
+ * authClient = authClient.createScoped(scopes);
* }
* callback(authClient);
* });
@@ -5864,8 +5981,7 @@ export namespace bigquery_v2 {
*/
projectId?: string;
/**
- * List of fields to return (comma-separated). If unspecified, all fields
- * are returned
+ * List of fields to return (comma-separated). If unspecified, all fields are returned
*/
selectedFields?: string;
/**
@@ -5908,8 +6024,7 @@ export namespace bigquery_v2 {
*/
maxResults?: number;
/**
- * Page token, returned by a previous call, to request the next page of
- * results
+ * Page token, returned by a previous call, to request the next page of results
*/
pageToken?: string;
/**
diff --git a/src/apis/bigquerydatatransfer/package.json b/src/apis/bigquerydatatransfer/package.json
index f35d867a953..101f3c432c0 100644
--- a/src/apis/bigquerydatatransfer/package.json
+++ b/src/apis/bigquerydatatransfer/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts
index f321556a62e..b634d282881 100644
--- a/src/apis/bigquerydatatransfer/v1.ts
+++ b/src/apis/bigquerydatatransfer/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace bigquerydatatransfer_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace bigquerydatatransfer_v1 {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* BigQuery Data Transfer API
*
- * Schedule queries or transfer external data from SaaS applications to Google
- * BigQuery on a regular basis.
+ * Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.
*
* @example
* const {google} = require('googleapis');
@@ -113,19 +108,17 @@ export namespace bigquerydatatransfer_v1 {
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.projects = new Resource$Projects(this.context);
}
}
/**
- * A request to determine whether the user has valid credentials. This method
- * is used to limit the number of OAuth popups in the user interface. The user
- * id is inferred from the API call context. If the data source has the
- * Google+ authorization type, this method returns false, as it cannot be
- * determined whether the credentials are already valid merely based on the
- * user id.
+ * A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
*/
export interface Schema$CheckValidCredsRequest {}
/**
@@ -138,8 +131,7 @@ export namespace bigquerydatatransfer_v1 {
hasValidCreds?: boolean;
}
/**
- * Represents data source metadata. Metadata is sufficient to render UI and
- * request proper OAuth tokens.
+ * Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
*/
export interface Schema$DataSource {
/**
@@ -151,10 +143,7 @@ export namespace bigquerydatatransfer_v1 {
*/
clientId?: string;
/**
- * Specifies whether the data source supports automatic data refresh for the
- * past few days, and how it's supported. For some data sources, data
- * might not be complete until a few days later, so it's useful to
- * refresh data automatically.
+ * Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
*/
dataRefreshType?: string;
/**
@@ -162,14 +151,11 @@ export namespace bigquerydatatransfer_v1 {
*/
dataSourceId?: string;
/**
- * Default data refresh window on days. Only meaningful when
- * `data_refresh_type` = `SLIDING_WINDOW`.
+ * Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
*/
defaultDataRefreshWindowDays?: number;
/**
- * Default data transfer schedule. Examples of valid schedules include:
- * `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and
- * `first sunday of quarter 00:00`.
+ * Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.
*/
defaultSchedule?: string;
/**
@@ -201,15 +187,11 @@ export namespace bigquerydatatransfer_v1 {
*/
parameters?: Schema$DataSourceParameter[];
/**
- * Api auth scopes for which refresh token needs to be obtained. These are
- * scopes needed by a data source to prepare data and ingest them into
- * BigQuery, e.g., https://www.googleapis.com/auth/bigquery
+ * Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
*/
scopes?: string[];
/**
- * Specifies whether the data source supports a user defined schedule, or
- * operates on the default schedule. When set to `true`, user can override
- * default schedule.
+ * Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule.
*/
supportsCustomSchedule?: boolean;
/**
@@ -221,17 +203,12 @@ export namespace bigquerydatatransfer_v1 {
*/
transferType?: string;
/**
- * The number of seconds to wait for an update from the data source before
- * the Data Transfer Service marks the transfer as FAILED.
+ * The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
*/
updateDeadlineSeconds?: number;
}
/**
- * Represents a data source parameter with validation rules, so that
- * parameters can be rendered in the UI. These parameters are given to us by
- * supported data sources, and include all needed information for rendering
- * and validation. Thus, whoever uses this api can decide to generate either
- * generic ui, or custom data source specific forms.
+ * Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.
*/
export interface Schema$DataSourceParameter {
/**
@@ -283,8 +260,7 @@ export namespace bigquerydatatransfer_v1 {
*/
type?: string;
/**
- * Description of the requirements for this field, in case the user input
- * does not fulfill the regex pattern or min/max values.
+ * Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
*/
validationDescription?: string;
/**
@@ -297,11 +273,7 @@ export namespace bigquerydatatransfer_v1 {
validationRegex?: string;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
@@ -313,9 +285,7 @@ export namespace bigquerydatatransfer_v1 {
*/
dataSources?: Schema$DataSource[];
/**
- * Output only. The next-pagination token. For multiple-page list results,
- * this token can be used as the `ListDataSourcesRequest.page_token` to
- * request the next page of list results.
+ * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results.
*/
nextPageToken?: string;
}
@@ -337,9 +307,7 @@ export namespace bigquerydatatransfer_v1 {
*/
export interface Schema$ListTransferConfigsResponse {
/**
- * Output only. The next-pagination token. For multiple-page list results,
- * this token can be used as the `ListTransferConfigsRequest.page_token` to
- * request the next page of list results.
+ * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.
*/
nextPageToken?: string;
/**
@@ -352,9 +320,7 @@ export namespace bigquerydatatransfer_v1 {
*/
export interface Schema$ListTransferLogsResponse {
/**
- * Output only. The next-pagination token. For multiple-page list results,
- * this token can be used as the `GetTransferRunLogRequest.page_token` to
- * request the next page of list results.
+ * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results.
*/
nextPageToken?: string;
/**
@@ -367,9 +333,7 @@ export namespace bigquerydatatransfer_v1 {
*/
export interface Schema$ListTransferRunsResponse {
/**
- * Output only. The next-pagination token. For multiple-page list results,
- * this token can be used as the `ListTransferRunsRequest.page_token` to
- * request the next page of list results.
+ * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.
*/
nextPageToken?: string;
/**
@@ -382,13 +346,11 @@ export namespace bigquerydatatransfer_v1 {
*/
export interface Schema$Location {
/**
- * The friendly name for this location, typically a nearby city name. For
- * example, "Tokyo".
+ * The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string;
/**
- * Cross-service attributes for the location. For example
- * {"cloud.googleapis.com/region": "us-east1"}
+ * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {[key: string]: string};
/**
@@ -396,13 +358,11 @@ export namespace bigquerydatatransfer_v1 {
*/
locationId?: string;
/**
- * Service-specific metadata. For example the available capacity at the
- * given location.
+ * Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {[key: string]: any};
/**
- * Resource name for the location, which may vary between implementations.
- * For example: `"projects/example-project/locations/us-east1"`
+ * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string;
}
@@ -411,25 +371,15 @@ export namespace bigquerydatatransfer_v1 {
*/
export interface Schema$ScheduleOptions {
/**
- * If true, automatic scheduling of data transfer runs for this
- * configuration will be disabled. The runs can be started on ad-hoc basis
- * using StartManualTransferRuns API. When automatic scheduling is disabled,
- * the TransferConfig.schedule field will be ignored.
+ * If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
*/
disableAutoScheduling?: boolean;
/**
- * Defines time to stop scheduling transfer runs. A transfer run cannot be
- * scheduled at or after the end time. The end time can be changed at any
- * moment. The time when a data transfer can be trigerred manually is not
- * limited by this option.
+ * Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
*/
endTime?: string;
/**
- * Specifies time to start scheduling transfer runs. The first run will be
- * scheduled at or after the start time according to a recurrence pattern
- * defined in the schedule string. The start time can be changed at any
- * moment. The time when a data transfer can be trigerred manually is not
- * limited by this option.
+ * Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
*/
startTime?: string;
}
@@ -438,13 +388,11 @@ export namespace bigquerydatatransfer_v1 {
*/
export interface Schema$ScheduleTransferRunsRequest {
/**
- * End time of the range of transfer runs. For example,
- * `"2017-05-30T00:00:00+00:00"`.
+ * End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`.
*/
endTime?: string;
/**
- * Start time of the range of transfer runs. For example,
- * `"2017-05-25T00:00:00+00:00"`.
+ * Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.
*/
startTime?: string;
}
@@ -462,8 +410,7 @@ export namespace bigquerydatatransfer_v1 {
*/
export interface Schema$StartManualTransferRunsRequest {
/**
- * Specific run_time for a transfer run to be started. The
- * requested_run_time must not be in the future.
+ * Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.
*/
requestedRunTime?: string;
/**
@@ -481,40 +428,7 @@ export namespace bigquerydatatransfer_v1 {
runs?: Schema$TransferRun[];
}
/**
- * The `Status` type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by [gRPC](https://github.com/grpc). The error model is designed to be:
- * - Simple to use and understand for most users - Flexible enough to meet
- * unexpected needs # Overview The `Status` message contains three pieces of
- * data: error code, error message, and error details. The error code should
- * be an enum value of google.rpc.Code, but it may accept additional error
- * codes if needed. The error message should be a developer-facing English
- * message that helps developers *understand* and *resolve* the error. If a
- * localized user-facing error message is needed, put the localized message in
- * the error details or localize it in the client. The optional error details
- * may contain arbitrary information about the error. There is a predefined
- * set of error detail types in the package `google.rpc` that can be used for
- * common error conditions. # Language mapping The `Status` message is the
- * logical representation of the error model, but it is not necessarily the
- * actual wire format. When the `Status` message is exposed in different
- * client libraries and different wire protocols, it can be mapped
- * differently. For example, it will likely be mapped to some exceptions in
- * Java, but more likely mapped to some error codes in C. # Other uses The
- * error model and the `Status` message can be used in a variety of
- * environments, either with or without APIs, to provide a consistent
- * developer experience across different environments. Example uses of this
- * error model include: - Partial errors. If a service needs to return
- * partial errors to the client, it may embed the `Status` in the normal
- * response to indicate the partial errors. - Workflow errors. A typical
- * workflow has multiple steps. Each step may have a `Status` message for
- * error reporting. - Batch operations. If a client uses batch request and
- * batch response, the `Status` message should be used directly inside
- * batch response, one for each error sub-response. - Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the `Status` message. - Logging. If some API errors are stored in
- * logs, the message `Status` could be used directly after any stripping
- * needed for security/privacy reasons.
+ * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -522,52 +436,33 @@ export namespace bigquerydatatransfer_v1 {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set
- * of message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
- * A specification for a time range, this will request transfer runs with
- * run_time between start_time (inclusive) and end_time (exclusive).
+ * A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
*/
export interface Schema$TimeRange {
/**
- * End time of the range of transfer runs. For example,
- * `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the
- * future. Creates transfer runs where run_time is in the range betwen
- * start_time (inclusive) and end_time (exlusive).
+ * End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range betwen start_time (inclusive) and end_time (exlusive).
*/
endTime?: string;
/**
- * Start time of the range of transfer runs. For example,
- * `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly
- * less than the end_time. Creates transfer runs where run_time is in the
- * range betwen start_time (inclusive) and end_time (exlusive).
+ * Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range betwen start_time (inclusive) and end_time (exlusive).
*/
startTime?: string;
}
/**
- * Represents a data transfer configuration. A transfer configuration contains
- * all metadata needed to perform a data transfer. For example,
- * `destination_dataset_id` specifies where data should be stored. When a new
- * transfer configuration is created, the specified `destination_dataset_id`
- * is created when needed and shared with the appropriate data source service
- * account.
+ * Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
*/
export interface Schema$TransferConfig {
/**
- * The number of days to look back to automatically refresh the data. For
- * example, if `data_refresh_window_days = 10`, then every day BigQuery
- * reingests data for [today-10, today-1], rather than ingesting data for
- * just [today-1]. Only valid if the data source supports the feature. Set
- * the value to 0 to use the default value.
+ * The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
*/
dataRefreshWindowDays?: number;
/**
@@ -583,8 +478,7 @@ export namespace bigquerydatatransfer_v1 {
*/
destinationDatasetId?: string;
/**
- * Is this config disabled. When set to true, no runs are scheduled for a
- * given transfer.
+ * Is this config disabled. When set to true, no runs are scheduled for a given transfer.
*/
disabled?: boolean;
/**
@@ -592,13 +486,7 @@ export namespace bigquerydatatransfer_v1 {
*/
displayName?: string;
/**
- * The resource name of the transfer config. Transfer config names have the
- * form of
- * `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- * The name is automatically generated based on the config_id specified in
- * CreateTransferConfigRequest along with project_id and region. If
- * config_id is not provided, usually a uuid, even though it is not
- * guaranteed or required, will be generated for config_id.
+ * The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
*/
name?: string;
/**
@@ -610,14 +498,7 @@ export namespace bigquerydatatransfer_v1 {
*/
params?: {[key: string]: any};
/**
- * Data transfer schedule. If the data source does not support a custom
- * schedule, this should be empty. If it is empty, the default value for the
- * data source will be used. The specified times are in UTC. Examples of
- * valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun
- * 13:15`, and `first sunday of quarter 00:00`. See more explanation about
- * the format here:
- * https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
- * NOTE: the granularity should be at least 8 hours, or less frequent.
+ * Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
*/
schedule?: string;
/**
@@ -667,8 +548,7 @@ export namespace bigquerydatatransfer_v1 {
*/
destinationDatasetId?: string;
/**
- * Output only. Time when transfer run ended. Parameter ignored by server
- * for input requests.
+ * Output only. Time when transfer run ended. Parameter ignored by server for input requests.
*/
endTime?: string;
/**
@@ -676,9 +556,7 @@ export namespace bigquerydatatransfer_v1 {
*/
errorStatus?: Schema$Status;
/**
- * The resource name of the transfer run. Transfer run names have the form
- * `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
- * The name is ignored when creating a transfer run.
+ * The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
*/
name?: string;
/**
@@ -686,16 +564,11 @@ export namespace bigquerydatatransfer_v1 {
*/
params?: {[key: string]: any};
/**
- * For batch transfer runs, specifies the date and time that data should be
- * ingested.
+ * For batch transfer runs, specifies the date and time that data should be ingested.
*/
runTime?: string;
/**
- * Output only. Describes the schedule of this transfer run if it was
- * created as part of a regular schedule. For batch transfer runs that are
- * scheduled manually, this is empty. NOTE: the system might choose to delay
- * the schedule depending on the current load, so `schedule_time`
- * doesn't always match this.
+ * Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
*/
schedule?: string;
/**
@@ -703,8 +576,7 @@ export namespace bigquerydatatransfer_v1 {
*/
scheduleTime?: string;
/**
- * Output only. Time when transfer run was started. Parameter ignored by
- * server for input requests.
+ * Output only. Time when transfer run was started. Parameter ignored by server for input requests.
*/
startTime?: string;
/**
@@ -744,11 +616,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.dataSources.checkValidCreds
- * @desc Returns true if valid credentials exist for the given data source
- * and requesting user. Some data sources doesn't support service account,
- * so we need to talk to them on behalf of the end user. This API just
- * checks whether we have OAuth token for the particular user, which is a
- * pre-requisite before user can create a transfer config.
+ * @desc Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.
* @alias bigquerydatatransfer.projects.dataSources.checkValidCreds
* @memberOf! ()
*
@@ -828,8 +696,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.dataSources.get
- * @desc Retrieves a supported data source and returns its settings, which
- * can be used for UI rendering.
+ * @desc Retrieves a supported data source and returns its settings, which can be used for UI rendering.
* @alias bigquerydatatransfer.projects.dataSources.get
* @memberOf! ()
*
@@ -901,8 +768,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.dataSources.list
- * @desc Lists supported data sources and returns their settings, which can
- * be used for UI rendering.
+ * @desc Lists supported data sources and returns their settings, which can be used for UI rendering.
* @alias bigquerydatatransfer.projects.dataSources.list
* @memberOf! ()
*
@@ -988,8 +854,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The data source in the form:
- * `projects/{project_id}/dataSources/{data_source_id}`
+ * The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
@@ -1006,8 +871,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/dataSources/{data_source_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
}
@@ -1023,15 +887,11 @@ export namespace bigquerydatatransfer_v1 {
*/
pageSize?: number;
/**
- * Pagination token, which can be used to request a specific page of
- * `ListDataSourcesRequest` list results. For multiple-page results,
- * `ListDataSourcesResponse` outputs a `next_page` token, which can be used
- * as the `page_token` value to request the next page of list results.
+ * Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
- * The BigQuery project id for which data sources should be returned. Must
- * be in the form: `projects/{project_id}`
+ * The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`
*/
parent?: string;
}
@@ -1246,13 +1106,8 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.dataSources.checkValidCreds
- * @desc Returns true if valid credentials exist for the given data source
- * and requesting user. Some data sources doesn't support service account,
- * so we need to talk to them on behalf of the end user. This API just
- * checks whether we have OAuth token for the particular user, which is a
- * pre-requisite before user can create a transfer config.
- * @alias
- * bigquerydatatransfer.projects.locations.dataSources.checkValidCreds
+ * @desc Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.
+ * @alias bigquerydatatransfer.projects.locations.dataSources.checkValidCreds
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -1331,8 +1186,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.dataSources.get
- * @desc Retrieves a supported data source and returns its settings, which
- * can be used for UI rendering.
+ * @desc Retrieves a supported data source and returns its settings, which can be used for UI rendering.
* @alias bigquerydatatransfer.projects.locations.dataSources.get
* @memberOf! ()
*
@@ -1404,8 +1258,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.dataSources.list
- * @desc Lists supported data sources and returns their settings, which can
- * be used for UI rendering.
+ * @desc Lists supported data sources and returns their settings, which can be used for UI rendering.
* @alias bigquerydatatransfer.projects.locations.dataSources.list
* @memberOf! ()
*
@@ -1491,8 +1344,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The data source in the form:
- * `projects/{project_id}/dataSources/{data_source_id}`
+ * The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
@@ -1509,8 +1361,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/dataSources/{data_source_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
*/
name?: string;
}
@@ -1526,15 +1377,11 @@ export namespace bigquerydatatransfer_v1 {
*/
pageSize?: number;
/**
- * Pagination token, which can be used to request a specific page of
- * `ListDataSourcesRequest` list results. For multiple-page results,
- * `ListDataSourcesResponse` outputs a `next_page` token, which can be used
- * as the `page_token` value to request the next page of list results.
+ * Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
- * The BigQuery project id for which data sources should be returned. Must
- * be in the form: `projects/{project_id}`
+ * The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`
*/
parent?: string;
}
@@ -1629,8 +1476,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.transferConfigs.delete
- * @desc Deletes a data transfer configuration, including any associated
- * transfer runs and logs.
+ * @desc Deletes a data transfer configuration, including any associated transfer runs and logs.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.delete
* @memberOf! ()
*
@@ -1857,8 +1703,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.transferConfigs.patch
- * @desc Updates a data transfer configuration. All fields must be set, even
- * if they are not updated.
+ * @desc Updates a data transfer configuration. All fields must be set, even if they are not updated.
* @alias bigquerydatatransfer.projects.locations.transferConfigs.patch
* @memberOf! ()
*
@@ -1934,12 +1779,8 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns
- * @desc Creates transfer runs for a time range [start_time, end_time]. For
- * each date - or whatever granularity the data source supports - in the
- * range, one transfer run is created. Note that runs are created per UTC
- * time in the time range. DEPRECATED: use StartManualTransferRuns instead.
- * @alias
- * bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns
+ * @desc Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
+ * @alias bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -2023,12 +1864,8 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns
- * @desc Start manual transfer runs to be executed now with schedule_time
- * equal to current time. The transfer runs can be created for a time range
- * where the run_time is between start_time (inclusive) and end_time
- * (exclusive), or for a specific run_time.
- * @alias
- * bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns
+ * @desc Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
+ * @alias bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -2119,37 +1956,15 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Optional OAuth2 authorization code to use with this transfer
- * configuration. This is required if new credentials are needed, as
- * indicated by `CheckValidCreds`. In order to obtain authorization_code,
- * please make a request to
- * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=
- * * client_id should be OAuth client_id of BigQuery DTS API for the given
- * data source returned by ListDataSources method. * data_source_scopes are
- * the scopes returned by ListDataSources method. * redirect_uri is an
- * optional parameter. If not specified, then authorization code is posted
- * to the opener of authorization flow window. Otherwise it will be sent
- * to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means
- * that authorization code should be returned in the title bar of the
- * browser, with the page text prompting the user to copy the code and
- * paste it in the application.
+ * Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
*/
authorizationCode?: string;
/**
- * The BigQuery project id where the transfer configuration should be
- * created. Must be in the format
- * projects/{project_id}/locations/{location_id} If specified location and
- * location of the destination bigquery dataset do not match - the request
- * will fail.
+ * The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
*/
parent?: string;
/**
- * Optional version info. If users want to find a very recent access token,
- * that is, immediately after approving access, users have to set the
- * version_info claim in the token request. To obtain the version_info,
- * users must use the “none+gsession” response type. which be return a
- * version_info back in the authorization response which be be put in a JWT
- * claim in the token request.
+ * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
*/
versionInfo?: string;
@@ -2166,8 +1981,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/transferConfigs/{config_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
*/
name?: string;
}
@@ -2179,8 +1993,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/transferConfigs/{config_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
*/
name?: string;
}
@@ -2192,8 +2005,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * When specified, only configurations of requested data sources are
- * returned.
+ * When specified, only configurations of requested data sources are returned.
*/
dataSourceIds?: string[];
/**
@@ -2201,15 +2013,11 @@ export namespace bigquerydatatransfer_v1 {
*/
pageSize?: number;
/**
- * Pagination token, which can be used to request a specific page of
- * `ListTransfersRequest` list results. For multiple-page results,
- * `ListTransfersResponse` outputs a `next_page` token, which can be used as
- * the `page_token` value to request the next page of list results.
+ * Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
- * The BigQuery project id for which data sources should be returned:
- * `projects/{project_id}`.
+ * The BigQuery project id for which data sources should be returned: `projects/{project_id}`.
*/
parent?: string;
}
@@ -2221,30 +2029,11 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Optional OAuth2 authorization code to use with this transfer
- * configuration. If it is provided, the transfer configuration will be
- * associated with the authorizing user. In order to obtain
- * authorization_code, please make a request to
- * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=
- * * client_id should be OAuth client_id of BigQuery DTS API for the given
- * data source returned by ListDataSources method. * data_source_scopes are
- * the scopes returned by ListDataSources method. * redirect_uri is an
- * optional parameter. If not specified, then authorization code is posted
- * to the opener of authorization flow window. Otherwise it will be sent
- * to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means
- * that authorization code should be returned in the title bar of the
- * browser, with the page text prompting the user to copy the code and
- * paste it in the application.
+ * Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
*/
authorizationCode?: string;
/**
- * The resource name of the transfer config. Transfer config names have the
- * form of
- * `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- * The name is automatically generated based on the config_id specified in
- * CreateTransferConfigRequest along with project_id and region. If
- * config_id is not provided, usually a uuid, even though it is not
- * guaranteed or required, will be generated for config_id.
+ * The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
*/
name?: string;
/**
@@ -2252,12 +2041,7 @@ export namespace bigquerydatatransfer_v1 {
*/
updateMask?: string;
/**
- * Optional version info. If users want to find a very recent access token,
- * that is, immediately after approving access, users have to set the
- * version_info claim in the token request. To obtain the version_info,
- * users must use the “none+gsession” response type. which be return a
- * version_info back in the authorization response which be be put in a JWT
- * claim in the token request.
+ * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
*/
versionInfo?: string;
@@ -2274,8 +2058,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Transfer configuration name in the form:
- * `projects/{project_id}/transferConfigs/{config_id}`.
+ * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
@@ -2292,8 +2075,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Transfer configuration name in the form:
- * `projects/{project_id}/transferConfigs/{config_id}`.
+ * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
@@ -2316,8 +2098,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.transferConfigs.runs.delete
* @desc Deletes the specified transfer run.
- * @alias
- * bigquerydatatransfer.projects.locations.transferConfigs.runs.delete
+ * @alias bigquerydatatransfer.projects.locations.transferConfigs.runs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -2543,8 +2324,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
*/
name?: string;
}
@@ -2556,8 +2336,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
*/
name?: string;
}
@@ -2573,16 +2352,11 @@ export namespace bigquerydatatransfer_v1 {
*/
pageSize?: number;
/**
- * Pagination token, which can be used to request a specific page of
- * `ListTransferRunsRequest` list results. For multiple-page results,
- * `ListTransferRunsResponse` outputs a `next_page` token, which can be used
- * as the `page_token` value to request the next page of list results.
+ * Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
- * Name of transfer configuration for which transfer runs should be
- * retrieved. Format of transfer configuration resource name is:
- * `projects/{project_id}/transferConfigs/{config_id}`.
+ * Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
/**
@@ -2604,8 +2378,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list
* @desc Returns user facing log messages for the data transfer run.
- * @alias
- * bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list
+ * @alias bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -2691,8 +2464,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Message types to return. If not populated - INFO, WARNING and ERROR
- * messages are returned.
+ * Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
*/
messageTypes?: string[];
/**
@@ -2700,15 +2472,11 @@ export namespace bigquerydatatransfer_v1 {
*/
pageSize?: number;
/**
- * Pagination token, which can be used to request a specific page of
- * `ListTransferLogsRequest` list results. For multiple-page results,
- * `ListTransferLogsResponse` outputs a `next_page` token, which can be used
- * as the `page_token` value to request the next page of list results.
+ * Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
- * Transfer run name in the form:
- * `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
+ * Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
*/
parent?: string;
}
@@ -2801,8 +2569,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.transferConfigs.delete
- * @desc Deletes a data transfer configuration, including any associated
- * transfer runs and logs.
+ * @desc Deletes a data transfer configuration, including any associated transfer runs and logs.
* @alias bigquerydatatransfer.projects.transferConfigs.delete
* @memberOf! ()
*
@@ -3029,8 +2796,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.transferConfigs.patch
- * @desc Updates a data transfer configuration. All fields must be set, even
- * if they are not updated.
+ * @desc Updates a data transfer configuration. All fields must be set, even if they are not updated.
* @alias bigquerydatatransfer.projects.transferConfigs.patch
* @memberOf! ()
*
@@ -3106,10 +2872,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.transferConfigs.scheduleRuns
- * @desc Creates transfer runs for a time range [start_time, end_time]. For
- * each date - or whatever granularity the data source supports - in the
- * range, one transfer run is created. Note that runs are created per UTC
- * time in the time range. DEPRECATED: use StartManualTransferRuns instead.
+ * @desc Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
* @alias bigquerydatatransfer.projects.transferConfigs.scheduleRuns
* @memberOf! ()
*
@@ -3194,10 +2957,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.transferConfigs.startManualRuns
- * @desc Start manual transfer runs to be executed now with schedule_time
- * equal to current time. The transfer runs can be created for a time range
- * where the run_time is between start_time (inclusive) and end_time
- * (exclusive), or for a specific run_time.
+ * @desc Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
* @alias bigquerydatatransfer.projects.transferConfigs.startManualRuns
* @memberOf! ()
*
@@ -3289,37 +3049,15 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Optional OAuth2 authorization code to use with this transfer
- * configuration. This is required if new credentials are needed, as
- * indicated by `CheckValidCreds`. In order to obtain authorization_code,
- * please make a request to
- * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=
- * * client_id should be OAuth client_id of BigQuery DTS API for the given
- * data source returned by ListDataSources method. * data_source_scopes are
- * the scopes returned by ListDataSources method. * redirect_uri is an
- * optional parameter. If not specified, then authorization code is posted
- * to the opener of authorization flow window. Otherwise it will be sent
- * to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means
- * that authorization code should be returned in the title bar of the
- * browser, with the page text prompting the user to copy the code and
- * paste it in the application.
+ * Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
*/
authorizationCode?: string;
/**
- * The BigQuery project id where the transfer configuration should be
- * created. Must be in the format
- * projects/{project_id}/locations/{location_id} If specified location and
- * location of the destination bigquery dataset do not match - the request
- * will fail.
+ * The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
*/
parent?: string;
/**
- * Optional version info. If users want to find a very recent access token,
- * that is, immediately after approving access, users have to set the
- * version_info claim in the token request. To obtain the version_info,
- * users must use the “none+gsession” response type. which be return a
- * version_info back in the authorization response which be be put in a JWT
- * claim in the token request.
+ * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
*/
versionInfo?: string;
@@ -3336,8 +3074,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/transferConfigs/{config_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
*/
name?: string;
}
@@ -3349,8 +3086,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/transferConfigs/{config_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`
*/
name?: string;
}
@@ -3362,8 +3098,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * When specified, only configurations of requested data sources are
- * returned.
+ * When specified, only configurations of requested data sources are returned.
*/
dataSourceIds?: string[];
/**
@@ -3371,15 +3106,11 @@ export namespace bigquerydatatransfer_v1 {
*/
pageSize?: number;
/**
- * Pagination token, which can be used to request a specific page of
- * `ListTransfersRequest` list results. For multiple-page results,
- * `ListTransfersResponse` outputs a `next_page` token, which can be used as
- * the `page_token` value to request the next page of list results.
+ * Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
- * The BigQuery project id for which data sources should be returned:
- * `projects/{project_id}`.
+ * The BigQuery project id for which data sources should be returned: `projects/{project_id}`.
*/
parent?: string;
}
@@ -3391,30 +3122,11 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Optional OAuth2 authorization code to use with this transfer
- * configuration. If it is provided, the transfer configuration will be
- * associated with the authorizing user. In order to obtain
- * authorization_code, please make a request to
- * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=
- * * client_id should be OAuth client_id of BigQuery DTS API for the given
- * data source returned by ListDataSources method. * data_source_scopes are
- * the scopes returned by ListDataSources method. * redirect_uri is an
- * optional parameter. If not specified, then authorization code is posted
- * to the opener of authorization flow window. Otherwise it will be sent
- * to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means
- * that authorization code should be returned in the title bar of the
- * browser, with the page text prompting the user to copy the code and
- * paste it in the application.
+ * Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
*/
authorizationCode?: string;
/**
- * The resource name of the transfer config. Transfer config names have the
- * form of
- * `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- * The name is automatically generated based on the config_id specified in
- * CreateTransferConfigRequest along with project_id and region. If
- * config_id is not provided, usually a uuid, even though it is not
- * guaranteed or required, will be generated for config_id.
+ * The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
*/
name?: string;
/**
@@ -3422,12 +3134,7 @@ export namespace bigquerydatatransfer_v1 {
*/
updateMask?: string;
/**
- * Optional version info. If users want to find a very recent access token,
- * that is, immediately after approving access, users have to set the
- * version_info claim in the token request. To obtain the version_info,
- * users must use the “none+gsession” response type. which be return a
- * version_info back in the authorization response which be be put in a JWT
- * claim in the token request.
+ * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
*/
versionInfo?: string;
@@ -3444,8 +3151,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Transfer configuration name in the form:
- * `projects/{project_id}/transferConfigs/{config_id}`.
+ * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
@@ -3462,8 +3168,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Transfer configuration name in the form:
- * `projects/{project_id}/transferConfigs/{config_id}`.
+ * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
@@ -3712,8 +3417,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
*/
name?: string;
}
@@ -3725,8 +3429,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The field will contain name of the resource requested, for example:
- * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
+ * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
*/
name?: string;
}
@@ -3742,16 +3445,11 @@ export namespace bigquerydatatransfer_v1 {
*/
pageSize?: number;
/**
- * Pagination token, which can be used to request a specific page of
- * `ListTransferRunsRequest` list results. For multiple-page results,
- * `ListTransferRunsResponse` outputs a `next_page` token, which can be used
- * as the `page_token` value to request the next page of list results.
+ * Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
- * Name of transfer configuration for which transfer runs should be
- * retrieved. Format of transfer configuration resource name is:
- * `projects/{project_id}/transferConfigs/{config_id}`.
+ * Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`.
*/
parent?: string;
/**
@@ -3773,8 +3471,7 @@ export namespace bigquerydatatransfer_v1 {
/**
* bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list
* @desc Returns user facing log messages for the data transfer run.
- * @alias
- * bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list
+ * @alias bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
@@ -3860,8 +3557,7 @@ export namespace bigquerydatatransfer_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Message types to return. If not populated - INFO, WARNING and ERROR
- * messages are returned.
+ * Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
*/
messageTypes?: string[];
/**
@@ -3869,15 +3565,11 @@ export namespace bigquerydatatransfer_v1 {
*/
pageSize?: number;
/**
- * Pagination token, which can be used to request a specific page of
- * `ListTransferLogsRequest` list results. For multiple-page results,
- * `ListTransferLogsResponse` outputs a `next_page` token, which can be used
- * as the `page_token` value to request the next page of list results.
+ * Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
*/
pageToken?: string;
/**
- * Transfer run name in the form:
- * `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
+ * Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.
*/
parent?: string;
}
diff --git a/src/apis/bigtableadmin/package.json b/src/apis/bigtableadmin/package.json
index 958f7b938a4..d24114720df 100644
--- a/src/apis/bigtableadmin/package.json
+++ b/src/apis/bigtableadmin/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/bigtableadmin/v1.ts b/src/apis/bigtableadmin/v1.ts
index 8b7df6d8667..265b42f7a3c 100644
--- a/src/apis/bigtableadmin/v1.ts
+++ b/src/apis/bigtableadmin/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace bigtableadmin_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace bigtableadmin_v1 {
*/
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.
+ * 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;
/**
@@ -112,37 +108,33 @@ export namespace bigtableadmin_v1 {
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.projects = new Resource$Projects(this.context);
}
}
/**
- * A resizable group of nodes in a particular cloud location, capable of
- * serving all Tables in the parent Instance.
+ * A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
*/
export interface Schema$Cluster {
/**
- * (`CreationOnly`) The type of storage used by this cluster to serve its
- * parent instance's tables, unless explicitly overridden.
+ * (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
*/
defaultStorageType?: string;
/**
- * (`CreationOnly`) The location where this cluster's nodes and storage
- * reside. For best performance, clients should be located as close as
- * possible to this cluster. Currently only zones are supported, so values
- * should be of the form `projects/<project>/locations/<zone>`.
+ * (`CreationOnly`) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`.
*/
location?: string;
/**
- * (`OutputOnly`) The unique name of the cluster. Values are of the form
- * `projects/<project>/instances/<instance>/clusters/a-z*`.
+ * (`OutputOnly`) The unique name of the cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/a-z*`.
*/
name?: string;
/**
- * The number of nodes allocated to this cluster. More nodes enable higher
- * throughput and more consistent performance.
+ * The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
*/
serveNodes?: number;
/**
@@ -167,13 +159,7 @@ export namespace bigtableadmin_v1 {
*/
requestTime?: string;
/**
- * Keys: the full `name` of each table that existed in the instance when
- * CreateCluster was first called, i.e.
- * `projects/<project>/instances/<instance>/tables/<table>`.
- * Any table added to the instance by a later API call will be created in
- * the new cluster by that API call, not this one. Values: information on
- * how much of a table's data has been copied to the newly-created
- * cluster so far.
+ * Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects/<project>/instances/<instance>/tables/<table>`. Any table added to the instance by a later API call will be created in the new cluster by that API call, not this one. Values: information on how much of a table's data has been copied to the newly-created cluster so far.
*/
tables?: {[key: string]: Schema$TableProgress};
}
@@ -186,15 +172,11 @@ export namespace bigtableadmin_v1 {
*/
cluster?: Schema$Cluster;
/**
- * The ID to be used when referring to the new cluster within its instance,
- * e.g., just `mycluster` rather than
- * `projects/myproject/instances/myinstance/clusters/mycluster`.
+ * The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`.
*/
clusterId?: string;
/**
- * The unique name of the instance in which to create the new cluster.
- * Values are of the form
- * `projects/<project>/instances/<instance>`.
+ * The unique name of the instance in which to create the new cluster. Values are of the form `projects/<project>/instances/<instance>`.
*/
parent?: string;
}
@@ -207,8 +189,7 @@ export namespace bigtableadmin_v1 {
*/
finishTime?: string;
/**
- * The request that prompted the initiation of this CreateInstance
- * operation.
+ * The request that prompted the initiation of this CreateInstance operation.
*/
originalRequest?: Schema$CreateInstanceRequest;
/**
@@ -221,11 +202,7 @@ export namespace bigtableadmin_v1 {
*/
export interface Schema$CreateInstanceRequest {
/**
- * The clusters to be created within the instance, mapped by desired cluster
- * ID, e.g., just `mycluster` rather than
- * `projects/myproject/instances/myinstance/clusters/mycluster`. Fields
- * marked `OutputOnly` must be left blank. Currently, at most two clusters
- * can be specified.
+ * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most two clusters can be specified.
*/
clusters?: {[key: string]: Schema$Cluster};
/**
@@ -233,43 +210,28 @@ export namespace bigtableadmin_v1 {
*/
instance?: Schema$Instance;
/**
- * The ID to be used when referring to the new instance within its project,
- * e.g., just `myinstance` rather than
- * `projects/myproject/instances/myinstance`.
+ * The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`.
*/
instanceId?: string;
/**
- * The unique name of the project in which to create the new instance.
- * Values are of the form `projects/<project>`.
+ * The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`.
*/
parent?: string;
}
/**
- * A collection of Bigtable Tables and the resources that serve them. All
- * tables in an instance are served from all Clusters in the instance.
+ * A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
*/
export interface Schema$Instance {
/**
- * The descriptive name for this instance as it appears in UIs. Can be
- * changed at any time, but should be kept globally unique to avoid
- * confusion.
+ * The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
*/
displayName?: string;
/**
- * Labels are a flexible and lightweight mechanism for organizing cloud
- * resources into groups that reflect a customer's organizational needs
- * and deployment strategies. They can be used to filter resources and
- * aggregate metrics. * Label keys must be between 1 and 63 characters long
- * and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. *
- * Label values must be between 0 and 63 characters long and must conform to
- * the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64
- * labels can be associated with a given resource. * Keys and values must
- * both be under 128 bytes.
+ * Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
*/
labels?: {[key: string]: string};
/**
- * (`OutputOnly`) The unique name of the instance. Values are of the form
- * `projects/<project>/instances/a-z+[a-z0-9]`.
+ * (`OutputOnly`) The unique name of the instance. Values are of the form `projects/<project>/instances/a-z+[a-z0-9]`.
*/
name?: string;
/**
@@ -299,13 +261,11 @@ export namespace bigtableadmin_v1 {
*/
export interface Schema$Location {
/**
- * The friendly name for this location, typically a nearby city name. For
- * example, "Tokyo".
+ * The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string;
/**
- * Cross-service attributes for the location. For example
- * {"cloud.googleapis.com/region": "us-east1"}
+ * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {[key: string]: string};
/**
@@ -313,13 +273,11 @@ export namespace bigtableadmin_v1 {
*/
locationId?: string;
/**
- * Service-specific metadata. For example the available capacity at the
- * given location.
+ * Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {[key: string]: any};
/**
- * Resource name for the location, which may vary between implementations.
- * For example: `"projects/example-project/locations/us-east1"`
+ * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string;
}
@@ -332,8 +290,7 @@ export namespace bigtableadmin_v1 {
*/
instance?: Schema$Instance;
/**
- * The subset of Instance fields which should be replaced. Must be
- * explicitly set.
+ * The subset of Instance fields which should be replaced. Must be explicitly set.
*/
updateMask?: string;
}
@@ -342,9 +299,7 @@ export namespace bigtableadmin_v1 {
*/
export interface Schema$TableProgress {
/**
- * Estimate of the number of bytes copied so far for this table. This will
- * eventually reach 'estimated_size_bytes' unless the table copy is
- * CANCELLED.
+ * Estimate of the number of bytes copied so far for this table. This will eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED.
*/
estimatedCopiedBytes?: string;
/**
@@ -383,8 +338,7 @@ export namespace bigtableadmin_v1 {
*/
finishTime?: string;
/**
- * The request that prompted the initiation of this UpdateInstance
- * operation.
+ * The request that prompted the initiation of this UpdateInstance operation.
*/
originalRequest?: Schema$PartialUpdateInstanceRequest;
/**
diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts
index d215b90f0e7..d4827fb1fc8 100644
--- a/src/apis/bigtableadmin/v2.ts
+++ b/src/apis/bigtableadmin/v2.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace bigtableadmin_v2 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace bigtableadmin_v2 {
*/
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.
+ * 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;
/**
@@ -113,7 +109,10 @@ export namespace bigtableadmin_v2 {
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.operations = new Resource$Operations(this.context);
this.projects = new Resource$Projects(this.context);
@@ -121,8 +120,7 @@ export namespace bigtableadmin_v2 {
}
/**
- * A configuration object describing how Cloud Bigtable should treat traffic
- * from a particular end user application.
+ * A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
*/
export interface Schema$AppProfile {
/**
@@ -130,13 +128,7 @@ export namespace bigtableadmin_v2 {
*/
description?: string;
/**
- * Strongly validated etag for optimistic concurrency control. Preserve the
- * value returned from `GetAppProfile` when calling `UpdateAppProfile` to
- * fail the request if there has been a modification in the mean time. The
- * `update_mask` of the request need not include `etag` for this protection
- * to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
- * [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
- * details.
+ * Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.
*/
etag?: string;
/**
@@ -144,8 +136,7 @@ export namespace bigtableadmin_v2 {
*/
multiClusterRoutingUseAny?: Schema$MultiClusterRoutingUseAny;
/**
- * (`OutputOnly`) The unique name of the app profile. Values are of the form
- * `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
+ * (`OutputOnly`) The unique name of the app profile. Values are of the form `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
*/
name?: string;
/**
@@ -154,27 +145,7 @@ export namespace bigtableadmin_v2 {
singleClusterRouting?: Schema$SingleClusterRouting;
}
/**
- * Specifies the audit configuration for a service. The configuration
- * determines which permission types are logged, and what identities, if any,
- * are exempted from logging. An AuditConfig must have one or more
- * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a
- * specific service, the union of the two AuditConfigs is used for that
- * service: the log_types specified in each AuditConfig are enabled, and the
- * exempted_members in each AuditLogConfig are exempted. Example Policy with
- * multiple AuditConfigs: { "audit_configs": [ {
- * "service": "allServices" "audit_log_configs":
- * [ { "log_type": "DATA_READ",
- * "exempted_members": [ "user:foo@gmail.com" ] }, {
- * "log_type": "DATA_WRITE", }, {
- * "log_type": "ADMIN_READ", } ] },
- * { "service": "fooservice.googleapis.com"
- * "audit_log_configs": [ { "log_type":
- * "DATA_READ", }, { "log_type":
- * "DATA_WRITE", "exempted_members": [
- * "user:bar@gmail.com" ] } ] }
- * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and
- * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging,
- * and bar@gmail.com from DATA_WRITE logging.
+ * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
@@ -182,25 +153,16 @@ export namespace bigtableadmin_v2 {
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
- * Specifies a service that will be enabled for audit logging. For example,
- * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a
- * special value that covers all services.
+ * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string;
}
/**
- * Provides the configuration for logging a type of permissions. Example: {
- * "audit_log_configs": [ { "log_type":
- * "DATA_READ", "exempted_members": [
- * "user:foo@gmail.com" ] }, {
- * "log_type": "DATA_WRITE", } ] } This
- * enables 'DATA_READ' and 'DATA_WRITE' logging, while
- * exempting foo@gmail.com from DATA_READ logging.
+ * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
- * Specifies the identities that do not cause logging for this type of
- * permission. Follows the same format of Binding.members.
+ * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[];
/**
@@ -213,36 +175,20 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$Binding {
/**
- * The condition that is associated with this binding. NOTE: An unsatisfied
- * condition will not allow user access via current binding. Different
- * bindings, including their conditions, are examined independently.
+ * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
*/
condition?: Schema$Expr;
/**
- * Specifies the identities requesting access for a Cloud Platform resource.
- * `members` can have the following values: * `allUsers`: A special
- * identifier that represents anyone who is on the internet; with or
- * without a Google account. * `allAuthenticatedUsers`: A special
- * identifier that represents anyone who is authenticated with a Google
- * account or a service account. * `user:{emailid}`: An email address that
- * represents a specific Google account. For example, `alice@gmail.com` .
- * * `serviceAccount:{emailid}`: An email address that represents a service
- * account. For example, `my-other-app@appspot.gserviceaccount.com`. *
- * `group:{emailid}`: An email address that represents a Google group. For
- * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
- * (primary) that represents all the users of that domain. For example,
- * `google.com` or `example.com`.
+ * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[];
/**
- * Role that is assigned to `members`. For example, `roles/viewer`,
- * `roles/editor`, or `roles/owner`.
+ * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string;
}
/**
- * Request message for
- * google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
+ * Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
*/
export interface Schema$CheckConsistencyRequest {
/**
@@ -251,41 +197,32 @@ export namespace bigtableadmin_v2 {
consistencyToken?: string;
}
/**
- * Response message for
- * google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
+ * Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
*/
export interface Schema$CheckConsistencyResponse {
/**
- * True only if the token is consistent. A token is consistent if
- * replication has caught up with the restrictions specified in the request.
+ * True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.
*/
consistent?: boolean;
}
/**
- * A resizable group of nodes in a particular cloud location, capable of
- * serving all Tables in the parent Instance.
+ * A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
*/
export interface Schema$Cluster {
/**
- * (`CreationOnly`) The type of storage used by this cluster to serve its
- * parent instance's tables, unless explicitly overridden.
+ * (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
*/
defaultStorageType?: string;
/**
- * (`CreationOnly`) The location where this cluster's nodes and storage
- * reside. For best performance, clients should be located as close as
- * possible to this cluster. Currently only zones are supported, so values
- * should be of the form `projects/<project>/locations/<zone>`.
+ * (`CreationOnly`) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`.
*/
location?: string;
/**
- * (`OutputOnly`) The unique name of the cluster. Values are of the form
- * `projects/<project>/instances/<instance>/clusters/a-z*`.
+ * (`OutputOnly`) The unique name of the cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/a-z*`.
*/
name?: string;
/**
- * The number of nodes allocated to this cluster. More nodes enable higher
- * throughput and more consistent performance.
+ * The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
*/
serveNodes?: number;
/**
@@ -307,10 +244,7 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$ColumnFamily {
/**
- * Garbage collection rule specified as a protobuf. Must serialize to at
- * most 500 bytes. NOTE: Garbage collection executes opportunistically in
- * the background, and so it's possible for reads to return a cell even
- * if it matches the active GC expression for its family.
+ * Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
*/
gcRule?: Schema$GcRule;
}
@@ -331,13 +265,7 @@ export namespace bigtableadmin_v2 {
*/
requestTime?: string;
/**
- * Keys: the full `name` of each table that existed in the instance when
- * CreateCluster was first called, i.e.
- * `projects/<project>/instances/<instance>/tables/<table>`.
- * Any table added to the instance by a later API call will be created in
- * the new cluster by that API call, not this one. Values: information on
- * how much of a table's data has been copied to the newly-created
- * cluster so far.
+ * Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects/<project>/instances/<instance>/tables/<table>`. Any table added to the instance by a later API call will be created in the new cluster by that API call, not this one. Values: information on how much of a table's data has been copied to the newly-created cluster so far.
*/
tables?: {[key: string]: Schema$TableProgress};
}
@@ -350,15 +278,11 @@ export namespace bigtableadmin_v2 {
*/
cluster?: Schema$Cluster;
/**
- * The ID to be used when referring to the new cluster within its instance,
- * e.g., just `mycluster` rather than
- * `projects/myproject/instances/myinstance/clusters/mycluster`.
+ * The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`.
*/
clusterId?: string;
/**
- * The unique name of the instance in which to create the new cluster.
- * Values are of the form
- * `projects/<project>/instances/<instance>`.
+ * The unique name of the instance in which to create the new cluster. Values are of the form `projects/<project>/instances/<instance>`.
*/
parent?: string;
}
@@ -371,8 +295,7 @@ export namespace bigtableadmin_v2 {
*/
finishTime?: string;
/**
- * The request that prompted the initiation of this CreateInstance
- * operation.
+ * The request that prompted the initiation of this CreateInstance operation.
*/
originalRequest?: Schema$CreateInstanceRequest;
/**
@@ -385,11 +308,7 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$CreateInstanceRequest {
/**
- * The clusters to be created within the instance, mapped by desired cluster
- * ID, e.g., just `mycluster` rather than
- * `projects/myproject/instances/myinstance/clusters/mycluster`. Fields
- * marked `OutputOnly` must be left blank. Currently, at most two clusters
- * can be specified.
+ * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most two clusters can be specified.
*/
clusters?: {[key: string]: Schema$Cluster};
/**
@@ -397,14 +316,11 @@ export namespace bigtableadmin_v2 {
*/
instance?: Schema$Instance;
/**
- * The ID to be used when referring to the new instance within its project,
- * e.g., just `myinstance` rather than
- * `projects/myproject/instances/myinstance`.
+ * The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`.
*/
instanceId?: string;
/**
- * The unique name of the project in which to create the new instance.
- * Values are of the form `projects/<project>`.
+ * The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`.
*/
parent?: string;
}
@@ -413,20 +329,7 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$CreateTableRequest {
/**
- * The optional list of row keys that will be used to initially split the
- * table into several tablets (tablets are similar to HBase regions). Given
- * two split keys, `s1` and `s2`, three tablets will be created, spanning
- * the key ranges: `[, s1), [s1, s2), [s2, )`. Example: * Row keys :=
- * `["a", "apple", "custom",
- * "customer_1", "customer_2",` `"other",
- * "zz"]` * initial_split_keys := `["apple",
- * "customer_1", "customer_2", "other"]` * Key
- * assignment: - Tablet 1 `[, apple) =>
- * {"a"}.` - Tablet 2 `[apple, customer_1) =>
- * {"apple", "custom"}.` - Tablet 3 `[customer_1,
- * customer_2) => {"customer_1"}.` - Tablet 4 `[customer_2,
- * other) => {"customer_2"}.` - Tablet 5 `[other, )
- * => {"other", "zz"}.`
+ * The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, `s1` and `s2`, three tablets will be created, spanning the key ranges: `[, s1), [s1, s2), [s2, )`. Example: * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",` `"other", "zz"]` * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]` * Key assignment: - Tablet 1 `[, apple) => {"a"}.` - Tablet 2 `[apple, customer_1) => {"apple", "custom"}.` - Tablet 3 `[customer_1, customer_2) => {"customer_1"}.` - Tablet 4 `[customer_2, other) => {"customer_2"}.` - Tablet 5 `[other, ) => {"other", "zz"}.`
*/
initialSplits?: Schema$Split[];
/**
@@ -434,14 +337,12 @@ export namespace bigtableadmin_v2 {
*/
table?: Schema$Table;
/**
- * The name by which the new table should be referred to within the parent
- * instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
+ * The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
*/
tableId?: string;
}
/**
- * Request message for
- * google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
+ * Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
*/
export interface Schema$DropRowRangeRequest {
/**
@@ -449,45 +350,32 @@ export namespace bigtableadmin_v2 {
*/
deleteAllDataFromTable?: boolean;
/**
- * Delete all rows that start with this row key prefix. Prefix cannot be
- * zero length.
+ * Delete all rows that start with this row key prefix. Prefix cannot be zero length.
*/
rowKeyPrefix?: string;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
- * Represents an expression text. Example: title: "User account
- * presence" description: "Determines whether the request has a
- * user account" expression: "size(request.user) > 0"
+ * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
*/
export interface Schema$Expr {
/**
- * An optional description of the expression. This is a longer text which
- * describes the expression, e.g. when hovered over it in a UI.
+ * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string;
/**
- * Textual representation of an expression in Common Expression Language
- * syntax. The application context of the containing message determines
- * which well-known feature set of CEL is supported.
+ * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
*/
expression?: string;
/**
- * An optional string indicating the location of the expression for error
- * reporting, e.g. a file name and a position in the file.
+ * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string;
/**
- * An optional title for the expression, i.e. a short string describing its
- * purpose. This can be used e.g. in UIs which allow to enter the
- * expression.
+ * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string;
}
@@ -500,8 +388,7 @@ export namespace bigtableadmin_v2 {
*/
intersection?: Schema$Intersection;
/**
- * Delete cells in a column older than the given age. Values must be at
- * least one millisecond, and will be truncated to microsecond granularity.
+ * Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
*/
maxAge?: string;
/**
@@ -514,13 +401,11 @@ export namespace bigtableadmin_v2 {
union?: Schema$Union;
}
/**
- * Request message for
- * google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
+ * Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
*/
export interface Schema$GenerateConsistencyTokenRequest {}
/**
- * Response message for
- * google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
+ * Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
*/
export interface Schema$GenerateConsistencyTokenResponse {
/**
@@ -533,31 +418,19 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$GetIamPolicyRequest {}
/**
- * A collection of Bigtable Tables and the resources that serve them. All
- * tables in an instance are served from all Clusters in the instance.
+ * A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
*/
export interface Schema$Instance {
/**
- * The descriptive name for this instance as it appears in UIs. Can be
- * changed at any time, but should be kept globally unique to avoid
- * confusion.
+ * The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
*/
displayName?: string;
/**
- * Labels are a flexible and lightweight mechanism for organizing cloud
- * resources into groups that reflect a customer's organizational needs
- * and deployment strategies. They can be used to filter resources and
- * aggregate metrics. * Label keys must be between 1 and 63 characters long
- * and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. *
- * Label values must be between 0 and 63 characters long and must conform to
- * the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64
- * labels can be associated with a given resource. * Keys and values must
- * both be under 128 bytes.
+ * Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
*/
labels?: {[key: string]: string};
/**
- * (`OutputOnly`) The unique name of the instance. Values are of the form
- * `projects/<project>/instances/a-z+[a-z0-9]`.
+ * (`OutputOnly`) The unique name of the instance. Values are of the form `projects/<project>/instances/a-z+[a-z0-9]`.
*/
name?: string;
/**
@@ -587,16 +460,11 @@ export namespace bigtableadmin_v2 {
*/
appProfiles?: Schema$AppProfile[];
/**
- * Locations from which AppProfile information could not be retrieved, due
- * to an outage or some other transient condition. AppProfiles from these
- * locations may be missing from `app_profiles`. Values are of the form
- * `projects/<project>/locations/<zone_id>`
+ * Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from `app_profiles`. Values are of the form `projects/<project>/locations/<zone_id>`
*/
failedLocations?: string[];
/**
- * Set if not all app profiles could be returned in a single response. Pass
- * this value to `page_token` in another request to get the next page of
- * results.
+ * Set if not all app profiles could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.
*/
nextPageToken?: string;
}
@@ -609,11 +477,7 @@ export namespace bigtableadmin_v2 {
*/
clusters?: Schema$Cluster[];
/**
- * Locations from which Cluster information could not be retrieved, due to
- * an outage or some other transient condition. Clusters from these
- * locations may be missing from `clusters`, or may only have partial
- * information returned. Values are of the form
- * `projects/<project>/locations/<zone_id>`
+ * Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from `clusters`, or may only have partial information returned. Values are of the form `projects/<project>/locations/<zone_id>`
*/
failedLocations?: string[];
/**
@@ -626,12 +490,7 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$ListInstancesResponse {
/**
- * Locations from which Instance information could not be retrieved, due to
- * an outage or some other transient condition. Instances whose Clusters are
- * all in one of the failed locations may be missing from `instances`, and
- * Instances with at least one Cluster in a failed location may only have
- * partial information returned. Values are of the form
- * `projects/<project>/locations/<zone_id>`
+ * Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from `instances`, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form `projects/<project>/locations/<zone_id>`
*/
failedLocations?: string[];
/**
@@ -661,8 +520,7 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$ListTablesResponse {
/**
- * Set if not all tables could be returned in a single response. Pass this
- * value to `page_token` in another request to get the next page of results.
+ * Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.
*/
nextPageToken?: string;
/**
@@ -675,13 +533,11 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$Modification {
/**
- * Create a new column family with the specified schema, or fail if one
- * already exists with the given ID.
+ * Create a new column family with the specified schema, or fail if one already exists with the given ID.
*/
create?: Schema$ColumnFamily;
/**
- * Drop (delete) the column family with the given ID, or fail if no such
- * family exists.
+ * Drop (delete) the column family with the given ID, or fail if no such family exists.
*/
drop?: boolean;
/**
@@ -689,40 +545,29 @@ export namespace bigtableadmin_v2 {
*/
id?: string;
/**
- * Update an existing column family to the specified schema, or fail if no
- * column family exists with the given ID.
+ * Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
*/
update?: Schema$ColumnFamily;
}
/**
- * Request message for
- * google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
+ * Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
*/
export interface Schema$ModifyColumnFamiliesRequest {
/**
- * Modifications to be atomically applied to the specified table's
- * families. Entries are applied in order, meaning that earlier
- * modifications can be masked by later ones (in the case of repeated
- * updates to the same family, for example).
+ * Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).
*/
modifications?: Schema$Modification[];
}
/**
- * Read/write requests may be routed to any cluster in the instance, and will
- * fail over to another cluster in the event of transient errors or delays.
- * Choosing this option sacrifices read-your-writes consistency to improve
- * availability.
+ * Read/write requests may be routed to any cluster in the instance, and will fail over to another cluster in the event of transient errors or delays. Choosing this option sacrifices read-your-writes consistency to improve availability.
*/
export interface Schema$MultiClusterRoutingUseAny {}
/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
+ * This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
- * If the value is `false`, it means the operation is still in progress. If
- * `true`, the operation is completed, and either `error` or `response` is
- * available.
+ * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean;
/**
@@ -730,26 +575,15 @@ export namespace bigtableadmin_v2 {
*/
error?: Schema$Status;
/**
- * Service-specific metadata associated with the operation. It typically
- * contains progress information and common metadata such as create time.
- * Some services might not provide such metadata. Any method that returns a
- * long-running operation should document the metadata type, if any.
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any};
/**
- * The server-assigned name, which is only unique within the same service
- * that originally returns it. If you use the default HTTP mapping, the
- * `name` should have the format of `operations/some/unique/name`.
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
*/
name?: string;
/**
- * The normal response of the operation in case of success. If the original
- * method returns no data on success, such as `Delete`, the response is
- * `google.protobuf.Empty`. If the original method is standard
- * `Get`/`Create`/`Update`, the response should be the resource. For other
- * methods, the response should have the type `XxxResponse`, where `Xxx` is
- * the original method name. For example, if the original method name is
- * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {[key: string]: any};
}
@@ -762,30 +596,12 @@ export namespace bigtableadmin_v2 {
*/
instance?: Schema$Instance;
/**
- * The subset of Instance fields which should be replaced. Must be
- * explicitly set.
+ * The subset of Instance fields which should be replaced. Must be explicitly set.
*/
updateMask?: string;
}
/**
- * Defines an Identity and Access Management (IAM) policy. It is used to
- * specify access control policies for Cloud Platform resources. A `Policy`
- * consists of a list of `bindings`. A `binding` binds a list of `members` to
- * a `role`, where the members can be user accounts, Google groups, Google
- * domains, and service accounts. A `role` is a named list of permissions
- * defined by IAM. **JSON Example** { "bindings": [ {
- * "role": "roles/owner", "members": [
- * "user:mike@example.com", "group:admins@example.com",
- * "domain:google.com",
- * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, {
- * "role": "roles/viewer", "members":
- * ["user:sean@example.com"] } ] } **YAML
- * Example** bindings: - members: - user:mike@example.com -
- * group:admins@example.com - domain:google.com -
- * serviceAccount:my-other-app@appspot.gserviceaccount.com role:
- * roles/owner - members: - user:sean@example.com role:
- * roles/viewer For a description of IAM and its features, see the [IAM
- * developer's guide](https://cloud.google.com/iam/docs).
+ * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
*/
export interface Schema$Policy {
/**
@@ -793,20 +609,11 @@ export namespace bigtableadmin_v2 {
*/
auditConfigs?: Schema$AuditConfig[];
/**
- * Associates a list of `members` to a `role`. `bindings` with no members
- * will result in an error.
+ * Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
*/
bindings?: Schema$Binding[];
/**
- * `etag` is used for optimistic concurrency control as a way to help
- * prevent simultaneous updates of a policy from overwriting each other. It
- * is strongly suggested that systems make use of the `etag` in the
- * read-modify-write cycle to perform policy updates in order to avoid race
- * conditions: An `etag` is returned in the response to `getIamPolicy`, and
- * systems are expected to put that etag in the request to `setIamPolicy` to
- * ensure that their change will be applied to the same version of the
- * policy. If no `etag` is provided in the call to `setIamPolicy`, then the
- * existing policy is overwritten blindly.
+ * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
*/
etag?: string;
/**
@@ -819,30 +626,20 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$SetIamPolicyRequest {
/**
- * REQUIRED: The complete policy to be applied to the `resource`. The size
- * of the policy is limited to a few 10s of KB. An empty policy is a valid
- * policy but certain Cloud Platform services (such as Projects) might
- * reject them.
+ * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
*/
policy?: Schema$Policy;
/**
- * OPTIONAL: A FieldMask specifying which fields of the policy to modify.
- * Only the fields in the mask will be modified. If no mask is provided, the
- * following default mask is used: paths: "bindings, etag" This
- * field is only used by Cloud IAM.
+ * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM.
*/
updateMask?: string;
}
/**
- * Unconditionally routes all read/write requests to a specific cluster. This
- * option preserves read-your-writes consistency, but does not improve
- * availability.
+ * Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency, but does not improve availability.
*/
export interface Schema$SingleClusterRouting {
/**
- * Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
- * allowed by this app profile. It is unsafe to send these requests to the
- * same table/row/column in multiple clusters.
+ * Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
*/
allowTransactionalWrites?: boolean;
/**
@@ -860,40 +657,7 @@ export namespace bigtableadmin_v2 {
key?: string;
}
/**
- * The `Status` type defines a logical error model that is suitable for
- * different programming environments, including REST APIs and RPC APIs. It is
- * used by [gRPC](https://github.com/grpc). The error model is designed to be:
- * - Simple to use and understand for most users - Flexible enough to meet
- * unexpected needs # Overview The `Status` message contains three pieces of
- * data: error code, error message, and error details. The error code should
- * be an enum value of google.rpc.Code, but it may accept additional error
- * codes if needed. The error message should be a developer-facing English
- * message that helps developers *understand* and *resolve* the error. If a
- * localized user-facing error message is needed, put the localized message in
- * the error details or localize it in the client. The optional error details
- * may contain arbitrary information about the error. There is a predefined
- * set of error detail types in the package `google.rpc` that can be used for
- * common error conditions. # Language mapping The `Status` message is the
- * logical representation of the error model, but it is not necessarily the
- * actual wire format. When the `Status` message is exposed in different
- * client libraries and different wire protocols, it can be mapped
- * differently. For example, it will likely be mapped to some exceptions in
- * Java, but more likely mapped to some error codes in C. # Other uses The
- * error model and the `Status` message can be used in a variety of
- * environments, either with or without APIs, to provide a consistent
- * developer experience across different environments. Example uses of this
- * error model include: - Partial errors. If a service needs to return
- * partial errors to the client, it may embed the `Status` in the normal
- * response to indicate the partial errors. - Workflow errors. A typical
- * workflow has multiple steps. Each step may have a `Status` message for
- * error reporting. - Batch operations. If a client uses batch request and
- * batch response, the `Status` message should be used directly inside
- * batch response, one for each error sub-response. - Asynchronous
- * operations. If an API call embeds asynchronous operation results in its
- * response, the status of those operations should be represented directly
- * using the `Status` message. - Logging. If some API errors are stored in
- * logs, the message `Status` could be used directly after any stripping
- * needed for security/privacy reasons.
+ * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
@@ -901,46 +665,32 @@ export namespace bigtableadmin_v2 {
*/
code?: number;
/**
- * A list of messages that carry the error details. There is a common set
- * of message types for APIs to use.
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}>;
/**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
- * A collection of user data indexed by row, column, and timestamp. Each table
- * is served using the resources of its parent cluster.
+ * A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
*/
export interface Schema$Table {
/**
- * Output only. Map from cluster ID to per-cluster table state. If it could
- * not be determined whether or not the table has data in a particular
- * cluster (for example, if its zone is unavailable), then there will be an
- * entry for the cluster with UNKNOWN `replication_status`. Views:
- * `REPLICATION_VIEW`, `FULL`
+ * Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `FULL`
*/
clusterStates?: {[key: string]: Schema$ClusterState};
/**
- * (`CreationOnly`) The column families configured for this table, mapped by
- * column family ID. Views: `SCHEMA_VIEW`, `FULL`
+ * (`CreationOnly`) The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
*/
columnFamilies?: {[key: string]: Schema$ColumnFamily};
/**
- * (`CreationOnly`) The granularity (i.e. `MILLIS`) at which timestamps are
- * stored in this table. Timestamps not matching the granularity will be
- * rejected. If unspecified at creation time, the value will be set to
- * `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.
+ * (`CreationOnly`) The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.
*/
granularity?: string;
/**
- * Output only. The unique name of the table. Values are of the form
- * `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
- * Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
+ * Output only. The unique name of the table. Values are of the form `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
*/
name?: string;
}
@@ -949,9 +699,7 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$TableProgress {
/**
- * Estimate of the number of bytes copied so far for this table. This will
- * eventually reach 'estimated_size_bytes' unless the table copy is
- * CANCELLED.
+ * Estimate of the number of bytes copied so far for this table. This will eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED.
*/
estimatedCopiedBytes?: string;
/**
@@ -965,10 +713,7 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$TestIamPermissionsRequest {
/**
- * The set of permissions to check for the `resource`. Permissions with
- * wildcards (such as '*' or 'storage.*') are not allowed.
- * For more information see [IAM
- * Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[];
}
@@ -977,8 +722,7 @@ export namespace bigtableadmin_v2 {
*/
export interface Schema$TestIamPermissionsResponse {
/**
- * A subset of `TestPermissionsRequest.permissions` that the caller is
- * allowed.
+ * A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
*/
permissions?: string[];
}
@@ -1021,8 +765,7 @@ export namespace bigtableadmin_v2 {
*/
finishTime?: string;
/**
- * The request that prompted the initiation of this UpdateInstance
- * operation.
+ * The request that prompted the initiation of this UpdateInstance operation.
*/
originalRequest?: Schema$PartialUpdateInstanceRequest;
/**
@@ -1041,15 +784,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.operations.cancel
- * @desc Starts asynchronous cancellation on a long-running operation. The
- * server makes a best effort to cancel the operation, but success is not
- * guaranteed. If the server doesn't support this method, it returns
- * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
- * or other methods to check whether the cancellation succeeded or whether
- * the operation completed despite cancellation. On successful cancellation,
- * the operation is not deleted; instead, it becomes an operation with an
- * Operation.error value with a google.rpc.Status.code of 1, corresponding
- * to `Code.CANCELLED`.
+ * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* @alias bigtableadmin.operations.cancel
* @memberOf! ()
*
@@ -1119,10 +854,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.operations.delete
- * @desc Deletes a long-running operation. This method indicates that the
- * client is no longer interested in the operation result. It does not
- * cancel the operation. If the server doesn't support this method, it
- * returns `google.rpc.Code.UNIMPLEMENTED`.
+ * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
* @alias bigtableadmin.operations.delete
* @memberOf! ()
*
@@ -1192,9 +924,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.operations.get
- * @desc Gets the latest state of a long-running operation. Clients can use
- * this method to poll the operation result at intervals as recommended by
- * the API service.
+ * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias bigtableadmin.operations.get
* @memberOf! ()
*
@@ -1319,15 +1049,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.operations.projects.operations.list
- * @desc Lists operations that match the specified filter in the request. If
- * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE:
- * the `name` binding allows API services to override the binding to use
- * different resource name schemes, such as `users/x/operations`. To
- * override the binding, API services can add a binding such as
- * `"/v1/{name=users/x}/operations"` to their service configuration. For
- * backwards compatibility, the default name includes the operations
- * collection id, however overriding users must ensure the name binding is
- * the parent resource, without the operations collection id.
+ * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @alias bigtableadmin.operations.projects.operations.list
* @memberOf! ()
*
@@ -1672,8 +1394,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.getIamPolicy
- * @desc Gets the access control policy for an instance resource. Returns an
- * empty policy if an instance exists but does not have a policy set.
+ * @desc Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
* @alias bigtableadmin.projects.instances.getIamPolicy
* @memberOf! ()
*
@@ -1825,9 +1546,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.partialUpdateInstance
- * @desc Partially updates an instance within a project. This method can
- * modify all fields of an Instance and is the preferred way to update an
- * Instance.
+ * @desc Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
* @alias bigtableadmin.projects.instances.partialUpdateInstance
* @memberOf! ()
*
@@ -1903,8 +1622,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.setIamPolicy
- * @desc Sets the access control policy on an instance resource. Replaces
- * any existing policy.
+ * @desc Sets the access control policy on an instance resource. Replaces any existing policy.
* @alias bigtableadmin.projects.instances.setIamPolicy
* @memberOf! ()
*
@@ -1978,8 +1696,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.testIamPermissions
- * @desc Returns permissions that the caller has on the specified instance
- * resource.
+ * @desc Returns permissions that the caller has on the specified instance resource.
* @alias bigtableadmin.projects.instances.testIamPermissions
* @memberOf! ()
*
@@ -2062,9 +1779,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.update
- * @desc Updates an instance within a project. This method updates only the
- * display name and type for an Instance. To update other Instance
- * properties, such as labels, use PartialUpdateInstance.
+ * @desc Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.
* @alias bigtableadmin.projects.instances.update
* @memberOf! ()
*
@@ -2142,8 +1857,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the project in which to create the new instance.
- * Values are of the form `projects/`.
+ * The unique name of the project in which to create the new instance. Values are of the form `projects/`.
*/
parent?: string;
@@ -2160,8 +1874,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the instance to be deleted. Values are of the form
- * `projects//instances/`.
+ * The unique name of the instance to be deleted. Values are of the form `projects//instances/`.
*/
name?: string;
}
@@ -2173,8 +1886,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the requested instance. Values are of the form
- * `projects//instances/`.
+ * The unique name of the requested instance. Values are of the form `projects//instances/`.
*/
name?: string;
}
@@ -2186,8 +1898,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy is being requested. See the
- * operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
@@ -2208,8 +1919,7 @@ export namespace bigtableadmin_v2 {
*/
pageToken?: string;
/**
- * The unique name of the project for which a list of instances is
- * requested. Values are of the form `projects/`.
+ * The unique name of the project for which a list of instances is requested. Values are of the form `projects/`.
*/
parent?: string;
}
@@ -2221,13 +1931,11 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * (`OutputOnly`) The unique name of the instance. Values are of the form
- * `projects//instances/a-z+[a-z0-9]`.
+ * (`OutputOnly`) The unique name of the instance. Values are of the form `projects//instances/a-z+[a-z0-9]`.
*/
name?: string;
/**
- * The subset of Instance fields which should be replaced. Must be
- * explicitly set.
+ * The subset of Instance fields which should be replaced. Must be explicitly set.
*/
updateMask?: string;
@@ -2244,8 +1952,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy is being specified. See the
- * operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
@@ -2262,8 +1969,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy detail is being requested.
- * See the operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
@@ -2280,8 +1986,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * (`OutputOnly`) The unique name of the instance. Values are of the form
- * `projects//instances/a-z+[a-z0-9]`.
+ * (`OutputOnly`) The unique name of the instance. Values are of the form `projects//instances/a-z+[a-z0-9]`.
*/
name?: string;
@@ -2681,9 +2386,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The ID to be used when referring to the new app profile within its
- * instance, e.g., just `myprofile` rather than
- * `projects/myproject/instances/myinstance/appProfiles/myprofile`.
+ * The ID to be used when referring to the new app profile within its instance, e.g., just `myprofile` rather than `projects/myproject/instances/myinstance/appProfiles/myprofile`.
*/
appProfileId?: string;
/**
@@ -2691,8 +2394,7 @@ export namespace bigtableadmin_v2 {
*/
ignoreWarnings?: boolean;
/**
- * The unique name of the instance in which to create the new app profile.
- * Values are of the form `projects//instances/`.
+ * The unique name of the instance in which to create the new app profile. Values are of the form `projects//instances/`.
*/
parent?: string;
@@ -2713,8 +2415,7 @@ export namespace bigtableadmin_v2 {
*/
ignoreWarnings?: boolean;
/**
- * The unique name of the app profile to be deleted. Values are of the form
- * `projects//instances//appProfiles/`.
+ * The unique name of the app profile to be deleted. Values are of the form `projects//instances//appProfiles/`.
*/
name?: string;
}
@@ -2726,8 +2427,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the requested app profile. Values are of the form
- * `projects//instances//appProfiles/`.
+ * The unique name of the requested app profile. Values are of the form `projects//instances//appProfiles/`.
*/
name?: string;
}
@@ -2747,11 +2447,7 @@ export namespace bigtableadmin_v2 {
*/
pageToken?: string;
/**
- * The unique name of the instance for which a list of app profiles is
- * requested. Values are of the form
- * `projects//instances/`. Use ` = '-'` to list
- * AppProfiles for all Instances in a project, e.g.,
- * `projects/myproject/instances/-`.
+ * The unique name of the instance for which a list of app profiles is requested. Values are of the form `projects//instances/`. Use ` = '-'` to list AppProfiles for all Instances in a project, e.g., `projects/myproject/instances/-`.
*/
parent?: string;
}
@@ -2767,13 +2463,11 @@ export namespace bigtableadmin_v2 {
*/
ignoreWarnings?: boolean;
/**
- * (`OutputOnly`) The unique name of the app profile. Values are of the form
- * `projects//instances//appProfiles/_a-zA-Z0-9*`.
+ * (`OutputOnly`) The unique name of the app profile. Values are of the form `projects//instances//appProfiles/_a-zA-Z0-9*`.
*/
name?: string;
/**
- * The subset of app profile fields which should be replaced. If unset, all
- * fields will be replaced.
+ * The subset of app profile fields which should be replaced. If unset, all fields will be replaced.
*/
updateMask?: string;
@@ -3166,14 +2860,11 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The ID to be used when referring to the new cluster within its instance,
- * e.g., just `mycluster` rather than
- * `projects/myproject/instances/myinstance/clusters/mycluster`.
+ * The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`.
*/
clusterId?: string;
/**
- * The unique name of the instance in which to create the new cluster.
- * Values are of the form `projects//instances/`.
+ * The unique name of the instance in which to create the new cluster. Values are of the form `projects//instances/`.
*/
parent?: string;
@@ -3190,8 +2881,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the cluster to be deleted. Values are of the form
- * `projects//instances//clusters/`.
+ * The unique name of the cluster to be deleted. Values are of the form `projects//instances//clusters/`.
*/
name?: string;
}
@@ -3203,8 +2893,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the requested cluster. Values are of the form
- * `projects//instances//clusters/`.
+ * The unique name of the requested cluster. Values are of the form `projects//instances//clusters/`.
*/
name?: string;
}
@@ -3220,11 +2909,7 @@ export namespace bigtableadmin_v2 {
*/
pageToken?: string;
/**
- * The unique name of the instance for which a list of clusters is
- * requested. Values are of the form
- * `projects//instances/`. Use ` = '-'` to list
- * Clusters for all Instances in a project, e.g.,
- * `projects/myproject/instances/-`.
+ * The unique name of the instance for which a list of clusters is requested. Values are of the form `projects//instances/`. Use ` = '-'` to list Clusters for all Instances in a project, e.g., `projects/myproject/instances/-`.
*/
parent?: string;
}
@@ -3236,8 +2921,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * (`OutputOnly`) The unique name of the cluster. Values are of the form
- * `projects//instances//clusters/a-z*`.
+ * (`OutputOnly`) The unique name of the cluster. Values are of the form `projects//instances//clusters/a-z*`.
*/
name?: string;
@@ -3255,9 +2939,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.tables.checkConsistency
- * @desc Checks replication consistency based on a consistency token, that
- * is, if replication has caught up based on the conditions specified in the
- * token and the check request.
+ * @desc Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
* @alias bigtableadmin.projects.instances.tables.checkConsistency
* @memberOf! ()
*
@@ -3337,9 +3019,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.tables.create
- * @desc Creates a new table in the specified instance. The table can be
- * created with a full set of initial column families, specified in the
- * request.
+ * @desc Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
* @alias bigtableadmin.projects.instances.tables.create
* @memberOf! ()
*
@@ -3483,9 +3163,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.tables.dropRowRange
- * @desc Permanently drop/delete a row range from a specified table. The
- * request can specify whether to delete all rows in a table, or only those
- * that match a particular prefix.
+ * @desc Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.
* @alias bigtableadmin.projects.instances.tables.dropRowRange
* @memberOf! ()
*
@@ -3559,10 +3237,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.tables.generateConsistencyToken
- * @desc Generates a consistency token for a Table, which can be used in
- * CheckConsistency to check whether mutations to the table that finished
- * before this call started have been replicated. The tokens will be
- * available for 90 days.
+ * @desc Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
* @alias bigtableadmin.projects.instances.tables.generateConsistencyToken
* @memberOf! ()
*
@@ -3718,8 +3393,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.tables.getIamPolicy
- * @desc Gets the access control policy for an instance resource. Returns an
- * empty policy if an table exists but does not have a policy set.
+ * @desc Gets the access control policy for an instance resource. Returns an empty policy if an table exists but does not have a policy set.
* @alias bigtableadmin.projects.instances.tables.getIamPolicy
* @memberOf! ()
*
@@ -3871,10 +3545,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.tables.modifyColumnFamilies
- * @desc Performs a series of column family modifications on the specified
- * table. Either all or none of the modifications will occur before this
- * method returns, but data requests received prior to that point may see a
- * table where only some modifications have taken effect.
+ * @desc Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
* @alias bigtableadmin.projects.instances.tables.modifyColumnFamilies
* @memberOf! ()
*
@@ -3948,8 +3619,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.tables.setIamPolicy
- * @desc Sets the access control policy on a table resource. Replaces any
- * existing policy.
+ * @desc Sets the access control policy on a table resource. Replaces any existing policy.
* @alias bigtableadmin.projects.instances.tables.setIamPolicy
* @memberOf! ()
*
@@ -4023,8 +3693,7 @@ export namespace bigtableadmin_v2 {
/**
* bigtableadmin.projects.instances.tables.testIamPermissions
- * @desc Returns permissions that the caller has on the specified table
- * resource.
+ * @desc Returns permissions that the caller has on the specified table resource.
* @alias bigtableadmin.projects.instances.tables.testIamPermissions
* @memberOf! ()
*
@@ -4114,9 +3783,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the Table for which to check replication consistency.
- * Values are of the form
- * `projects//instances//tables/`.
+ * The unique name of the Table for which to check replication consistency. Values are of the form `projects//instances//tables/`.
*/
name?: string;
@@ -4133,8 +3800,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the instance in which to create the table. Values are
- * of the form `projects//instances/`.
+ * The unique name of the instance in which to create the table. Values are of the form `projects//instances/`.
*/
parent?: string;
@@ -4151,8 +3817,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the table to be deleted. Values are of the form
- * `projects//instances//tables/`.
+ * The unique name of the table to be deleted. Values are of the form `projects//instances//tables/`.
*/
name?: string;
}
@@ -4164,8 +3829,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the table on which to drop a range of rows. Values are
- * of the form `projects//instances//tables/`.
+ * The unique name of the table on which to drop a range of rows. Values are of the form `projects//instances//tables/`.
*/
name?: string;
@@ -4182,9 +3846,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the Table for which to create a consistency token.
- * Values are of the form
- * `projects//instances//tables/`.
+ * The unique name of the Table for which to create a consistency token. Values are of the form `projects//instances//tables/`.
*/
name?: string;
@@ -4201,13 +3863,11 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the requested table. Values are of the form
- * `projects//instances//tables/`.
+ * The unique name of the requested table. Values are of the form `projects//instances//tables/`.
*/
name?: string;
/**
- * The view to be applied to the returned table's fields. Defaults to
- * `SCHEMA_VIEW` if unspecified.
+ * The view to be applied to the returned table's fields. Defaults to `SCHEMA_VIEW` if unspecified.
*/
view?: string;
}
@@ -4219,8 +3879,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy is being requested. See the
- * operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
@@ -4237,12 +3896,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Maximum number of results per page. A page_size of zero lets the server
- * choose the number of items to return. A page_size which is strictly
- * positive will return at most that many items. A negative page_size will
- * cause an error. Following the first request, subsequent paginated calls
- * are not required to pass a page_size. If a page_size is set in subsequent
- * calls, it must match the page_size given in the first request.
+ * Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
*/
pageSize?: number;
/**
@@ -4250,13 +3904,11 @@ export namespace bigtableadmin_v2 {
*/
pageToken?: string;
/**
- * The unique name of the instance for which tables should be listed. Values
- * are of the form `projects//instances/`.
+ * The unique name of the instance for which tables should be listed. Values are of the form `projects//instances/`.
*/
parent?: string;
/**
- * The view to be applied to the returned tables' fields. Defaults to
- * `NAME_ONLY` if unspecified; no others are currently supported.
+ * The view to be applied to the returned tables' fields. Defaults to `NAME_ONLY` if unspecified; no others are currently supported.
*/
view?: string;
}
@@ -4268,8 +3920,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The unique name of the table whose families should be modified. Values
- * are of the form `projects//instances//tables/`.
+ * The unique name of the table whose families should be modified. Values are of the form `projects//instances//tables/`.
*/
name?: string;
@@ -4286,8 +3937,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy is being specified. See the
- * operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
@@ -4304,8 +3954,7 @@ export namespace bigtableadmin_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy detail is being requested.
- * See the operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
diff --git a/src/apis/binaryauthorization/package.json b/src/apis/binaryauthorization/package.json
index 01214c751cc..80b4ca480a6 100644
--- a/src/apis/binaryauthorization/package.json
+++ b/src/apis/binaryauthorization/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts
index 707eebe5b4a..c505115100f 100644
--- a/src/apis/binaryauthorization/v1beta1.ts
+++ b/src/apis/binaryauthorization/v1beta1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace binaryauthorization_v1beta1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace binaryauthorization_v1beta1 {
*/
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.
+ * 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;
/**
@@ -95,8 +91,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* Binary Authorization API
*
- * The management interface for Binary Authorization, a system providing
- * policy control for images deployed to Kubernetes Engine clusters.
+ * The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters.
*
* @example
* const {google} = require('googleapis');
@@ -113,18 +108,17 @@ export namespace binaryauthorization_v1beta1 {
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.projects = new Resource$Projects(this.context);
}
}
/**
- * An admission rule specifies either that all container images used in a pod
- * creation request must be attested to by one or more attestors, that all pod
- * creations will be allowed, or that all pod creations will be denied. Images
- * matching an admission whitelist pattern are exempted from admission rules
- * and will never block a pod creation.
+ * An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission whitelist pattern are exempted from admission rules and will never block a pod creation.
*/
export interface Schema$AdmissionRule {
/**
@@ -136,41 +130,29 @@ export namespace binaryauthorization_v1beta1 {
*/
evaluationMode?: string;
/**
- * Optional. The resource names of the attestors that must attest to a
- * container image, in the format `projects/x/attestors/x. Each attestor
- * must exist before a policy can reference it. To add an attestor to a
- * policy the principal issuing the policy change request must be able to
- * read the attestor resource. Note: this field must be non-empty when the
- * evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be
- * empty.
+ * Optional. The resource names of the attestors that must attest to a container image, in the format `projects/x/attestors/x. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty.
*/
requireAttestationsBy?: string[];
}
/**
- * An admission whitelist pattern exempts images from checks by admission
- * rules.
+ * An admission whitelist pattern exempts images from checks by admission rules.
*/
export interface Schema$AdmissionWhitelistPattern {
/**
- * An image name pattern to whitelist, in the form `registry/path/to/image`.
- * This supports a trailing `*` as a wildcard, but this is allowed only in
- * text after the `registry/` part.
+ * An image name pattern to whitelist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part.
*/
namePattern?: string;
}
/**
- * An attestor that attests to container image artifacts. An existing attestor
- * cannot be modified except where indicated.
+ * An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated.
*/
export interface Schema$Attestor {
/**
- * Optional. A descriptive comment. This field may be updated. The field
- * may be displayed in chooser dialogs.
+ * Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs.
*/
description?: string;
/**
- * Required. The resource name, in the format: `projects/x/attestors/x. This
- * field may not be updated.
+ * Required. The resource name, in the format: `projects/x/attestors/x. This field may not be updated.
*/
name?: string;
/**
@@ -183,18 +165,11 @@ export namespace binaryauthorization_v1beta1 {
userOwnedDrydockNote?: Schema$UserOwnedDrydockNote;
}
/**
- * An attestor public key that will be used to verify attestations signed by
- * this attestor.
+ * An attestor public key that will be used to verify attestations signed by this attestor.
*/
export interface Schema$AttestorPublicKey {
/**
- * ASCII-armored representation of a PGP public key, as the entire output by
- * the command `gpg --export --armor foo@example.com` (either LF or CRLF
- * line endings). When using this field, `id` should be left blank. The
- * BinAuthz API handlers will calculate the ID and fill it in automatically.
- * BinAuthz computes this ID as the OpenPGP RFC4880 V4 fingerprint,
- * represented as upper-case hex. If `id` is provided by the caller, it
- * will be overwritten by the API-calculated ID.
+ * ASCII-armored representation of a PGP public key, as the entire output by the command `gpg --export --armor foo@example.com` (either LF or CRLF line endings). When using this field, `id` should be left blank. The BinAuthz API handlers will calculate the ID and fill it in automatically. BinAuthz computes this ID as the OpenPGP RFC4880 V4 fingerprint, represented as upper-case hex. If `id` is provided by the caller, it will be overwritten by the API-calculated ID.
*/
asciiArmoredPgpPublicKey?: string;
/**
@@ -202,18 +177,11 @@ export namespace binaryauthorization_v1beta1 {
*/
comment?: string;
/**
- * The ID of this public key. Signatures verified by BinAuthz must include
- * the ID of the public key that can be used to verify them, and that ID
- * must match the contents of this field exactly. Additional restrictions on
- * this field can be imposed based on which public key type is encapsulated.
- * See the documentation on `public_key` cases below for details.
+ * The ID of this public key. Signatures verified by BinAuthz must include the ID of the public key that can be used to verify them, and that ID must match the contents of this field exactly. Additional restrictions on this field can be imposed based on which public key type is encapsulated. See the documentation on `public_key` cases below for details.
*/
id?: string;
/**
- * A raw PKIX SubjectPublicKeyInfo format public key. NOTE: `id` may be
- * explicitly provided by the caller when using this type of public key, but
- * it MUST be a valid RFC3986 URI. If `id` is left blank, a default one will
- * be computed based on the digest of the DER encoding of the public key.
+ * A raw PKIX SubjectPublicKeyInfo format public key. NOTE: `id` may be explicitly provided by the caller when using this type of public key, but it MUST be a valid RFC3986 URI. If `id` is left blank, a default one will be computed based on the digest of the DER encoding of the public key.
*/
pkixPublicKey?: Schema$PkixPublicKey;
}
@@ -222,106 +190,53 @@ export namespace binaryauthorization_v1beta1 {
*/
export interface Schema$Binding {
/**
- * The condition that is associated with this binding. NOTE: An unsatisfied
- * condition will not allow user access via current binding. Different
- * bindings, including their conditions, are examined independently.
+ * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
*/
condition?: Schema$Expr;
/**
- * Specifies the identities requesting access for a Cloud Platform resource.
- * `members` can have the following values: * `allUsers`: A special
- * identifier that represents anyone who is on the internet; with or
- * without a Google account. * `allAuthenticatedUsers`: A special
- * identifier that represents anyone who is authenticated with a Google
- * account or a service account. * `user:{emailid}`: An email address that
- * represents a specific Google account. For example, `alice@gmail.com` .
- * * `serviceAccount:{emailid}`: An email address that represents a service
- * account. For example, `my-other-app@appspot.gserviceaccount.com`. *
- * `group:{emailid}`: An email address that represents a Google group. For
- * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
- * (primary) that represents all the users of that domain. For example,
- * `google.com` or `example.com`.
+ * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[];
/**
- * Role that is assigned to `members`. For example, `roles/viewer`,
- * `roles/editor`, or `roles/owner`.
+ * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
- * Represents an expression text. Example: title: "User account
- * presence" description: "Determines whether the request has a
- * user account" expression: "size(request.user) > 0"
+ * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
*/
export interface Schema$Expr {
/**
- * An optional description of the expression. This is a longer text which
- * describes the expression, e.g. when hovered over it in a UI.
+ * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string;
/**
- * Textual representation of an expression in Common Expression Language
- * syntax. The application context of the containing message determines
- * which well-known feature set of CEL is supported.
+ * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
*/
expression?: string;
/**
- * An optional string indicating the location of the expression for error
- * reporting, e.g. a file name and a position in the file.
+ * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string;
/**
- * An optional title for the expression, i.e. a short string describing its
- * purpose. This can be used e.g. in UIs which allow to enter the
- * expression.
+ * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string;
}
/**
- * Defines an Identity and Access Management (IAM) policy. It is used to
- * specify access control policies for Cloud Platform resources. A `Policy`
- * consists of a list of `bindings`. A `binding` binds a list of `members` to
- * a `role`, where the members can be user accounts, Google groups, Google
- * domains, and service accounts. A `role` is a named list of permissions
- * defined by IAM. **JSON Example** { "bindings": [ {
- * "role": "roles/owner", "members": [
- * "user:mike@example.com", "group:admins@example.com",
- * "domain:google.com",
- * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, {
- * "role": "roles/viewer", "members":
- * ["user:sean@example.com"] } ] } **YAML
- * Example** bindings: - members: - user:mike@example.com -
- * group:admins@example.com - domain:google.com -
- * serviceAccount:my-other-app@appspot.gserviceaccount.com role:
- * roles/owner - members: - user:sean@example.com role:
- * roles/viewer For a description of IAM and its features, see the [IAM
- * developer's guide](https://cloud.google.com/iam/docs).
+ * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
*/
export interface Schema$IamPolicy {
/**
- * Associates a list of `members` to a `role`. `bindings` with no members
- * will result in an error.
+ * Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
*/
bindings?: Schema$Binding[];
/**
- * `etag` is used for optimistic concurrency control as a way to help
- * prevent simultaneous updates of a policy from overwriting each other. It
- * is strongly suggested that systems make use of the `etag` in the
- * read-modify-write cycle to perform policy updates in order to avoid race
- * conditions: An `etag` is returned in the response to `getIamPolicy`, and
- * systems are expected to put that etag in the request to `setIamPolicy` to
- * ensure that their change will be applied to the same version of the
- * policy. If no `etag` is provided in the call to `setIamPolicy`, then the
- * existing policy is overwritten blindly.
+ * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
*/
etag?: string;
/**
@@ -338,28 +253,20 @@ export namespace binaryauthorization_v1beta1 {
*/
attestors?: Schema$Attestor[];
/**
- * A token to retrieve the next page of results. Pass this value in the
- * ListAttestorsRequest.page_token field in the subsequent call to the
- * `ListAttestors` method to retrieve the next page of results.
+ * A token to retrieve the next page of results. Pass this value in the ListAttestorsRequest.page_token field in the subsequent call to the `ListAttestors` method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
- * A public key in the PkixPublicKey format (see
- * https://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details). Public
- * keys of this type are typically textually encoded using the PEM format.
+ * A public key in the PkixPublicKey format (see https://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details). Public keys of this type are typically textually encoded using the PEM format.
*/
export interface Schema$PkixPublicKey {
/**
- * A PEM-encoded public key, as described in
- * https://tools.ietf.org/html/rfc7468#section-13
+ * A PEM-encoded public key, as described in https://tools.ietf.org/html/rfc7468#section-13
*/
publicKeyPem?: string;
/**
- * The signature algorithm used to verify a message against a signature
- * using this key. These signature algorithm must match the structure and
- * any object identifiers encoded in `public_key_pem` (i.e. this algorithm
- * must match that of the public key).
+ * The signature algorithm used to verify a message against a signature using this key. These signature algorithm must match the structure and any object identifiers encoded in `public_key_pem` (i.e. this algorithm must match that of the public key).
*/
signatureAlgorithm?: string;
}
@@ -368,24 +275,15 @@ export namespace binaryauthorization_v1beta1 {
*/
export interface Schema$Policy {
/**
- * Optional. Admission policy whitelisting. A matching admission request
- * will always be permitted. This feature is typically used to exclude
- * Google or third-party infrastructure images from Binary Authorization
- * policies.
+ * Optional. Admission policy whitelisting. A matching admission request will always be permitted. This feature is typically used to exclude Google or third-party infrastructure images from Binary Authorization policies.
*/
admissionWhitelistPatterns?: Schema$AdmissionWhitelistPattern[];
/**
- * Optional. Per-cluster admission rules. Cluster spec format:
- * `location.clusterId`. There can be at most one admission rule per cluster
- * spec. A `location` is either a compute zone (e.g. us-central1-a) or a
- * region (e.g. us-central1). For `clusterId` syntax restrictions see
- * https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters.
+ * Optional. Per-cluster admission rules. Cluster spec format: `location.clusterId`. There can be at most one admission rule per cluster spec. A `location` is either a compute zone (e.g. us-central1-a) or a region (e.g. us-central1). For `clusterId` syntax restrictions see https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters.
*/
clusterAdmissionRules?: {[key: string]: Schema$AdmissionRule};
/**
- * Required. Default admission rule for a cluster without a per-cluster,
- * per- kubernetes-service-account, or per-istio-service-identity admission
- * rule.
+ * Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule.
*/
defaultAdmissionRule?: Schema$AdmissionRule;
/**
@@ -393,15 +291,11 @@ export namespace binaryauthorization_v1beta1 {
*/
description?: string;
/**
- * Optional. Controls the evaluation of a Google-maintained global admission
- * policy for common system-level images. Images not covered by the global
- * policy will be subject to the project admission policy. This setting has
- * no effect when specified inside a global admission policy.
+ * Optional. Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. This setting has no effect when specified inside a global admission policy.
*/
globalPolicyEvaluationMode?: string;
/**
- * Output only. The resource name, in the format `projects/x/policy`. There
- * is at most one policy per project.
+ * Output only. The resource name, in the format `projects/x/policy`. There is at most one policy per project.
*/
name?: string;
/**
@@ -414,10 +308,7 @@ export namespace binaryauthorization_v1beta1 {
*/
export interface Schema$SetIamPolicyRequest {
/**
- * REQUIRED: The complete policy to be applied to the `resource`. The size
- * of the policy is limited to a few 10s of KB. An empty policy is a valid
- * policy but certain Cloud Platform services (such as Projects) might
- * reject them.
+ * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
*/
policy?: Schema$IamPolicy;
}
@@ -426,10 +317,7 @@ export namespace binaryauthorization_v1beta1 {
*/
export interface Schema$TestIamPermissionsRequest {
/**
- * The set of permissions to check for the `resource`. Permissions with
- * wildcards (such as '*' or 'storage.*') are not allowed.
- * For more information see [IAM
- * Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[];
}
@@ -438,42 +326,24 @@ export namespace binaryauthorization_v1beta1 {
*/
export interface Schema$TestIamPermissionsResponse {
/**
- * A subset of `TestPermissionsRequest.permissions` that the caller is
- * allowed.
+ * A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
*/
permissions?: string[];
}
/**
- * An user owned drydock note references a Drydock ATTESTATION_AUTHORITY Note
- * created by the user.
+ * An user owned drydock note references a Drydock ATTESTATION_AUTHORITY Note created by the user.
*/
export interface Schema$UserOwnedDrydockNote {
/**
- * Output only. This field will contain the service account email address
- * that this Attestor will use as the principal when querying Container
- * Analysis. Attestor administrators must grant this service account the IAM
- * role needed to read attestations from the note_reference in Container
- * Analysis (`containeranalysis.notes.occurrences.viewer`). This email
- * address is fixed for the lifetime of the Attestor, but callers should not
- * make any other assumptions about the service account email; future
- * versions may use an email based on a different naming pattern.
+ * Output only. This field will contain the service account email address that this Attestor will use as the principal when querying Container Analysis. Attestor administrators must grant this service account the IAM role needed to read attestations from the note_reference in Container Analysis (`containeranalysis.notes.occurrences.viewer`). This email address is fixed for the lifetime of the Attestor, but callers should not make any other assumptions about the service account email; future versions may use an email based on a different naming pattern.
*/
delegationServiceAccountEmail?: string;
/**
- * Required. The Drydock resource name of a ATTESTATION_AUTHORITY Note,
- * created by the user, in the format: `projects/x/notes/x (or the legacy
- * `providers/x/notes/x). This field may not be updated. An attestation by
- * this attestor is stored as a Drydock ATTESTATION_AUTHORITY Occurrence
- * that names a container image and that links to this Note. Drydock is an
- * external dependency.
+ * Required. The Drydock resource name of a ATTESTATION_AUTHORITY Note, created by the user, in the format: `projects/x/notes/x (or the legacy `providers/x/notes/x). This field may not be updated. An attestation by this attestor is stored as a Drydock ATTESTATION_AUTHORITY Occurrence that names a container image and that links to this Note. Drydock is an external dependency.
*/
noteReference?: string;
/**
- * Optional. Public keys that verify attestations signed by this attestor.
- * This field may be updated. If this field is non-empty, one of the
- * specified public keys must verify that an attestation was signed by this
- * attestor for the image specified in the admission request. If this field
- * is empty, this attestor always returns that no valid attestations exist.
+ * Optional. Public keys that verify attestations signed by this attestor. This field may be updated. If this field is non-empty, one of the specified public keys must verify that an attestation was signed by this attestor for the image specified in the admission request. If this field is empty, this attestor always returns that no valid attestations exist.
*/
publicKeys?: Schema$AttestorPublicKey[];
}
@@ -490,8 +360,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.getPolicy
- * @desc Gets the policy for this project. Returns a default policy if the
- * project does not have one.
+ * @desc Gets the policy for this project. Returns a default policy if the project does not have one.
* @alias binaryauthorization.projects.getPolicy
* @memberOf! ()
*
@@ -561,11 +430,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.updatePolicy
- * @desc Creates or updates a project's policy, and returns a copy of the
- * new policy. A policy is always updated as a whole, to avoid race
- * conditions with concurrent policy enforcement (or management!) requests.
- * Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the
- * request is malformed.
+ * @desc Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.
* @alias binaryauthorization.projects.updatePolicy
* @memberOf! ()
*
@@ -643,8 +508,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The resource name of the policy to retrieve, in the format
- * `projects/x/policy`.
+ * Required. The resource name of the policy to retrieve, in the format `projects/x/policy`.
*/
name?: string;
}
@@ -656,8 +520,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Output only. The resource name, in the format `projects/x/policy`. There
- * is at most one policy per project.
+ * Output only. The resource name, in the format `projects/x/policy`. There is at most one policy per project.
*/
name?: string;
@@ -675,9 +538,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.attestors.create
- * @desc Creates an attestor, and returns a copy of the new attestor.
- * Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the
- * request is malformed, ALREADY_EXISTS if the attestor already exists.
+ * @desc Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists.
* @alias binaryauthorization.projects.attestors.create
* @memberOf! ()
*
@@ -752,8 +613,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.attestors.delete
- * @desc Deletes an attestor. Returns NOT_FOUND if the attestor does not
- * exist.
+ * @desc Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.
* @alias binaryauthorization.projects.attestors.delete
* @memberOf! ()
*
@@ -893,8 +753,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.attestors.getIamPolicy
- * @desc Gets the access control policy for a resource. Returns an empty
- * policy if the resource exists and does not have a policy set.
+ * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
* @alias binaryauthorization.projects.attestors.getIamPolicy
* @memberOf! ()
*
@@ -969,8 +828,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.attestors.list
- * @desc Lists attestors. Returns INVALID_ARGUMENT if the project does not
- * exist.
+ * @desc Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.
* @alias binaryauthorization.projects.attestors.list
* @memberOf! ()
*
@@ -1049,8 +907,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.attestors.setIamPolicy
- * @desc Sets the access control policy on the specified resource. Replaces
- * any existing policy.
+ * @desc Sets the access control policy on the specified resource. Replaces any existing policy.
* @alias binaryauthorization.projects.attestors.setIamPolicy
* @memberOf! ()
*
@@ -1126,11 +983,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.attestors.testIamPermissions
- * @desc Returns permissions that a caller has on the specified resource. If
- * the resource does not exist, this will return an empty set of
- * permissions, not a NOT_FOUND error. Note: This operation is designed to
- * be used for building permission-aware UIs and command-line tools, not for
- * authorization checking. This operation may "fail open" without warning.
+ * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
* @alias binaryauthorization.projects.attestors.testIamPermissions
* @memberOf! ()
*
@@ -1213,8 +1066,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.attestors.update
- * @desc Updates an attestor. Returns NOT_FOUND if the attestor does not
- * exist.
+ * @desc Updates an attestor. Returns NOT_FOUND if the attestor does not exist.
* @alias binaryauthorization.projects.attestors.update
* @memberOf! ()
*
@@ -1313,8 +1165,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The name of the attestors to delete, in the format
- * `projects/x/attestors/x`.
+ * Required. The name of the attestors to delete, in the format `projects/x/attestors/x`.
*/
name?: string;
}
@@ -1326,8 +1177,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The name of the attestor to retrieve, in the format
- * `projects/x/attestors/x`.
+ * Required. The name of the attestor to retrieve, in the format `projects/x/attestors/x`.
*/
name?: string;
}
@@ -1339,8 +1189,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy is being requested. See the
- * operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
}
@@ -1352,19 +1201,15 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Requested page size. The server may return fewer results than requested.
- * If unspecified, the server will pick an appropriate default.
+ * Requested page size. The server may return fewer results than requested. If unspecified, the 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 ListAttestorsResponse.next_page_token
- * returned from the previous call to the `ListAttestors` method.
+ * A token identifying a page of results the server should return. Typically, this is the value of ListAttestorsResponse.next_page_token returned from the previous call to the `ListAttestors` method.
*/
pageToken?: string;
/**
- * Required. The resource name of the project associated with the attestors,
- * in the format `projects/x`.
+ * Required. The resource name of the project associated with the attestors, in the format `projects/x`.
*/
parent?: string;
}
@@ -1376,8 +1221,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy is being specified. See the
- * operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
@@ -1394,8 +1238,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy detail is being requested.
- * See the operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
@@ -1412,8 +1255,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. The resource name, in the format: `projects/x/attestors/x`.
- * This field may not be updated.
+ * Required. The resource name, in the format: `projects/x/attestors/x`. This field may not be updated.
*/
name?: string;
@@ -1431,8 +1273,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.policy.getIamPolicy
- * @desc Gets the access control policy for a resource. Returns an empty
- * policy if the resource exists and does not have a policy set.
+ * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
* @alias binaryauthorization.projects.policy.getIamPolicy
* @memberOf! ()
*
@@ -1507,8 +1348,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.policy.setIamPolicy
- * @desc Sets the access control policy on the specified resource. Replaces
- * any existing policy.
+ * @desc Sets the access control policy on the specified resource. Replaces any existing policy.
* @alias binaryauthorization.projects.policy.setIamPolicy
* @memberOf! ()
*
@@ -1584,11 +1424,7 @@ export namespace binaryauthorization_v1beta1 {
/**
* binaryauthorization.projects.policy.testIamPermissions
- * @desc Returns permissions that a caller has on the specified resource. If
- * the resource does not exist, this will return an empty set of
- * permissions, not a NOT_FOUND error. Note: This operation is designed to
- * be used for building permission-aware UIs and command-line tools, not for
- * authorization checking. This operation may "fail open" without warning.
+ * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
* @alias binaryauthorization.projects.policy.testIamPermissions
* @memberOf! ()
*
@@ -1678,8 +1514,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy is being requested. See the
- * operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
}
@@ -1691,8 +1526,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy is being specified. See the
- * operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
@@ -1709,8 +1543,7 @@ export namespace binaryauthorization_v1beta1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * REQUIRED: The resource for which the policy detail is being requested.
- * See the operation documentation for the appropriate value for this field.
+ * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
diff --git a/src/apis/blogger/package.json b/src/apis/blogger/package.json
index 38d71716e76..50d1fc8f01f 100644
--- a/src/apis/blogger/package.json
+++ b/src/apis/blogger/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/blogger/v2.ts b/src/apis/blogger/v2.ts
index 932cb10827b..e6b99e2974b 100644
--- a/src/apis/blogger/v2.ts
+++ b/src/apis/blogger/v2.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace blogger_v2 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace blogger_v2 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -99,7 +96,10 @@ export namespace blogger_v2 {
users: Resource$Users;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.blogs = new Resource$Blogs(this.context);
this.comments = new Resource$Comments(this.context);
@@ -265,8 +265,7 @@ export namespace blogger_v2 {
*/
selfLink?: string;
/**
- * The title of this entity. This is the name displayed in the Admin user
- * interface.
+ * The title of this entity. This is the name displayed in the Admin user interface.
*/
title?: string;
/**
@@ -1252,8 +1251,7 @@ export namespace blogger_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * ID of the user whose blogs are to be fetched. Either the word 'self'
- * (sans quote marks) or the user's profile identifier.
+ * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
*/
userId?: string;
}
diff --git a/src/apis/blogger/v3.ts b/src/apis/blogger/v3.ts
index c83847fa92f..9df8e66368e 100644
--- a/src/apis/blogger/v3.ts
+++ b/src/apis/blogger/v3.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace blogger_v3 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace blogger_v3 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -102,7 +99,10 @@ export namespace blogger_v3 {
users: Resource$Users;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.blogs = new Resource$Blogs(this.context);
this.blogUserInfos = new Resource$Bloguserinfos(this.context);
@@ -201,8 +201,7 @@ export namespace blogger_v3 {
*/
photosAlbumKey?: string;
/**
- * Access permissions that the user has for the blog (ADMIN, AUTHOR, or
- * READER).
+ * Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
*/
role?: string;
/**
@@ -340,8 +339,7 @@ export namespace blogger_v3 {
*/
status?: string;
/**
- * The title of this entity. This is the name displayed in the Admin user
- * interface.
+ * The title of this entity. This is the name displayed in the Admin user interface.
*/
title?: string;
/**
@@ -821,8 +819,7 @@ export namespace blogger_v3 {
*/
maxPosts?: number;
/**
- * Access level with which to view the blog. Note that some fields require
- * elevated access.
+ * Access level with which to view the blog. Note that some fields require elevated access.
*/
view?: string;
}
@@ -837,8 +834,7 @@ export namespace blogger_v3 {
*/
url?: string;
/**
- * Access level with which to view the blog. Note that some fields require
- * elevated access.
+ * Access level with which to view the blog. Note that some fields require elevated access.
*/
view?: string;
}
@@ -849,29 +845,23 @@ export namespace blogger_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether the response is a list of blogs with per-user information instead
- * of just blogs.
+ * Whether the response is a list of blogs with per-user information instead of just blogs.
*/
fetchUserInfo?: boolean;
/**
- * User access types for blogs to include in the results, e.g. AUTHOR will
- * return blogs where the user has author level access. If no roles are
- * specified, defaults to ADMIN and AUTHOR roles.
+ * User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.
*/
role?: string[];
/**
- * Blog statuses to include in the result (default: Live blogs only). Note
- * that ADMIN access is required to view deleted blogs.
+ * Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.
*/
status?: string[];
/**
- * ID of the user whose blogs are to be fetched. Either the word 'self'
- * (sans quote marks) or the user's profile identifier.
+ * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
*/
userId?: string;
/**
- * Access level with which to view the blogs. Note that some fields require
- * elevated access.
+ * Access level with which to view the blogs. Note that some fields require elevated access.
*/
view?: string;
}
@@ -974,8 +964,7 @@ export namespace blogger_v3 {
*/
maxPosts?: number;
/**
- * ID of the user whose blogs are to be fetched. Either the word 'self'
- * (sans quote marks) or the user's profile identifier.
+ * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
*/
userId?: string;
}
@@ -1288,8 +1277,7 @@ export namespace blogger_v3 {
/**
* blogger.comments.listByBlog
- * @desc Retrieves the comments for a blog, across all posts, possibly
- * filtered.
+ * @desc Retrieves the comments for a blog, across all posts, possibly filtered.
* @alias blogger.comments.listByBlog
* @memberOf! ()
*
@@ -1573,10 +1561,7 @@ export namespace blogger_v3 {
*/
postId?: string;
/**
- * Access level for the requested comment (default: READER). Note that some
- * comments will require elevated permissions, for example comments where
- * the parent posts which is in a draft state, or comments that are pending
- * moderation.
+ * Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.
*/
view?: string;
}
@@ -1619,8 +1604,7 @@ export namespace blogger_v3 {
*/
status?: string[];
/**
- * Access level with which to view the returned result. Note that some
- * fields require elevated access.
+ * Access level with which to view the returned result. Note that some fields require elevated access.
*/
view?: string;
}
@@ -1925,8 +1909,7 @@ export namespace blogger_v3 {
/**
* blogger.pages.list
- * @desc Retrieves the pages for a blog, optionally including non-LIVE
- * statuses.
+ * @desc Retrieves the pages for a blog, optionally including non-LIVE statuses.
* @alias blogger.pages.list
* @memberOf! ()
*
@@ -2372,8 +2355,7 @@ export namespace blogger_v3 {
*/
status?: string[];
/**
- * Access level with which to view the returned result. Note that some
- * fields require elevated access.
+ * Access level with which to view the returned result. Note that some fields require elevated access.
*/
view?: string;
}
@@ -2392,13 +2374,11 @@ export namespace blogger_v3 {
*/
pageId?: string;
/**
- * Whether a publish action should be performed when the page is updated
- * (default: false).
+ * Whether a publish action should be performed when the page is updated (default: false).
*/
publish?: boolean;
/**
- * Whether a revert action should be performed when the page is updated
- * (default: false).
+ * Whether a revert action should be performed when the page is updated (default: false).
*/
revert?: boolean;
@@ -2452,13 +2432,11 @@ export namespace blogger_v3 {
*/
pageId?: string;
/**
- * Whether a publish action should be performed when the page is updated
- * (default: false).
+ * Whether a publish action should be performed when the page is updated (default: false).
*/
publish?: boolean;
/**
- * Whether a revert action should be performed when the page is updated
- * (default: false).
+ * Whether a revert action should be performed when the page is updated (default: false).
*/
revert?: boolean;
@@ -3026,8 +3004,7 @@ export namespace blogger_v3 {
/**
* blogger.posts.publish
- * @desc Publishes a draft post, optionally at the specific time of the
- * given publishDate parameter.
+ * @desc Publishes a draft post, optionally at the specific time of the given publishDate parameter.
* @alias blogger.posts.publish
* @memberOf! ()
*
@@ -3346,9 +3323,7 @@ export namespace blogger_v3 {
*/
blogId?: string;
/**
- * Whether the body content of the post is included (default: true). This
- * should be set to false when the post bodies are not required, to help
- * minimize traffic.
+ * Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.
*/
fetchBody?: boolean;
/**
@@ -3364,8 +3339,7 @@ export namespace blogger_v3 {
*/
postId?: string;
/**
- * Access level with which to view the returned result. Note that some
- * fields require elevated access.
+ * Access level with which to view the returned result. Note that some fields require elevated access.
*/
view?: string;
}
@@ -3388,8 +3362,7 @@ export namespace blogger_v3 {
*/
path?: string;
/**
- * Access level with which to view the returned result. Note that some
- * fields require elevated access.
+ * Access level with which to view the returned result. Note that some fields require elevated access.
*/
view?: string;
}
@@ -3404,13 +3377,11 @@ export namespace blogger_v3 {
*/
blogId?: string;
/**
- * Whether the body content of the post is included with the result
- * (default: true).
+ * Whether the body content of the post is included with the result (default: true).
*/
fetchBody?: boolean;
/**
- * Whether image URL metadata for each post is included in the returned
- * result (default: false).
+ * Whether image URL metadata for each post is included in the returned result (default: false).
*/
fetchImages?: boolean;
/**
@@ -3438,9 +3409,7 @@ export namespace blogger_v3 {
*/
endDate?: string;
/**
- * Whether the body content of posts is included (default: true). This
- * should be set to false when the post bodies are not required, to help
- * minimize traffic.
+ * Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.
*/
fetchBodies?: boolean;
/**
@@ -3472,8 +3441,7 @@ export namespace blogger_v3 {
*/
status?: string[];
/**
- * Access level with which to view the returned result. Note that some
- * fields require escalated access.
+ * Access level with which to view the returned result. Note that some fields require escalated access.
*/
view?: string;
}
@@ -3488,13 +3456,11 @@ export namespace blogger_v3 {
*/
blogId?: string;
/**
- * Whether the body content of the post is included with the result
- * (default: true).
+ * Whether the body content of the post is included with the result (default: true).
*/
fetchBody?: boolean;
/**
- * Whether image URL metadata for each post is included in the returned
- * result (default: false).
+ * Whether image URL metadata for each post is included in the returned result (default: false).
*/
fetchImages?: boolean;
/**
@@ -3506,13 +3472,11 @@ export namespace blogger_v3 {
*/
postId?: string;
/**
- * Whether a publish action should be performed when the post is updated
- * (default: false).
+ * Whether a publish action should be performed when the post is updated (default: false).
*/
publish?: boolean;
/**
- * Whether a revert action should be performed when the post is updated
- * (default: false).
+ * Whether a revert action should be performed when the post is updated (default: false).
*/
revert?: boolean;
@@ -3536,10 +3500,7 @@ export namespace blogger_v3 {
*/
postId?: string;
/**
- * Optional date and time to schedule the publishing of the Blog. If no
- * publishDate parameter is given, the post is either published at the a
- * previously saved schedule date (if present), or the current time. If a
- * future date is given, the post will be scheduled to be published.
+ * Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published.
*/
publishDate?: string;
}
@@ -3569,9 +3530,7 @@ export namespace blogger_v3 {
*/
blogId?: string;
/**
- * Whether the body content of posts is included (default: true). This
- * should be set to false when the post bodies are not required, to help
- * minimize traffic.
+ * Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.
*/
fetchBodies?: boolean;
/**
@@ -3594,13 +3553,11 @@ export namespace blogger_v3 {
*/
blogId?: string;
/**
- * Whether the body content of the post is included with the result
- * (default: true).
+ * Whether the body content of the post is included with the result (default: true).
*/
fetchBody?: boolean;
/**
- * Whether image URL metadata for each post is included in the returned
- * result (default: false).
+ * Whether image URL metadata for each post is included in the returned result (default: false).
*/
fetchImages?: boolean;
/**
@@ -3612,13 +3569,11 @@ export namespace blogger_v3 {
*/
postId?: string;
/**
- * Whether a publish action should be performed when the post is updated
- * (default: false).
+ * Whether a publish action should be performed when the post is updated (default: false).
*/
publish?: boolean;
/**
- * Whether a revert action should be performed when the post is updated
- * (default: false).
+ * Whether a revert action should be performed when the post is updated (default: false).
*/
revert?: boolean;
@@ -3636,9 +3591,7 @@ export namespace blogger_v3 {
/**
* blogger.postUserInfos.get
- * @desc Gets one post and user info pair, by post ID and user ID. The post
- * user info contains per-user information about the post, such as access
- * rights, specific to the user.
+ * @desc Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.
* @alias blogger.postUserInfos.get
* @memberOf! ()
*
@@ -3715,9 +3668,7 @@ export namespace blogger_v3 {
/**
* blogger.postUserInfos.list
- * @desc Retrieves a list of post and post user info pairs, possibly
- * filtered. The post user info contains per-user information about the
- * post, such as access rights, specific to the user.
+ * @desc Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.
* @alias blogger.postUserInfos.list
* @memberOf! ()
*
@@ -3819,8 +3770,7 @@ export namespace blogger_v3 {
*/
postId?: string;
/**
- * ID of the user for the per-user information to be fetched. Either the
- * word 'self' (sans quote marks) or the user's profile identifier.
+ * ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
*/
userId?: string;
}
@@ -3868,13 +3818,11 @@ export namespace blogger_v3 {
*/
status?: string[];
/**
- * ID of the user for the per-user information to be fetched. Either the
- * word 'self' (sans quote marks) or the user's profile identifier.
+ * ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
*/
userId?: string;
/**
- * Access level with which to view the returned result. Note that some
- * fields require elevated access.
+ * Access level with which to view the returned result. Note that some fields require elevated access.
*/
view?: string;
}
diff --git a/src/apis/books/package.json b/src/apis/books/package.json
index 5e0749d8f76..81de9631269 100644
--- a/src/apis/books/package.json
+++ b/src/apis/books/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/books/v1.ts b/src/apis/books/v1.ts
index 0b40783e814..665043363e6 100644
--- a/src/apis/books/v1.ts
+++ b/src/apis/books/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace books_v1 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace books_v1 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -107,7 +104,10 @@ export namespace books_v1 {
volumes: Resource$Volumes;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.bookshelves = new Resource$Bookshelves(this.context);
this.cloudloading = new Resource$Cloudloading(this.context);
@@ -127,13 +127,11 @@ export namespace books_v1 {
export interface Schema$Annotation {
/**
- * Anchor text after excerpt. For requests, if the user bookmarked a screen
- * that has no flowing text on it, then this field should be empty.
+ * Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
*/
afterSelectedText?: string;
/**
- * Anchor text before excerpt. For requests, if the user bookmarked a screen
- * that has no flowing text on it, then this field should be empty.
+ * Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
*/
beforeSelectedText?: string;
/**
@@ -237,8 +235,7 @@ export namespace books_v1 {
*/
selfLink?: string;
/**
- * Timestamp for the last time this data was updated. (RFC 3339 UTC
- * date-time format).
+ * Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
*/
updated?: string;
/**
@@ -256,13 +253,11 @@ export namespace books_v1 {
*/
kind?: string;
/**
- * Token to pass in for pagination for the next page. This will not be
- * present if this request does not have more results.
+ * Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
*/
nextPageToken?: string;
/**
- * Total number of annotations found. This may be greater than the number of
- * notes returned in this response if results have been paginated.
+ * Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
*/
totalItems?: number;
}
@@ -276,8 +271,7 @@ export namespace books_v1 {
*/
kind?: string;
/**
- * Token to pass in for pagination for the next page. This will not be
- * present if this request does not have more results.
+ * Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
*/
nextPageToken?: string;
/**
@@ -325,8 +319,7 @@ export namespace books_v1 {
*/
access?: string;
/**
- * Created time for this bookshelf (formatted UTC timestamp with millisecond
- * resolution).
+ * Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
*/
created?: string;
/**
@@ -350,8 +343,7 @@ export namespace books_v1 {
*/
title?: string;
/**
- * Last modified time of this bookshelf (formatted UTC timestamp with
- * millisecond resolution).
+ * Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
*/
updated?: string;
/**
@@ -359,8 +351,7 @@ export namespace books_v1 {
*/
volumeCount?: number;
/**
- * Last time a volume was added or removed from this bookshelf (formatted
- * UTC timestamp with millisecond resolution).
+ * Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
*/
volumesLastUpdated?: string;
}
@@ -405,8 +396,7 @@ export namespace books_v1 {
*/
message?: string;
/**
- * Client nonce for verification. Download access and client-validation
- * only.
+ * Client nonce for verification. Download access and client-validation only.
*/
nonce?: string;
/**
@@ -422,8 +412,7 @@ export namespace books_v1 {
*/
signature?: string;
/**
- * Client app identifier for verification. Download access and
- * client-validation only.
+ * Client app identifier for verification. Download access and client-validation only.
*/
source?: string;
/**
@@ -510,8 +499,7 @@ export namespace books_v1 {
*/
deviceAllowed?: boolean;
/**
- * If restricted, the number of content download licenses already acquired
- * (including the requesting client, if licensed).
+ * If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
*/
downloadsAcquired?: number;
/**
@@ -523,8 +511,7 @@ export namespace books_v1 {
*/
kind?: string;
/**
- * If restricted, the maximum number of content download licenses for this
- * volume.
+ * If restricted, the maximum number of content download licenses for this volume.
*/
maxDownloadDevices?: number;
/**
@@ -532,14 +519,11 @@ export namespace books_v1 {
*/
message?: string;
/**
- * Client nonce for verification. Download access and client-validation
- * only.
+ * Client nonce for verification. Download access and client-validation only.
*/
nonce?: string;
/**
- * Error/warning reason code. Additional codes may be added in the future. 0
- * OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200
- * WARNING_USED_LAST_ACCESS
+ * Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
*/
reasonCode?: string;
/**
@@ -551,8 +535,7 @@ export namespace books_v1 {
*/
signature?: string;
/**
- * Client app identifier for verification. Download access and
- * client-validation only.
+ * Client app identifier for verification. Download access and client-validation only.
*/
source?: string;
/**
@@ -655,15 +638,11 @@ export namespace books_v1 {
*/
selfLink?: string;
/**
- * Timestamp for the last time an item in this layer was updated. (RFC 3339
- * UTC date-time format).
+ * Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
*/
updated?: string;
/**
- * The current version of this layer's volume annotations. Note that
- * this version applies only to the data in the
- * books.layers.volumeAnnotations.* responses. The actual annotation data is
- * versioned separately.
+ * The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
*/
volumeAnnotationsVersion?: string;
/**
@@ -755,8 +734,7 @@ export namespace books_v1 {
*/
pdfPosition?: string;
/**
- * Timestamp when this reading position was last updated (formatted UTC
- * timestamp with millisecond resolution).
+ * Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
*/
updated?: string;
/**
@@ -800,13 +778,11 @@ export namespace books_v1 {
*/
kind?: string;
/**
- * Star rating for this review. Possible values are ONE, TWO, THREE, FOUR,
- * FIVE or NOT_RATED.
+ * Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
*/
rating?: string;
/**
- * Information regarding the source of this review, when the review is not
- * from a Google Books user.
+ * Information regarding the source of this review, when the review is not from a Google Books user.
*/
source?: {description?: string; extraDescription?: string; url?: string};
/**
@@ -814,8 +790,7 @@ export namespace books_v1 {
*/
title?: string;
/**
- * Source type for this review. Possible values are EDITORIAL, WEB_USER or
- * GOOGLE_USER.
+ * Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
*/
type?: string;
/**
@@ -863,9 +838,7 @@ export namespace books_v1 {
}
export interface Schema$Volume {
/**
- * Any information about a volume related to reading or obtaining that
- * volume text. This information can depend on country (books may be public
- * domain in one country but not in another, e.g.).
+ * Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
*/
accessInfo?: {
accessViewStatus?: string;
@@ -892,8 +865,7 @@ export namespace books_v1 {
webReaderLink?: string;
};
/**
- * Opaque identifier for a specific version of a volume resource. (In LITE
- * projection)
+ * Opaque identifier for a specific version of a volume resource. (In LITE projection)
*/
etag?: string;
/**
@@ -915,10 +887,7 @@ export namespace books_v1 {
*/
recommendedInfo?: {explanation?: string};
/**
- * Any information about a volume related to the eBookstore and/or
- * purchaseability. This information can depend on the country where the
- * request originates from (i.e. books may not be for sale in certain
- * countries).
+ * Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
*/
saleInfo?: {
buyLink?: string;
@@ -945,8 +914,7 @@ export namespace books_v1 {
*/
selfLink?: string;
/**
- * User specific information related to this volume. (e.g. page this user
- * last read or whether they purchased this book)
+ * User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
*/
userInfo?: {
acquiredTime?: string;
@@ -1090,8 +1058,7 @@ export namespace books_v1 {
*/
selfLink?: string;
/**
- * Timestamp for the last time this anntoation was updated. (RFC 3339 UTC
- * date-time format).
+ * Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
*/
updated?: string;
/**
@@ -1109,8 +1076,7 @@ export namespace books_v1 {
*/
kind?: string;
/**
- * Token to pass in for pagination for the next page. This will not be
- * present if this request does not have more results.
+ * Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
*/
nextPageToken?: string;
/**
@@ -1118,10 +1084,7 @@ export namespace books_v1 {
*/
totalItems?: number;
/**
- * The version string for all of the volume annotations in this layer (not
- * just the ones in this response). Note: the version string doesn't
- * apply to the annotation data, just the information in this response (e.g.
- * the location of annotations in the book).
+ * The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).
*/
version?: string;
}
@@ -1135,15 +1098,13 @@ export namespace books_v1 {
*/
kind?: string;
/**
- * Total number of volumes found. This might be greater than the number of
- * volumes returned in this response if results have been paginated.
+ * Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
*/
totalItems?: number;
}
export interface Schema$Volumeseriesinfo {
/**
- * The display number string. This should be used only for display purposes
- * and the actual sequence should be inferred from the below orderNumber.
+ * The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
*/
bookDisplayNumber?: string;
/**
@@ -1724,8 +1685,7 @@ export namespace books_v1 {
*/
drive_document_id?: string;
/**
- * The document MIME type. It can be set only if the drive_document_id is
- * set.
+ * The document MIME type. It can be set only if the drive_document_id is set.
*/
mime_type?: string;
/**
@@ -1936,8 +1896,7 @@ export namespace books_v1 {
/**
* books.familysharing.share
- * @desc Initiates sharing of the content with the user's family. Empty
- * response indicates success.
+ * @desc Initiates sharing of the content with the user's family. Empty response indicates success.
* @alias books.familysharing.share
* @memberOf! ()
*
@@ -2011,8 +1970,7 @@ export namespace books_v1 {
/**
* books.familysharing.unshare
- * @desc Initiates revoking content that has already been shared with the
- * user's family. Empty response indicates success.
+ * @desc Initiates revoking content that has already been shared with the user's family. Empty response indicates success.
* @alias books.familysharing.unshare
* @memberOf! ()
*
@@ -2553,8 +2511,7 @@ export namespace books_v1 {
*/
contentVersion?: string;
/**
- * The requested pixel height for any images. If height is provided width
- * must also be provided.
+ * The requested pixel height for any images. If height is provided width must also be provided.
*/
h?: number;
/**
@@ -2562,8 +2519,7 @@ export namespace books_v1 {
*/
layerId?: string;
/**
- * The locale information for the data. ISO-639-1 language and ISO-3166-1
- * country code. Ex: 'en_US'.
+ * The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
*/
locale?: string;
/**
@@ -2579,8 +2535,7 @@ export namespace books_v1 {
*/
volumeId?: string;
/**
- * The requested pixel width for any images. If width is provided height
- * must also be provided.
+ * The requested pixel width for any images. If width is provided height must also be provided.
*/
w?: number;
}
@@ -2592,8 +2547,7 @@ export namespace books_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The list of Annotation Data Ids to retrieve. Pagination is ignored if
- * this is set.
+ * The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.
*/
annotationDataId?: string[];
/**
@@ -2601,8 +2555,7 @@ export namespace books_v1 {
*/
contentVersion?: string;
/**
- * The requested pixel height for any images. If height is provided width
- * must also be provided.
+ * The requested pixel height for any images. If height is provided width must also be provided.
*/
h?: number;
/**
@@ -2610,8 +2563,7 @@ export namespace books_v1 {
*/
layerId?: string;
/**
- * The locale information for the data. ISO-639-1 language and ISO-3166-1
- * country code. Ex: 'en_US'.
+ * The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
*/
locale?: string;
/**
@@ -2631,13 +2583,11 @@ export namespace books_v1 {
*/
source?: string;
/**
- * RFC 3339 timestamp to restrict to items updated prior to this timestamp
- * (exclusive).
+ * RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
*/
updatedMax?: string;
/**
- * RFC 3339 timestamp to restrict to items updated since this timestamp
- * (inclusive).
+ * RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
*/
updatedMin?: string;
/**
@@ -2645,8 +2595,7 @@ export namespace books_v1 {
*/
volumeId?: string;
/**
- * The requested pixel width for any images. If width is provided height
- * must also be provided.
+ * The requested pixel width for any images. If width is provided height must also be provided.
*/
w?: number;
}
@@ -2839,8 +2788,7 @@ export namespace books_v1 {
*/
layerId?: string;
/**
- * The locale information for the data. ISO-639-1 language and ISO-3166-1
- * country code. Ex: 'en_US'.
+ * The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
*/
locale?: string;
/**
@@ -2876,8 +2824,7 @@ export namespace books_v1 {
*/
layerId?: string;
/**
- * The locale information for the data. ISO-639-1 language and ISO-3166-1
- * country code. Ex: 'en_US'.
+ * The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
*/
locale?: string;
/**
@@ -2889,8 +2836,7 @@ export namespace books_v1 {
*/
pageToken?: string;
/**
- * Set to true to return deleted annotations. updatedMin must be in the
- * request to use this. Defaults to false.
+ * Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
*/
showDeleted?: boolean;
/**
@@ -2906,13 +2852,11 @@ export namespace books_v1 {
*/
startPosition?: string;
/**
- * RFC 3339 timestamp to restrict to items updated prior to this timestamp
- * (exclusive).
+ * RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
*/
updatedMax?: string;
/**
- * RFC 3339 timestamp to restrict to items updated since this timestamp
- * (inclusive).
+ * RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
*/
updatedMin?: string;
/**
@@ -3164,8 +3108,7 @@ export namespace books_v1 {
/**
* books.myconfig.syncVolumeLicenses
- * @desc Request downloaded content access for specified volumes on the My
- * eBooks shelf.
+ * @desc Request downloaded content access for specified volumes on the My eBooks shelf.
* @alias books.myconfig.syncVolumeLicenses
* @memberOf! ()
*
@@ -3244,9 +3187,7 @@ export namespace books_v1 {
/**
* books.myconfig.updateUserSettings
- * @desc Sets the settings for the user. If a sub-object is specified, it
- * will overwrite the existing sub-object stored in the server. Unspecified
- * sub-objects will retain the existing value.
+ * @desc Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.
* @alias books.myconfig.updateUserSettings
* @memberOf! ()
*
@@ -3364,8 +3305,7 @@ export namespace books_v1 {
*/
cpksver?: string;
/**
- * The type of access license to request. If not specified, the default is
- * BOTH.
+ * The type of access license to request. If not specified, the default is BOTH.
*/
licenseTypes?: string;
/**
@@ -3875,8 +3815,7 @@ export namespace books_v1 {
*/
country?: string;
/**
- * Requests that only the summary of the specified layer be provided in the
- * response.
+ * Requests that only the summary of the specified layer be provided in the response.
*/
showOnlySummaryInResponse?: boolean;
/**
@@ -3917,8 +3856,7 @@ export namespace books_v1 {
*/
pageToken?: string;
/**
- * Set to true to return deleted annotations. updatedMin must be in the
- * request to use this. Defaults to false.
+ * Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
*/
showDeleted?: boolean;
/**
@@ -3926,13 +3864,11 @@ export namespace books_v1 {
*/
source?: string;
/**
- * RFC 3339 timestamp to restrict to items updated prior to this timestamp
- * (exclusive).
+ * RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
*/
updatedMax?: string;
/**
- * RFC 3339 timestamp to restrict to items updated since this timestamp
- * (inclusive).
+ * RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
*/
updatedMin?: string;
/**
@@ -4134,8 +4070,7 @@ export namespace books_v1 {
/**
* books.mylibrary.bookshelves.get
- * @desc Retrieves metadata for a specific bookshelf belonging to the
- * authenticated user.
+ * @desc Retrieves metadata for a specific bookshelf belonging to the authenticated user.
* @alias books.mylibrary.bookshelves.get
* @memberOf! ()
*
@@ -4210,8 +4145,7 @@ export namespace books_v1 {
/**
* books.mylibrary.bookshelves.list
- * @desc Retrieves a list of bookshelves belonging to the authenticated
- * user.
+ * @desc Retrieves a list of bookshelves belonging to the authenticated user.
* @alias books.mylibrary.bookshelves.list
* @memberOf! ()
*
@@ -4520,8 +4454,7 @@ export namespace books_v1 {
*/
volumeId?: string;
/**
- * Position on shelf to move the item (0 puts the item before the current
- * first item, 1 puts it between the first and the second and so on.)
+ * Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)
*/
volumePosition?: number;
}
@@ -4982,8 +4915,7 @@ export namespace books_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
- * generating notification title and body.
+ * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.
*/
locale?: string;
/**
@@ -5159,8 +5091,7 @@ export namespace books_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if
- * unset.
+ * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
*/
locale?: string;
}
@@ -5176,13 +5107,11 @@ export namespace books_v1 {
*/
categoryId?: string[];
/**
- * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if
- * unset.
+ * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
*/
locale?: string;
/**
- * The maximum allowed maturity rating of returned volumes. Books with a
- * higher maturity rating are filtered out.
+ * The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
*/
maxAllowedMaturityRating?: string;
/**
@@ -5286,13 +5215,11 @@ export namespace books_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
- * generating recommendations.
+ * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
*/
locale?: string;
/**
- * The maximum allowed maturity rating of returned recommendations. Books
- * with a higher maturity rating are filtered out.
+ * The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
*/
maxAllowedMaturityRating?: string;
/**
@@ -6074,8 +6001,7 @@ export namespace books_v1 {
*/
libraryRestrict?: string;
/**
- * The maximum allowed maturity rating of returned recommendations. Books
- * with a higher maturity rating are filtered out.
+ * The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
*/
maxAllowedMaturityRating?: string;
/**
@@ -6211,13 +6137,11 @@ export namespace books_v1 {
*/
association?: string;
/**
- * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
- * generating recommendations.
+ * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
*/
locale?: string;
/**
- * The maximum allowed maturity rating of returned recommendations. Books
- * with a higher maturity rating are filtered out.
+ * The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
*/
maxAllowedMaturityRating?: string;
/**
@@ -6331,8 +6255,7 @@ export namespace books_v1 {
*/
country?: string;
/**
- * ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for
- * generating recommendations.
+ * ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.
*/
locale?: string;
/**
@@ -6340,8 +6263,7 @@ export namespace books_v1 {
*/
maxResults?: number;
/**
- * The processing state of the user uploaded volumes to be returned.
- * Applicable only if the UPLOADED is specified in the acquireMethod.
+ * The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.
*/
processingState?: string[];
/**
@@ -6531,13 +6453,11 @@ export namespace books_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
- * generating recommendations.
+ * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
*/
locale?: string;
/**
- * The maximum allowed maturity rating of returned recommendations. Books
- * with a higher maturity rating are filtered out.
+ * The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
*/
maxAllowedMaturityRating?: string;
/**
@@ -6553,8 +6473,7 @@ export namespace books_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
- * generating recommendations.
+ * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
*/
locale?: string;
/**
@@ -6663,8 +6582,7 @@ export namespace books_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
- * generating recommendations.
+ * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
*/
locale?: string;
/**
@@ -6684,8 +6602,7 @@ export namespace books_v1 {
*/
startIndex?: number;
/**
- * The ids of the volumes to be returned. If not specified all that match
- * the processingState are returned.
+ * The ids of the volumes to be returned. If not specified all that match the processingState are returned.
*/
volumeId?: string[];
}
diff --git a/src/apis/calendar/package.json b/src/apis/calendar/package.json
index d894769493b..35327134450 100644
--- a/src/apis/calendar/package.json
+++ b/src/apis/calendar/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts
index 39a6e1e0790..c6191c4a007 100644
--- a/src/apis/calendar/v3.ts
+++ b/src/apis/calendar/v3.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace calendar_v3 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace calendar_v3 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -102,7 +99,10 @@ export namespace calendar_v3 {
settings: Resource$Settings;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.acl = new Resource$Acl(this.context);
this.calendarList = new Resource$Calendarlist(this.context);
@@ -129,14 +129,11 @@ export namespace calendar_v3 {
*/
kind?: string;
/**
- * Token used to access the next page of this result. Omitted if no further
- * results are available, in which case nextSyncToken is provided.
+ * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string;
/**
- * Token used at a later point in time to retrieve only the entries that
- * have changed since this result was returned. Omitted if further results
- * are available, in which case nextPageToken is provided.
+ * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
*/
nextSyncToken?: string;
}
@@ -154,16 +151,7 @@ export namespace calendar_v3 {
*/
kind?: string;
/**
- * The role assigned to the scope. Possible values are: - "none"
- * - Provides no access. - "freeBusyReader" - Provides read
- * access to free/busy information. - "reader" - Provides read
- * access to the calendar. Private events will appear to users with reader
- * access, but event details will be hidden. - "writer" -
- * Provides read and write access to the calendar. Private events will
- * appear to users with writer access, and event details will be visible. -
- * "owner" - Provides ownership of the calendar. This role has all
- * of the permissions of the writer role with the additional ability to see
- * and manipulate ACLs.
+ * The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
role?: string;
/**
@@ -173,8 +161,7 @@ export namespace calendar_v3 {
}
export interface Schema$Calendar {
/**
- * Conferencing properties for this calendar, for example what types of
- * conferences are allowed.
+ * Conferencing properties for this calendar, for example what types of conferences are allowed.
*/
conferenceProperties?: Schema$ConferenceProperties;
/**
@@ -186,8 +173,7 @@ export namespace calendar_v3 {
*/
etag?: string;
/**
- * Identifier of the calendar. To retrieve IDs call the calendarList.list()
- * method.
+ * Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
*/
id?: string;
/**
@@ -203,8 +189,7 @@ export namespace calendar_v3 {
*/
summary?: string;
/**
- * The time zone of the calendar. (Formatted as an IANA Time Zone Database
- * name, e.g. "Europe/Zurich".) Optional.
+ * The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
*/
timeZone?: string;
}
@@ -222,49 +207,29 @@ export namespace calendar_v3 {
*/
kind?: string;
/**
- * Token used to access the next page of this result. Omitted if no further
- * results are available, in which case nextSyncToken is provided.
+ * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string;
/**
- * Token used at a later point in time to retrieve only the entries that
- * have changed since this result was returned. Omitted if further results
- * are available, in which case nextPageToken is provided.
+ * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
*/
nextSyncToken?: string;
}
export interface Schema$CalendarListEntry {
/**
- * The effective access role that the authenticated user has on the
- * calendar. Read-only. Possible values are: - "freeBusyReader"
- * - Provides read access to free/busy information. - "reader" -
- * Provides read access to the calendar. Private events will appear to users
- * with reader access, but event details will be hidden. -
- * "writer" - Provides read and write access to the calendar.
- * Private events will appear to users with writer access, and event details
- * will be visible. - "owner" - Provides ownership of the
- * calendar. This role has all of the permissions of the writer role with
- * the additional ability to see and manipulate ACLs.
+ * The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
accessRole?: string;
/**
- * The main color of the calendar in the hexadecimal format
- * "#0088aa". This property supersedes the index-based colorId
- * property. To set or change this property, you need to specify
- * colorRgbFormat=true in the parameters of the insert, update and patch
- * methods. Optional.
+ * The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
*/
backgroundColor?: string;
/**
- * The color of the calendar. This is an ID referring to an entry in the
- * calendar section of the colors definition (see the colors endpoint). This
- * property is superseded by the backgroundColor and foregroundColor
- * properties and can be ignored when using these properties. Optional.
+ * The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
*/
colorId?: string;
/**
- * Conferencing properties for this calendar, for example what types of
- * conferences are allowed.
+ * Conferencing properties for this calendar, for example what types of conferences are allowed.
*/
conferenceProperties?: Schema$ConferenceProperties;
/**
@@ -272,8 +237,7 @@ export namespace calendar_v3 {
*/
defaultReminders?: Schema$EventReminder[];
/**
- * Whether this calendar list entry has been deleted from the calendar list.
- * Read-only. Optional. The default is False.
+ * Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
*/
deleted?: boolean;
/**
@@ -285,16 +249,11 @@ export namespace calendar_v3 {
*/
etag?: string;
/**
- * The foreground color of the calendar in the hexadecimal format
- * "#ffffff". This property supersedes the index-based colorId
- * property. To set or change this property, you need to specify
- * colorRgbFormat=true in the parameters of the insert, update and patch
- * methods. Optional.
+ * The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
*/
foregroundColor?: string;
/**
- * Whether the calendar has been hidden from the list. Optional. The default
- * is False.
+ * Whether the calendar has been hidden from the list. Optional. The default is False.
*/
hidden?: boolean;
/**
@@ -306,23 +265,19 @@ export namespace calendar_v3 {
*/
kind?: string;
/**
- * Geographic location of the calendar as free-form text. Optional.
- * Read-only.
+ * Geographic location of the calendar as free-form text. Optional. Read-only.
*/
location?: string;
/**
- * The notifications that the authenticated user is receiving for this
- * calendar.
+ * The notifications that the authenticated user is receiving for this calendar.
*/
notificationSettings?: {notifications?: Schema$CalendarNotification[]};
/**
- * Whether the calendar is the primary calendar of the authenticated user.
- * Read-only. Optional. The default is False.
+ * Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
*/
primary?: boolean;
/**
- * Whether the calendar content shows up in the calendar UI. Optional. The
- * default is False.
+ * Whether the calendar content shows up in the calendar UI. Optional. The default is False.
*/
selected?: boolean;
/**
@@ -330,8 +285,7 @@ export namespace calendar_v3 {
*/
summary?: string;
/**
- * The summary that the authenticated user has set for this calendar.
- * Optional.
+ * The summary that the authenticated user has set for this calendar. Optional.
*/
summaryOverride?: string;
/**
@@ -341,25 +295,11 @@ export namespace calendar_v3 {
}
export interface Schema$CalendarNotification {
/**
- * The method used to deliver the notification. Possible values are: -
- * "email" - Notifications are sent via email. - "sms"
- * - Deprecated. Once this feature is shutdown, the API will no longer
- * return notifications using this method. Any newly added SMS notifications
- * will be ignored. See Google Calendar SMS notifications to be removed for
- * more information. Notifications are sent via SMS. This value is read-only
- * and is ignored on inserts and updates. SMS notifications are only
- * available for G Suite customers. Required when adding a notification.
+ * The method used to deliver the notification. Possible values are: - "email" - Notifications are sent via email. - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See Google Calendar SMS notifications to be removed for more information. Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers. Required when adding a notification.
*/
method?: string;
/**
- * The type of notification. Possible values are: -
- * "eventCreation" - Notification sent when a new event is put on
- * the calendar. - "eventChange" - Notification sent when an
- * event is changed. - "eventCancellation" - Notification sent
- * when an event is cancelled. - "eventResponse" - Notification
- * sent when an attendee responds to the event invitation. -
- * "agenda" - An agenda with the events of the day (sent out in
- * the morning). Required when adding a notification.
+ * The type of notification. Possible values are: - "eventCreation" - Notification sent when a new event is put on the calendar. - "eventChange" - Notification sent when an event is changed. - "eventCancellation" - Notification sent when an event is cancelled. - "eventResponse" - Notification sent when an attendee responds to the event invitation. - "agenda" - An agenda with the events of the day (sent out in the morning). Required when adding a notification.
*/
type?: string;
}
@@ -369,8 +309,7 @@ export namespace calendar_v3 {
*/
address?: string;
/**
- * Date and time of notification channel expiration, expressed as a Unix
- * timestamp, in milliseconds. Optional.
+ * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
*/
expiration?: string;
/**
@@ -378,8 +317,7 @@ export namespace calendar_v3 {
*/
id?: string;
/**
- * Identifies this as a notification channel used to watch for changes to a
- * resource. Value: the fixed string "api#channel".
+ * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
*/
kind?: string;
/**
@@ -391,8 +329,7 @@ export namespace calendar_v3 {
*/
payload?: boolean;
/**
- * An opaque ID that identifies the resource being watched on this channel.
- * Stable across different API versions.
+ * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
*/
resourceId?: string;
/**
@@ -400,8 +337,7 @@ export namespace calendar_v3 {
*/
resourceUri?: string;
/**
- * An arbitrary string delivered to the target address with each
- * notification delivered over this channel. Optional.
+ * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
*/
token?: string;
/**
@@ -415,22 +351,17 @@ export namespace calendar_v3 {
*/
background?: string;
/**
- * The foreground color that can be used to write on top of a background
- * with 'background' color.
+ * The foreground color that can be used to write on top of a background with 'background' color.
*/
foreground?: string;
}
export interface Schema$Colors {
/**
- * A global palette of calendar colors, mapping from the color ID to its
- * definition. A calendarListEntry resource refers to one of these color IDs
- * in its color field. Read-only.
+ * A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only.
*/
calendar?: {[key: string]: Schema$ColorDefinition};
/**
- * A global palette of event colors, mapping from the color ID to its
- * definition. An event resource may refer to one of these color IDs in its
- * color field. Read-only.
+ * A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only.
*/
event?: {[key: string]: Schema$ColorDefinition};
/**
@@ -438,56 +369,37 @@ export namespace calendar_v3 {
*/
kind?: string;
/**
- * Last modification time of the color palette (as a RFC3339 timestamp).
- * Read-only.
+ * Last modification time of the color palette (as a RFC3339 timestamp). Read-only.
*/
updated?: string;
}
export interface Schema$ConferenceData {
/**
- * The ID of the conference. Can be used by developers to keep track of
- * conferences, should not be displayed to users. Values for solution types:
- * - "eventHangout": unset. - "eventNamedHangout": the
- * name of the Hangout. - "hangoutsMeet": the 10-letter meeting
- * code, for example "aaa-bbbb-ccc". Optional.
+ * The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types: - "eventHangout": unset. - "eventNamedHangout": the name of the Hangout. - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
*/
conferenceId?: string;
/**
- * The conference solution, such as Hangouts or Hangouts Meet. Unset for a
- * conference with a failed create request. Either conferenceSolution and at
- * least one entryPoint, or createRequest is required.
+ * The conference solution, such as Hangouts or Hangouts Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required.
*/
conferenceSolution?: Schema$ConferenceSolution;
/**
- * A request to generate a new conference and attach it to the event. The
- * data is generated asynchronously. To see whether the data is present
- * check the status field. Either conferenceSolution and at least one
- * entryPoint, or createRequest is required.
+ * A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. Either conferenceSolution and at least one entryPoint, or createRequest is required.
*/
createRequest?: Schema$CreateConferenceRequest;
/**
- * Information about individual conference entry points, such as URLs or
- * phone numbers. All of them must belong to the same conference. Either
- * conferenceSolution and at least one entryPoint, or createRequest is
- * required.
+ * Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest is required.
*/
entryPoints?: Schema$EntryPoint[];
/**
- * Additional notes (such as instructions from the domain administrator,
- * legal notices) to display to the user. Can contain HTML. The maximum
- * length is 2048 characters. Optional.
+ * Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
*/
notes?: string;
/**
- * Additional properties related to a conference. An example would be a
- * solution-specific setting for enabling video streaming.
+ * Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
*/
parameters?: Schema$ConferenceParameters;
/**
- * The signature of the conference data. Genereated on server side. Must be
- * preserved while copying the conference data between events, otherwise the
- * conference data will not be copied. Unset for a conference with a failed
- * create request. Optional for a conference with a pending create request.
+ * The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. Unset for a conference with a failed create request. Optional for a conference with a pending create request.
*/
signature?: string;
}
@@ -502,20 +414,13 @@ export namespace calendar_v3 {
}
export interface Schema$ConferenceProperties {
/**
- * The types of conference solutions that are supported for this calendar.
- * The possible values are: - "eventHangout" -
- * "eventNamedHangout" - "hangoutsMeet" Optional.
+ * The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional.
*/
allowedConferenceSolutionTypes?: string[];
}
export interface Schema$ConferenceRequestStatus {
/**
- * The current status of the conference create request. Read-only. The
- * possible values are: - "pending": the conference create
- * request is still being processed. - "success": the conference
- * create request succeeded, the entry points are populated. -
- * "failure": the conference create request failed, there are no
- * entry points.
+ * The current status of the conference create request. Read-only. The possible values are: - "pending": the conference create request is still being processed. - "success": the conference create request succeeded, the entry points are populated. - "failure": the conference create request failed, there are no entry points.
*/
statusCode?: string;
}
@@ -525,8 +430,7 @@ export namespace calendar_v3 {
*/
iconUri?: string;
/**
- * The key which can uniquely identify the conference solution for this
- * event.
+ * The key which can uniquely identify the conference solution for this event.
*/
key?: Schema$ConferenceSolutionKey;
/**
@@ -536,13 +440,7 @@ export namespace calendar_v3 {
}
export interface Schema$ConferenceSolutionKey {
/**
- * The conference solution type. If a client encounters an unfamiliar or
- * empty type, it should still be able to display the entry points. However,
- * it should disallow modifications. The possible values are: -
- * "eventHangout" for Hangouts for consumers
- * (http://hangouts.google.com) - "eventNamedHangout" for classic
- * Hangouts for G Suite users (http://hangouts.google.com) -
- * "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
+ * The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
*/
type?: string;
}
@@ -552,9 +450,7 @@ export namespace calendar_v3 {
*/
conferenceSolutionKey?: Schema$ConferenceSolutionKey;
/**
- * The client-generated unique ID for this request. Clients should
- * regenerate this ID for every new request. If an ID provided is the same
- * as for the previous request, the request is ignored.
+ * The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
*/
requestId?: string;
/**
@@ -564,83 +460,43 @@ export namespace calendar_v3 {
}
export interface Schema$EntryPoint {
/**
- * The access code to access the conference. The maximum length is 128
- * characters. When creating new conference data, populate only the subset
- * of {meetingCode, accessCode, passcode, password, pin} fields that match
- * the terminology that the conference provider uses. Only the populated
- * fields should be displayed. Optional.
+ * The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
*/
accessCode?: string;
/**
- * Features of the entry point, such as being toll or toll-free. One entry
- * point can have multiple features. However, toll and toll-free cannot be
- * both set on the same entry point.
+ * Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
*/
entryPointFeatures?: string[];
/**
- * The type of the conference entry point. Possible values are: -
- * "video" - joining a conference over HTTP. A conference can have
- * zero or one video entry point. - "phone" - joining a conference
- * by dialing a phone number. A conference can have zero or more phone entry
- * points. - "sip" - joining a conference over SIP. A conference
- * can have zero or one sip entry point. - "more" - further
- * conference joining instructions, for example additional phone numbers. A
- * conference can have zero or one more entry point. A conference with only
- * a more entry point is not a valid conference.
+ * The type of the conference entry point. Possible values are: - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
*/
entryPointType?: string;
/**
- * The label for the URI. Visible to end users. Not localized. The maximum
- * length is 512 characters. Examples: - for video:
- * meet.google.com/aaa-bbbb-ccc - for phone: +1 123 268 2601 - for sip:
- * 12345678@altostrat.com - for more: should not be filled Optional.
+ * The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples: - for video: meet.google.com/aaa-bbbb-ccc - for phone: +1 123 268 2601 - for sip: 12345678@altostrat.com - for more: should not be filled Optional.
*/
label?: string;
/**
- * The meeting code to access the conference. The maximum length is 128
- * characters. When creating new conference data, populate only the subset
- * of {meetingCode, accessCode, passcode, password, pin} fields that match
- * the terminology that the conference provider uses. Only the populated
- * fields should be displayed. Optional.
+ * The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
*/
meetingCode?: string;
/**
- * The passcode to access the conference. The maximum length is 128
- * characters. When creating new conference data, populate only the subset
- * of {meetingCode, accessCode, passcode, password, pin} fields that match
- * the terminology that the conference provider uses. Only the populated
- * fields should be displayed.
+ * The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
*/
passcode?: string;
/**
- * The password to access the conference. The maximum length is 128
- * characters. When creating new conference data, populate only the subset
- * of {meetingCode, accessCode, passcode, password, pin} fields that match
- * the terminology that the conference provider uses. Only the populated
- * fields should be displayed. Optional.
+ * The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
*/
password?: string;
/**
- * The PIN to access the conference. The maximum length is 128 characters.
- * When creating new conference data, populate only the subset of
- * {meetingCode, accessCode, passcode, password, pin} fields that match the
- * terminology that the conference provider uses. Only the populated fields
- * should be displayed. Optional.
+ * The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
*/
pin?: string;
/**
- * The CLDR/ISO 3166 region code for the country associated with this phone
- * access. Example: "SE" for Sweden. Calendar backend will
- * populate this field only for EntryPointType.PHONE.
+ * The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE.
*/
regionCode?: string;
/**
- * The URI of the entry point. The maximum length is 1300 characters.
- * Format: - for video, http: or https: schema is required. - for phone,
- * tel: schema is required. The URI should include the entire dial sequence
- * (e.g., tel:+12345678900,,,123456789;1234). - for sip, sip: schema is
- * required, e.g., sip:12345678@myprovider.com. - for more, http: or https:
- * schema is required.
+ * The URI of the entry point. The maximum length is 1300 characters. Format: - for video, http: or https: schema is required. - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. - for more, http: or https: schema is required.
*/
uri?: string;
}
@@ -650,54 +506,33 @@ export namespace calendar_v3 {
*/
domain?: string;
/**
- * Specific reason for the error. Some of the possible values are: -
- * "groupTooBig" - The group of users requested is too large for a
- * single query. - "tooManyCalendarsRequested" - The number of
- * calendars requested is too large for a single query. -
- * "notFound" - The requested resource was not found. -
- * "internalError" - The API service has encountered an internal
- * error. Additional error types may be added in the future, so clients
- * should gracefully handle additional error statuses not included in this
- * list.
+ * Specific reason for the error. Some of the possible values are: - "groupTooBig" - The group of users requested is too large for a single query. - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query. - "notFound" - The requested resource was not found. - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.
*/
reason?: string;
}
export interface Schema$Event {
/**
- * Whether anyone can invite themselves to the event (currently works for
- * Google+ events only). Optional. The default is False.
+ * Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
*/
anyoneCanAddSelf?: boolean;
/**
- * File attachments for the event. Currently only Google Drive attachments
- * are supported. In order to modify attachments the supportsAttachments
- * request parameter should be set to true. There can be at most 25
- * attachments per event,
+ * File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
*/
attachments?: Schema$EventAttachment[];
/**
- * The attendees of the event. See the Events with attendees guide for more
- * information on scheduling events with other calendar users.
+ * The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
*/
attendees?: Schema$EventAttendee[];
/**
- * Whether attendees may have been omitted from the event's
- * representation. When retrieving an event, this may be due to a
- * restriction specified by the maxAttendee query parameter. When updating
- * an event, this can be used to only update the participant's response.
- * Optional. The default is False.
+ * Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
*/
attendeesOmitted?: boolean;
/**
- * The color of the event. This is an ID referring to an entry in the event
- * section of the colors definition (see the colors endpoint). Optional.
+ * The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
*/
colorId?: string;
/**
- * The conference-related information, such as details of a Hangouts Meet
- * conference. To create new conference details use the createRequest field.
- * To persist your changes, remember to set the conferenceDataVersion
- * request parameter to 1 for all event modification requests.
+ * The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
*/
conferenceData?: Schema$ConferenceData;
/**
@@ -718,14 +553,11 @@ export namespace calendar_v3 {
*/
description?: string;
/**
- * The (exclusive) end time of the event. For a recurring event, this is the
- * end time of the first instance.
+ * The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
*/
end?: Schema$EventDateTime;
/**
- * Whether the end time is actually unspecified. An end time is still
- * provided for compatibility reasons, even if this attribute is set to
- * True. The default is False.
+ * Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
*/
endTimeUnspecified?: boolean;
/**
@@ -753,23 +585,19 @@ export namespace calendar_v3 {
width?: number;
};
/**
- * Whether attendees other than the organizer can invite others to the
- * event. Optional. The default is True.
+ * Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
*/
guestsCanInviteOthers?: boolean;
/**
- * Whether attendees other than the organizer can modify the event.
- * Optional. The default is False.
+ * Whether attendees other than the organizer can modify the event. Optional. The default is False.
*/
guestsCanModify?: boolean;
/**
- * Whether attendees other than the organizer can see who the event's
- * attendees are. Optional. The default is True.
+ * Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
*/
guestsCanSeeOtherGuests?: boolean;
/**
- * An absolute link to the Google+ hangout associated with this event.
- * Read-only.
+ * An absolute link to the Google+ hangout associated with this event. Read-only.
*/
hangoutLink?: string;
/**
@@ -777,30 +605,11 @@ export namespace calendar_v3 {
*/
htmlLink?: string;
/**
- * Event unique identifier as defined in RFC5545. It is used to uniquely
- * identify events accross calendaring systems and must be supplied when
- * importing events via the import method. Note that the icalUID and the id
- * are not identical and only one of them should be supplied at event
- * creation time. One difference in their semantics is that in recurring
- * events, all occurrences of one event have different ids while they all
- * share the same icalUIDs.
+ * Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
*/
iCalUID?: string;
/**
- * Opaque identifier of the event. When creating new single or recurring
- * events, you can specify their IDs. Provided IDs must follow these rules:
- * - characters allowed in the ID are those used in base32hex encoding, i.e.
- * lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the
- * length of the ID must be between 5 and 1024 characters - the ID must be
- * unique per calendar Due to the globally distributed nature of the
- * system, we cannot guarantee that ID collisions will be detected at event
- * creation time. To minimize the risk of collisions we recommend using an
- * established UUID algorithm such as one described in RFC4122. If you do
- * not specify an ID, it will be automatically generated by the server. Note
- * that the icalUID and the id are not identical and only one of them should
- * be supplied at event creation time. One difference in their semantics is
- * that in recurring events, all occurrences of one event have different ids
- * while they all share the same icalUIDs.
+ * Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
*/
id?: string;
/**
@@ -812,17 +621,11 @@ export namespace calendar_v3 {
*/
location?: string;
/**
- * Whether this is a locked event copy where no changes can be made to the
- * main event fields "summary", "description",
- * "location", "start", "end" or
- * "recurrence". The default is False. Read-Only.
+ * Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
*/
locked?: boolean;
/**
- * The organizer of the event. If the organizer is also an attendee, this is
- * indicated with a separate entry in attendees with the organizer field set
- * to True. To change the organizer, use the move operation. Read-only,
- * except when importing an event.
+ * The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
*/
organizer?: {
displayName?: string;
@@ -831,30 +634,19 @@ export namespace calendar_v3 {
self?: boolean;
};
/**
- * For an instance of a recurring event, this is the time at which this
- * event would start according to the recurrence data in the recurring event
- * identified by recurringEventId. It uniquely identifies the instance
- * within the recurring event series even if the instance was moved to a
- * different time. Immutable.
+ * For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
*/
originalStartTime?: Schema$EventDateTime;
/**
- * Whether this is a private event copy where changes are not shared with
- * other copies on other calendars. Optional. Immutable. The default is
- * False.
+ * Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
*/
privateCopy?: boolean;
/**
- * List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as
- * specified in RFC5545. Note that DTSTART and DTEND lines are not allowed
- * in this field; event start and end times are specified in the start and
- * end fields. This field is omitted for single events or instances of
- * recurring events.
+ * List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
*/
recurrence?: string[];
/**
- * For an instance of a recurring event, this is the id of the recurring
- * event to which this instance belongs. Immutable.
+ * For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
*/
recurringEventId?: string;
/**
@@ -866,43 +658,15 @@ export namespace calendar_v3 {
*/
sequence?: number;
/**
- * Source from which the event was created. For example, a web page, an
- * email message or any document identifiable by an URL with HTTP or HTTPS
- * scheme. Can only be seen or modified by the creator of the event.
+ * Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
*/
source?: {title?: string; url?: string};
/**
- * The (inclusive) start time of the event. For a recurring event, this is
- * the start time of the first instance.
+ * The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
*/
start?: Schema$EventDateTime;
/**
- * Status of the event. Optional. Possible values are: -
- * "confirmed" - The event is confirmed. This is the default
- * status. - "tentative" - The event is tentatively confirmed. -
- * "cancelled" - The event is cancelled (deleted). The list method
- * returns cancelled events only on incremental sync (when syncToken or
- * updatedMin are specified) or if the showDeleted flag is set to true. The
- * get method always returns them. A cancelled status represents two
- * different states depending on the event type: - Cancelled exceptions of
- * an uncancelled recurring event indicate that this instance should no
- * longer be presented to the user. Clients should store these events for
- * the lifetime of the parent recurring event. Cancelled exceptions are only
- * guaranteed to have values for the id, recurringEventId and
- * originalStartTime fields populated. The other fields might be empty. -
- * All other cancelled events represent deleted events. Clients should
- * remove their locally synced copies. Such cancelled events will eventually
- * disappear, so do not rely on them being available indefinitely. Deleted
- * events are only guaranteed to have the id field populated. On the
- * organizer's calendar, cancelled events continue to expose event
- * details (summary, location, etc.) so that they can be restored
- * (undeleted). Similarly, the events to which the user was invited and that
- * they manually removed continue to provide details. However, incremental
- * sync requests with showDeleted set to false will not return these
- * details. If an event changes its organizer (for example via the move
- * operation) and the original organizer is not on the attendee list, it
- * will leave behind a cancelled event where only the id field is guaranteed
- * to be populated.
+ * Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
*/
status?: string;
/**
@@ -910,12 +674,7 @@ export namespace calendar_v3 {
*/
summary?: string;
/**
- * Whether the event blocks time on the calendar. Optional. Possible values
- * are: - "opaque" - Default value. The event does block time on
- * the calendar. This is equivalent to setting Show me as to Busy in the
- * Calendar UI. - "transparent" - The event does not block time
- * on the calendar. This is equivalent to setting Show me as to Available in
- * the Calendar UI.
+ * Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
*/
transparency?: string;
/**
@@ -923,26 +682,17 @@ export namespace calendar_v3 {
*/
updated?: string;
/**
- * Visibility of the event. Optional. Possible values are: -
- * "default" - Uses the default visibility for events on the
- * calendar. This is the default value. - "public" - The event is
- * public and event details are visible to all readers of the calendar. -
- * "private" - The event is private and only event attendees may
- * view event details. - "confidential" - The event is private.
- * This value is provided for compatibility reasons.
+ * Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.
*/
visibility?: string;
}
export interface Schema$EventAttachment {
/**
- * ID of the attached file. Read-only. For Google Drive files, this is the
- * ID of the corresponding Files resource entry in the Drive API.
+ * ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
*/
fileId?: string;
/**
- * URL link to the attachment. For adding Google Drive file attachments use
- * the same format as in alternateLink property of the Files resource in the
- * Drive API. Required when adding an attachment.
+ * URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment.
*/
fileUrl?: string;
/**
@@ -972,14 +722,11 @@ export namespace calendar_v3 {
*/
displayName?: string;
/**
- * The attendee's email address, if available. This field must be
- * present when adding an attendee. It must be a valid email address as per
- * RFC5322. Required when adding an attendee.
+ * The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee.
*/
email?: string;
/**
- * The attendee's Profile ID, if available. It corresponds to the id
- * field in the People collection of the Google+ API
+ * The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
*/
id?: string;
/**
@@ -987,91 +734,53 @@ export namespace calendar_v3 {
*/
optional?: boolean;
/**
- * Whether the attendee is the organizer of the event. Read-only. The
- * default is False.
+ * Whether the attendee is the organizer of the event. Read-only. The default is False.
*/
organizer?: boolean;
/**
- * Whether the attendee is a resource. Can only be set when the attendee is
- * added to the event for the first time. Subsequent modifications are
- * ignored. Optional. The default is False.
+ * Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
*/
resource?: boolean;
/**
- * The attendee's response status. Possible values are: -
- * "needsAction" - The attendee has not responded to the
- * invitation. - "declined" - The attendee has declined the
- * invitation. - "tentative" - The attendee has tentatively
- * accepted the invitation. - "accepted" - The attendee has
- * accepted the invitation.
+ * The attendee's response status. Possible values are: - "needsAction" - The attendee has not responded to the invitation. - "declined" - The attendee has declined the invitation. - "tentative" - The attendee has tentatively accepted the invitation. - "accepted" - The attendee has accepted the invitation.
*/
responseStatus?: string;
/**
- * Whether this entry represents the calendar on which this copy of the
- * event appears. Read-only. The default is False.
+ * Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
*/
self?: boolean;
}
export interface Schema$EventDateTime {
/**
- * The date, in the format "yyyy-mm-dd", if this is an all-day
- * event.
+ * The date, in the format "yyyy-mm-dd", if this is an all-day event.
*/
date?: string;
/**
- * The time, as a combined date-time value (formatted according to RFC3339).
- * A time zone offset is required unless a time zone is explicitly specified
- * in timeZone.
+ * The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
*/
dateTime?: string;
/**
- * The time zone in which the time is specified. (Formatted as an IANA Time
- * Zone Database name, e.g. "Europe/Zurich".) For recurring events
- * this field is required and specifies the time zone in which the
- * recurrence is expanded. For single events this field is optional and
- * indicates a custom time zone for the event start/end.
+ * The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
*/
timeZone?: string;
}
export interface Schema$EventReminder {
/**
- * The method used by this reminder. Possible values are: -
- * "email" - Reminders are sent via email. - "sms" -
- * Deprecated. Once this feature is shutdown, the API will no longer return
- * reminders using this method. Any newly added SMS reminders will be
- * ignored. See Google Calendar SMS notifications to be removed for more
- * information. Reminders are sent via SMS. These are only available for G
- * Suite customers. Requests to set SMS reminders for other account types
- * are ignored. - "popup" - Reminders are sent via a UI popup.
- * Required when adding a reminder.
+ * The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder.
*/
method?: string;
/**
- * Number of minutes before the start of the event when the reminder should
- * trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
- * Required when adding a reminder.
+ * Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder.
*/
minutes?: number;
}
export interface Schema$Events {
/**
- * The user's access role for this calendar. Read-only. Possible values
- * are: - "none" - The user has no access. -
- * "freeBusyReader" - The user has read access to free/busy
- * information. - "reader" - The user has read access to the
- * calendar. Private events will appear to users with reader access, but
- * event details will be hidden. - "writer" - The user has read
- * and write access to the calendar. Private events will appear to users
- * with writer access, and event details will be visible. -
- * "owner" - The user has ownership of the calendar. This role has
- * all of the permissions of the writer role with the additional ability to
- * see and manipulate ACLs.
+ * The user's access role for this calendar. Read-only. Possible values are: - "none" - The user has no access. - "freeBusyReader" - The user has read access to free/busy information. - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
accessRole?: string;
/**
- * The default reminders on the calendar for the authenticated user. These
- * reminders apply to all events on this calendar that do not explicitly
- * override them (i.e. do not have reminders.useDefault set to True).
+ * The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).
*/
defaultReminders?: Schema$EventReminder[];
/**
@@ -1091,14 +800,11 @@ export namespace calendar_v3 {
*/
kind?: string;
/**
- * Token used to access the next page of this result. Omitted if no further
- * results are available, in which case nextSyncToken is provided.
+ * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string;
/**
- * Token used at a later point in time to retrieve only the entries that
- * have changed since this result was returned. Omitted if further results
- * are available, in which case nextPageToken is provided.
+ * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
*/
nextSyncToken?: string;
/**
@@ -1110,15 +816,13 @@ export namespace calendar_v3 {
*/
timeZone?: string;
/**
- * Last modification time of the calendar (as a RFC3339 timestamp).
- * Read-only.
+ * Last modification time of the calendar (as a RFC3339 timestamp). Read-only.
*/
updated?: string;
}
export interface Schema$FreeBusyCalendar {
/**
- * List of time ranges during which this calendar should be regarded as
- * busy.
+ * List of time ranges during which this calendar should be regarded as busy.
*/
busy?: Schema$TimePeriod[];
/**
@@ -1138,14 +842,11 @@ export namespace calendar_v3 {
}
export interface Schema$FreeBusyRequest {
/**
- * Maximal number of calendars for which FreeBusy information is to be
- * provided. Optional. Maximum value is 50.
+ * Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
*/
calendarExpansionMax?: number;
/**
- * Maximal number of calendar identifiers to be provided for a single group.
- * Optional. An error is returned for a group with more members than this
- * value. Maximum value is 100.
+ * Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.
*/
groupExpansionMax?: number;
/**
@@ -1207,9 +908,7 @@ export namespace calendar_v3 {
*/
kind?: string;
/**
- * Value of the user setting. The format of the value depends on the ID of
- * the setting. It must always be a UTF-8 string of length up to 1024
- * characters.
+ * Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.
*/
value?: string;
}
@@ -1227,14 +926,11 @@ export namespace calendar_v3 {
*/
kind?: string;
/**
- * Token used to access the next page of this result. Omitted if no further
- * results are available, in which case nextSyncToken is provided.
+ * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string;
/**
- * Token used at a later point in time to retrieve only the entries that
- * have changed since this result was returned. Omitted if further results
- * are available, in which case nextPageToken is provided.
+ * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
*/
nextSyncToken?: string;
}
@@ -1547,8 +1243,7 @@ export namespace calendar_v3 {
/**
* calendar.acl.patch
- * @desc Updates an access control rule. This method supports patch
- * semantics.
+ * @desc Updates an access control rule. This method supports patch semantics.
* @alias calendar.acl.patch
* @memberOf! ()
*
@@ -1775,9 +1470,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
@@ -1792,9 +1485,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
@@ -1809,14 +1500,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Whether to send notifications about the calendar sharing change.
- * Optional. The default is True.
+ * Whether to send notifications about the calendar sharing change. Optional. The default is True.
*/
sendNotifications?: boolean;
@@ -1832,15 +1520,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Maximum number of entries returned on one result page. By default the
- * value is 100 entries. The page size can never be larger than 250 entries.
- * Optional.
+ * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
@@ -1848,21 +1532,11 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Whether to include deleted ACLs in the result. Deleted ACLs are
- * represented by role equal to "none". Deleted ACLs will always be included
- * if syncToken is provided. Optional. The default is False.
+ * Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
*/
showDeleted?: boolean;
/**
- * Token obtained from the nextSyncToken field returned on the last page of
- * results from the previous list request. It makes the result of this list
- * request contain only entries that have changed since then. All entries
- * deleted since the previous list request will always be in the result set
- * and it is not allowed to set showDeleted to False. If the syncToken
- * expires, the server will respond with a 410 GONE response code and the
- * client should clear its storage and perform a full synchronization
- * without any syncToken. Learn more about incremental synchronization.
- * Optional. The default is to return all entries.
+ * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
}
@@ -1873,9 +1547,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
@@ -1883,9 +1555,7 @@ export namespace calendar_v3 {
*/
ruleId?: string;
/**
- * Whether to send notifications about the calendar sharing change. Note
- * that there are no notifications on access removal. Optional. The default
- * is True.
+ * Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
*/
sendNotifications?: boolean;
@@ -1901,9 +1571,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
@@ -1911,9 +1579,7 @@ export namespace calendar_v3 {
*/
ruleId?: string;
/**
- * Whether to send notifications about the calendar sharing change. Note
- * that there are no notifications on access removal. Optional. The default
- * is True.
+ * Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
*/
sendNotifications?: boolean;
@@ -1929,15 +1595,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Maximum number of entries returned on one result page. By default the
- * value is 100 entries. The page size can never be larger than 250 entries.
- * Optional.
+ * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
@@ -1945,21 +1607,11 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Whether to include deleted ACLs in the result. Deleted ACLs are
- * represented by role equal to "none". Deleted ACLs will always be included
- * if syncToken is provided. Optional. The default is False.
+ * Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
*/
showDeleted?: boolean;
/**
- * Token obtained from the nextSyncToken field returned on the last page of
- * results from the previous list request. It makes the result of this list
- * request contain only entries that have changed since then. All entries
- * deleted since the previous list request will always be in the result set
- * and it is not allowed to set showDeleted to False. If the syncToken
- * expires, the server will respond with a 410 GONE response code and the
- * client should clear its storage and perform a full synchronization
- * without any syncToken. Learn more about incremental synchronization.
- * Optional. The default is to return all entries.
+ * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
@@ -2274,8 +1926,7 @@ export namespace calendar_v3 {
/**
* calendar.calendarList.patch
- * @desc Updates an existing calendar on the user's calendar list. This
- * method supports patch semantics.
+ * @desc Updates an existing calendar on the user's calendar list. This method supports patch semantics.
* @alias calendar.calendarList.patch
* @memberOf! ()
*
@@ -2510,9 +2161,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
@@ -2523,9 +2172,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
@@ -2537,10 +2184,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to use the foregroundColor and backgroundColor fields to write
- * the calendar colors (RGB). If this feature is used, the index-based
- * colorId field will be set to the best matching option automatically.
- * Optional. The default is False.
+ * Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
*/
colorRgbFormat?: boolean;
@@ -2557,14 +2201,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Maximum number of entries returned on one result page. By default the
- * value is 100 entries. The page size can never be larger than 250 entries.
- * Optional.
+ * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
- * The minimum access role for the user in the returned entries. Optional.
- * The default is no restriction.
+ * The minimum access role for the user in the returned entries. Optional. The default is no restriction.
*/
minAccessRole?: string;
/**
@@ -2572,8 +2213,7 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Whether to include deleted calendar list entries in the result. Optional.
- * The default is False.
+ * Whether to include deleted calendar list entries in the result. Optional. The default is False.
*/
showDeleted?: boolean;
/**
@@ -2581,19 +2221,7 @@ export namespace calendar_v3 {
*/
showHidden?: boolean;
/**
- * Token obtained from the nextSyncToken field returned on the last page of
- * results from the previous list request. It makes the result of this list
- * request contain only entries that have changed since then. If only
- * read-only fields such as calendar properties or ACLs have changed, the
- * entry won't be returned. All entries deleted and hidden since the
- * previous list request will always be in the result set and it is not
- * allowed to set showDeleted neither showHidden to False. To ensure client
- * state consistency minAccessRole query parameter cannot be specified
- * together with nextSyncToken. If the syncToken expires, the server will
- * respond with a 410 GONE response code and the client should clear its
- * storage and perform a full synchronization without any syncToken. Learn
- * more about incremental synchronization. Optional. The default is to
- * return all entries.
+ * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
}
@@ -2605,16 +2233,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Whether to use the foregroundColor and backgroundColor fields to write
- * the calendar colors (RGB). If this feature is used, the index-based
- * colorId field will be set to the best matching option automatically.
- * Optional. The default is False.
+ * Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
*/
colorRgbFormat?: boolean;
@@ -2631,16 +2254,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Whether to use the foregroundColor and backgroundColor fields to write
- * the calendar colors (RGB). If this feature is used, the index-based
- * colorId field will be set to the best matching option automatically.
- * Optional. The default is False.
+ * Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
*/
colorRgbFormat?: boolean;
@@ -2657,14 +2275,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Maximum number of entries returned on one result page. By default the
- * value is 100 entries. The page size can never be larger than 250 entries.
- * Optional.
+ * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
- * The minimum access role for the user in the returned entries. Optional.
- * The default is no restriction.
+ * The minimum access role for the user in the returned entries. Optional. The default is no restriction.
*/
minAccessRole?: string;
/**
@@ -2672,8 +2287,7 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Whether to include deleted calendar list entries in the result. Optional.
- * The default is False.
+ * Whether to include deleted calendar list entries in the result. Optional. The default is False.
*/
showDeleted?: boolean;
/**
@@ -2681,19 +2295,7 @@ export namespace calendar_v3 {
*/
showHidden?: boolean;
/**
- * Token obtained from the nextSyncToken field returned on the last page of
- * results from the previous list request. It makes the result of this list
- * request contain only entries that have changed since then. If only
- * read-only fields such as calendar properties or ACLs have changed, the
- * entry won't be returned. All entries deleted and hidden since the
- * previous list request will always be in the result set and it is not
- * allowed to set showDeleted neither showHidden to False. To ensure client
- * state consistency minAccessRole query parameter cannot be specified
- * together with nextSyncToken. If the syncToken expires, the server will
- * respond with a 410 GONE response code and the client should clear its
- * storage and perform a full synchronization without any syncToken. Learn
- * more about incremental synchronization. Optional. The default is to
- * return all entries.
+ * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
@@ -2711,8 +2313,7 @@ export namespace calendar_v3 {
/**
* calendar.calendars.clear
- * @desc Clears a primary calendar. This operation deletes all events
- * associated with the primary calendar of an account.
+ * @desc Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
* @alias calendar.calendars.clear
* @memberOf! ()
*
@@ -2782,8 +2383,7 @@ export namespace calendar_v3 {
/**
* calendar.calendars.delete
- * @desc Deletes a secondary calendar. Use calendars.clear for clearing all
- * events on primary calendars.
+ * @desc Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
* @alias calendar.calendars.delete
* @memberOf! ()
*
@@ -2996,8 +2596,7 @@ export namespace calendar_v3 {
/**
* calendar.calendars.patch
- * @desc Updates metadata for a calendar. This method supports patch
- * semantics.
+ * @desc Updates metadata for a calendar. This method supports patch semantics.
* @alias calendar.calendars.patch
* @memberOf! ()
*
@@ -3147,9 +2746,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
@@ -3160,9 +2757,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
@@ -3173,9 +2768,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
@@ -3197,9 +2790,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
@@ -3215,9 +2806,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
@@ -3556,8 +3145,7 @@ export namespace calendar_v3 {
/**
* calendar.events.import
- * @desc Imports an event. This operation is used to add a private copy of an
- * existing event to a calendar.
+ * @desc Imports an event. This operation is used to add a private copy of an existing event to a calendar.
* @alias calendar.events.import
* @memberOf! ()
*
@@ -3806,8 +3394,8 @@ export namespace calendar_v3 {
* @param {boolean=} params.showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False.
* @param {boolean=} params.singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
- * @param {string=} params.timeMax Upper bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
- * @param {string=} params.timeMin Lower bound (inclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
+ * @param {string=} params.timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
+ * @param {string=} params.timeMin Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
* @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar.
* @param {string=} params.updatedMin Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3874,8 +3462,7 @@ export namespace calendar_v3 {
/**
* calendar.events.move
- * @desc Moves an event to another calendar, i.e. changes an event's
- * organizer.
+ * @desc Moves an event to another calendar, i.e. changes an event's organizer.
* @alias calendar.events.move
* @memberOf! ()
*
@@ -4198,8 +3785,8 @@ export namespace calendar_v3 {
* @param {boolean=} params.showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False.
* @param {boolean=} params.singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
- * @param {string=} params.timeMax Upper bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
- * @param {string=} params.timeMin Lower bound (inclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
+ * @param {string=} params.timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
+ * @param {string=} params.timeMin Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
* @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar.
* @param {string=} params.updatedMin Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
* @param {().Channel} params.resource Request body data
@@ -4273,9 +3860,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
@@ -4283,10 +3868,7 @@ export namespace calendar_v3 {
*/
eventId?: string;
/**
- * Deprecated. Please use sendUpdates instead. Whether to send
- * notifications about the deletion of the event. Note that some emails
- * might still be sent even if you set the value to false. The default is
- * false.
+ * Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
@@ -4301,18 +3883,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to always include a value in the email field for the organizer,
- * creator and attendees, even if no real email is available (i.e. a
- * generated, non-working value will be provided). The use of this option is
- * discouraged and should only be used by clients which cannot handle the
- * absence of an email address value in the mentioned places. Optional. The
- * default is False.
+ * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
@@ -4320,14 +3895,11 @@ export namespace calendar_v3 {
*/
eventId?: string;
/**
- * The maximum number of attendees to include in the response. If there are
- * more than the specified number of attendees, only the participant is
- * returned. Optional.
+ * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
- * Time zone used in the response. Optional. The default is the time zone of
- * the calendar.
+ * Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
}
@@ -4338,22 +3910,15 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Version number of conference data supported by the API client. Version 0
- * assumes no conference data support and ignores conference data in the
- * event's body. Version 1 enables support for copying of ConferenceData as
- * well as for creating new conferences using the createRequest field of
- * conferenceData. The default is 0.
+ * Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
- * Whether API client performing operation supports event attachments.
- * Optional. The default is False.
+ * Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
@@ -4369,40 +3934,27 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Version number of conference data supported by the API client. Version 0
- * assumes no conference data support and ignores conference data in the
- * event's body. Version 1 enables support for copying of ConferenceData as
- * well as for creating new conferences using the createRequest field of
- * conferenceData. The default is 0.
+ * Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
- * The maximum number of attendees to include in the response. If there are
- * more than the specified number of attendees, only the participant is
- * returned. Optional.
+ * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
- * Deprecated. Please use sendUpdates instead. Whether to send
- * notifications about the creation of the new event. Note that some emails
- * might still be sent even if you set the value to false. The default is
- * false.
+ * Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
- * Whether to send notifications about the creation of the new event. Note
- * that some emails might still be sent. The default is false.
+ * Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
*/
sendUpdates?: string;
/**
- * Whether API client performing operation supports event attachments.
- * Optional. The default is False.
+ * Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
@@ -4418,18 +3970,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to always include a value in the email field for the organizer,
- * creator and attendees, even if no real email is available (i.e. a
- * generated, non-working value will be provided). The use of this option is
- * discouraged and should only be used by clients which cannot handle the
- * absence of an email address value in the mentioned places. Optional. The
- * default is False.
+ * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
@@ -4437,15 +3982,11 @@ export namespace calendar_v3 {
*/
eventId?: string;
/**
- * The maximum number of attendees to include in the response. If there are
- * more than the specified number of attendees, only the participant is
- * returned. Optional.
+ * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
- * Maximum number of events returned on one result page. By default the
- * value is 250 events. The page size can never be larger than 2500 events.
- * Optional.
+ * Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
*/
maxResults?: number;
/**
@@ -4457,26 +3998,19 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Whether to include deleted events (with status equals "cancelled") in the
- * result. Cancelled instances of recurring events will still be included if
- * singleEvents is False. Optional. The default is False.
+ * Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
*/
showDeleted?: boolean;
/**
- * Upper bound (exclusive) for an event's start time to filter by. Optional.
- * The default is not to filter by start time. Must be an RFC3339 timestamp
- * with mandatory time zone offset.
+ * Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.
*/
timeMax?: string;
/**
- * Lower bound (inclusive) for an event's end time to filter by. Optional.
- * The default is not to filter by end time. Must be an RFC3339 timestamp
- * with mandatory time zone offset.
+ * Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.
*/
timeMin?: string;
/**
- * Time zone used in the response. Optional. The default is the time zone of
- * the calendar.
+ * Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
}
@@ -4487,43 +4021,27 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to always include a value in the email field for the organizer,
- * creator and attendees, even if no real email is available (i.e. a
- * generated, non-working value will be provided). The use of this option is
- * discouraged and should only be used by clients which cannot handle the
- * absence of an email address value in the mentioned places. Optional. The
- * default is False.
+ * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Specifies event ID in the iCalendar format to be included in the
- * response. Optional.
+ * Specifies event ID in the iCalendar format to be included in the response. Optional.
*/
iCalUID?: string;
/**
- * The maximum number of attendees to include in the response. If there are
- * more than the specified number of attendees, only the participant is
- * returned. Optional.
+ * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
- * Maximum number of events returned on one result page. The number of
- * events in the resulting page may be less than this value, or none at all,
- * even if there are more events matching the query. Incomplete pages can be
- * detected by a non-empty nextPageToken field in the response. By default
- * the value is 250 events. The page size can never be larger than 2500
- * events. Optional.
+ * Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
*/
maxResults?: number;
/**
- * The order of the events returned in the result. Optional. The default is
- * an unspecified, stable order.
+ * The order of the events returned in the result. Optional. The default is an unspecified, stable order.
*/
orderBy?: string;
/**
@@ -4531,84 +4049,47 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Extended properties constraint specified as propertyName=value. Matches
- * only private properties. This parameter might be repeated multiple times
- * to return events that match all given constraints.
+ * Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
*/
privateExtendedProperty?: string[];
/**
- * Free text search terms to find events that match these terms in any
- * field, except for extended properties. Optional.
+ * Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
*/
q?: string;
/**
- * Extended properties constraint specified as propertyName=value. Matches
- * only shared properties. This parameter might be repeated multiple times
- * to return events that match all given constraints.
+ * Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
*/
sharedExtendedProperty?: string[];
/**
- * Whether to include deleted events (with status equals "cancelled") in the
- * result. Cancelled instances of recurring events (but not the underlying
- * recurring event) will still be included if showDeleted and singleEvents
- * are both False. If showDeleted and singleEvents are both True, only
- * single instances of deleted events (but not the underlying recurring
- * events) are returned. Optional. The default is False.
+ * Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
*/
showDeleted?: boolean;
/**
- * Whether to include hidden invitations in the result. Optional. The
- * default is False.
+ * Whether to include hidden invitations in the result. Optional. The default is False.
*/
showHiddenInvitations?: boolean;
/**
- * Whether to expand recurring events into instances and only return single
- * one-off events and instances of recurring events, but not the underlying
- * recurring events themselves. Optional. The default is False.
+ * Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
*/
singleEvents?: boolean;
/**
- * Token obtained from the nextSyncToken field returned on the last page of
- * results from the previous list request. It makes the result of this list
- * request contain only entries that have changed since then. All events
- * deleted since the previous list request will always be in the result set
- * and it is not allowed to set showDeleted to False. There are several
- * query parameters that cannot be specified together with nextSyncToken to
- * ensure consistency of the client state. These are: - iCalUID - orderBy
- * - privateExtendedProperty - q - sharedExtendedProperty - timeMin -
- * timeMax - updatedMin If the syncToken expires, the server will respond
- * with a 410 GONE response code and the client should clear its storage and
- * perform a full synchronization without any syncToken. Learn more about
- * incremental synchronization. Optional. The default is to return all
- * entries.
+ * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
/**
- * Upper bound (exclusive) for an event's end time to filter by. Optional.
- * The default is not to filter by end time. Must be an RFC3339 timestamp
- * with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00,
- * 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If
- * timeMin is set, timeMax must be greater than timeMin.
+ * Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
*/
timeMax?: string;
/**
- * Lower bound (inclusive) for an event's start time to filter by. Optional.
- * The default is not to filter by start time. Must be an RFC3339 timestamp
- * with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00,
- * 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If
- * timeMax is set, timeMin must be smaller than timeMax.
+ * Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
*/
timeMin?: string;
/**
- * Time zone used in the response. Optional. The default is the time zone of
- * the calendar.
+ * Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
/**
- * Lower bound for an event's last modification time (as a RFC3339
- * timestamp) to filter by. When specified, entries deleted since this time
- * will always be included regardless of showDeleted. Optional. The default
- * is not to filter by last modification time.
+ * Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
*/
updatedMin?: string;
}
@@ -4619,13 +4100,11 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier of the source calendar where the event currently is
- * on.
+ * Calendar identifier of the source calendar where the event currently is on.
*/
calendarId?: string;
/**
- * Calendar identifier of the target calendar where the event is to be moved
- * to.
+ * Calendar identifier of the target calendar where the event is to be moved to.
*/
destination?: string;
/**
@@ -4633,15 +4112,11 @@ export namespace calendar_v3 {
*/
eventId?: string;
/**
- * Deprecated. Please use sendUpdates instead. Whether to send
- * notifications about the change of the event's organizer. Note that some
- * emails might still be sent even if you set the value to false. The
- * default is false.
+ * Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
- * Guests who should receive notifications about the change of the event's
- * organizer.
+ * Guests who should receive notifications about the change of the event's organizer.
*/
sendUpdates?: string;
}
@@ -4652,26 +4127,15 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to always include a value in the email field for the organizer,
- * creator and attendees, even if no real email is available (i.e. a
- * generated, non-working value will be provided). The use of this option is
- * discouraged and should only be used by clients which cannot handle the
- * absence of an email address value in the mentioned places. Optional. The
- * default is False.
+ * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Version number of conference data supported by the API client. Version 0
- * assumes no conference data support and ignores conference data in the
- * event's body. Version 1 enables support for copying of ConferenceData as
- * well as for creating new conferences using the createRequest field of
- * conferenceData. The default is 0.
+ * Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
@@ -4679,26 +4143,19 @@ export namespace calendar_v3 {
*/
eventId?: string;
/**
- * The maximum number of attendees to include in the response. If there are
- * more than the specified number of attendees, only the participant is
- * returned. Optional.
+ * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
- * Deprecated. Please use sendUpdates instead. Whether to send
- * notifications about the event update (for example, description changes,
- * etc.). Note that some emails might still be sent even if you set the
- * value to false. The default is false.
+ * Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
- * Guests who should receive notifications about the event update (for
- * example, title changes, etc.).
+ * Guests who should receive notifications about the event update (for example, title changes, etc.).
*/
sendUpdates?: string;
/**
- * Whether API client performing operation supports event attachments.
- * Optional. The default is False.
+ * Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
@@ -4714,21 +4171,15 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Deprecated. Please use sendUpdates instead. Whether to send
- * notifications about the creation of the event. Note that some emails
- * might still be sent even if you set the value to false. The default is
- * false.
+ * Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
- * Guests who should receive notifications about the creation of the new
- * event.
+ * Guests who should receive notifications about the creation of the new event.
*/
sendUpdates?: string;
/**
@@ -4743,26 +4194,15 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to always include a value in the email field for the organizer,
- * creator and attendees, even if no real email is available (i.e. a
- * generated, non-working value will be provided). The use of this option is
- * discouraged and should only be used by clients which cannot handle the
- * absence of an email address value in the mentioned places. Optional. The
- * default is False.
+ * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Version number of conference data supported by the API client. Version 0
- * assumes no conference data support and ignores conference data in the
- * event's body. Version 1 enables support for copying of ConferenceData as
- * well as for creating new conferences using the createRequest field of
- * conferenceData. The default is 0.
+ * Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
@@ -4770,26 +4210,19 @@ export namespace calendar_v3 {
*/
eventId?: string;
/**
- * The maximum number of attendees to include in the response. If there are
- * more than the specified number of attendees, only the participant is
- * returned. Optional.
+ * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
- * Deprecated. Please use sendUpdates instead. Whether to send
- * notifications about the event update (for example, description changes,
- * etc.). Note that some emails might still be sent even if you set the
- * value to false. The default is false.
+ * Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
- * Guests who should receive notifications about the event update (for
- * example, title changes, etc.).
+ * Guests who should receive notifications about the event update (for example, title changes, etc.).
*/
sendUpdates?: string;
/**
- * Whether API client performing operation supports event attachments.
- * Optional. The default is False.
+ * Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
@@ -4805,43 +4238,27 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Whether to always include a value in the email field for the organizer,
- * creator and attendees, even if no real email is available (i.e. a
- * generated, non-working value will be provided). The use of this option is
- * discouraged and should only be used by clients which cannot handle the
- * absence of an email address value in the mentioned places. Optional. The
- * default is False.
+ * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
- * Calendar identifier. To retrieve calendar IDs call the calendarList.list
- * method. If you want to access the primary calendar of the currently
- * logged in user, use the "primary" keyword.
+ * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
- * Specifies event ID in the iCalendar format to be included in the
- * response. Optional.
+ * Specifies event ID in the iCalendar format to be included in the response. Optional.
*/
iCalUID?: string;
/**
- * The maximum number of attendees to include in the response. If there are
- * more than the specified number of attendees, only the participant is
- * returned. Optional.
+ * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
- * Maximum number of events returned on one result page. The number of
- * events in the resulting page may be less than this value, or none at all,
- * even if there are more events matching the query. Incomplete pages can be
- * detected by a non-empty nextPageToken field in the response. By default
- * the value is 250 events. The page size can never be larger than 2500
- * events. Optional.
+ * Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
*/
maxResults?: number;
/**
- * The order of the events returned in the result. Optional. The default is
- * an unspecified, stable order.
+ * The order of the events returned in the result. Optional. The default is an unspecified, stable order.
*/
orderBy?: string;
/**
@@ -4849,84 +4266,47 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Extended properties constraint specified as propertyName=value. Matches
- * only private properties. This parameter might be repeated multiple times
- * to return events that match all given constraints.
+ * Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
*/
privateExtendedProperty?: string[];
/**
- * Free text search terms to find events that match these terms in any
- * field, except for extended properties. Optional.
+ * Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
*/
q?: string;
/**
- * Extended properties constraint specified as propertyName=value. Matches
- * only shared properties. This parameter might be repeated multiple times
- * to return events that match all given constraints.
+ * Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
*/
sharedExtendedProperty?: string[];
/**
- * Whether to include deleted events (with status equals "cancelled") in the
- * result. Cancelled instances of recurring events (but not the underlying
- * recurring event) will still be included if showDeleted and singleEvents
- * are both False. If showDeleted and singleEvents are both True, only
- * single instances of deleted events (but not the underlying recurring
- * events) are returned. Optional. The default is False.
+ * Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
*/
showDeleted?: boolean;
/**
- * Whether to include hidden invitations in the result. Optional. The
- * default is False.
+ * Whether to include hidden invitations in the result. Optional. The default is False.
*/
showHiddenInvitations?: boolean;
/**
- * Whether to expand recurring events into instances and only return single
- * one-off events and instances of recurring events, but not the underlying
- * recurring events themselves. Optional. The default is False.
+ * Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
*/
singleEvents?: boolean;
/**
- * Token obtained from the nextSyncToken field returned on the last page of
- * results from the previous list request. It makes the result of this list
- * request contain only entries that have changed since then. All events
- * deleted since the previous list request will always be in the result set
- * and it is not allowed to set showDeleted to False. There are several
- * query parameters that cannot be specified together with nextSyncToken to
- * ensure consistency of the client state. These are: - iCalUID - orderBy
- * - privateExtendedProperty - q - sharedExtendedProperty - timeMin -
- * timeMax - updatedMin If the syncToken expires, the server will respond
- * with a 410 GONE response code and the client should clear its storage and
- * perform a full synchronization without any syncToken. Learn more about
- * incremental synchronization. Optional. The default is to return all
- * entries.
+ * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
/**
- * Upper bound (exclusive) for an event's end time to filter by. Optional.
- * The default is not to filter by end time. Must be an RFC3339 timestamp
- * with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00,
- * 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If
- * timeMin is set, timeMax must be greater than timeMin.
+ * Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
*/
timeMax?: string;
/**
- * Lower bound (inclusive) for an event's start time to filter by. Optional.
- * The default is not to filter by start time. Must be an RFC3339 timestamp
- * with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00,
- * 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If
- * timeMax is set, timeMin must be smaller than timeMax.
+ * Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
*/
timeMin?: string;
/**
- * Time zone used in the response. Optional. The default is the time zone of
- * the calendar.
+ * Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
/**
- * Lower bound for an event's last modification time (as a RFC3339
- * timestamp) to filter by. When specified, entries deleted since this time
- * will always be included regardless of showDeleted. Optional. The default
- * is not to filter by last modification time.
+ * Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
*/
updatedMin?: string;
@@ -5271,9 +4651,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Maximum number of entries returned on one result page. By default the
- * value is 100 entries. The page size can never be larger than 250 entries.
- * Optional.
+ * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
@@ -5281,13 +4659,7 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Token obtained from the nextSyncToken field returned on the last page of
- * results from the previous list request. It makes the result of this list
- * request contain only entries that have changed since then. If the
- * syncToken expires, the server will respond with a 410 GONE response code
- * and the client should clear its storage and perform a full
- * synchronization without any syncToken. Learn more about incremental
- * synchronization. Optional. The default is to return all entries.
+ * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
}
@@ -5298,9 +4670,7 @@ export namespace calendar_v3 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Maximum number of entries returned on one result page. By default the
- * value is 100 entries. The page size can never be larger than 250 entries.
- * Optional.
+ * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
@@ -5308,13 +4678,7 @@ export namespace calendar_v3 {
*/
pageToken?: string;
/**
- * Token obtained from the nextSyncToken field returned on the last page of
- * results from the previous list request. It makes the result of this list
- * request contain only entries that have changed since then. If the
- * syncToken expires, the server will respond with a 410 GONE response code
- * and the client should clear its storage and perform a full
- * synchronization without any syncToken. Learn more about incremental
- * synchronization. Optional. The default is to return all entries.
+ * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
diff --git a/src/apis/chat/package.json b/src/apis/chat/package.json
index 7ca18296636..3b119f2b71c 100644
--- a/src/apis/chat/package.json
+++ b/src/apis/chat/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts
index ef814867101..ac5ae137155 100644
--- a/src/apis/chat/v1.ts
+++ b/src/apis/chat/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace chat_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace chat_v1 {
*/
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.
+ * 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;
/**
@@ -112,17 +108,17 @@ export namespace chat_v1 {
spaces: Resource$Spaces;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.spaces = new Resource$Spaces(this.context);
}
}
/**
- * List of string parameters to supply when the action method is invoked. For
- * example, consider three snooze buttons: snooze now, snooze 1 day, snooze
- * next week. You might use action method = snooze(), passing the snooze type
- * and snooze time in the list of string parameters.
+ * List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze 1 day, snooze next week. You might use action method = snooze(), passing the snooze type and snooze time in the list of string parameters.
*/
export interface Schema$ActionParameter {
/**
@@ -143,32 +139,20 @@ export namespace chat_v1 {
*/
type?: string;
/**
- * URL for users to auth or config. (Only for REQUEST_CONFIG response
- * types.)
+ * URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
*/
url?: string;
}
/**
- * Annotations associated with the plain-text body of the message. Example
- * plain-text message body: ``` Hello @FooBot how are you!" ``` The
- * corresponding annotations metadata: ``` "annotations":[{
- * "type":"USER_MENTION", "startIndex":6,
- * "length":7, "userMention": { "user": {
- * "name":"users/107946847022116401880",
- * "displayName":"FooBot",
- * "avatarUrl":"https://goo.gl/aeDtrS",
- * "type":"BOT" },
- * "type":"MENTION" } }] ```
+ * Annotations associated with the plain-text body of the message. Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/107946847022116401880", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
*/
export interface Schema$Annotation {
/**
- * Length of the substring in the plain-text message body this annotation
- * corresponds to.
+ * Length of the substring in the plain-text message body this annotation corresponds to.
*/
length?: number;
/**
- * Start index (0-based, inclusive) in the plain-text message body this
- * annotation corresponds to.
+ * Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.
*/
startIndex?: number;
/**
@@ -215,9 +199,7 @@ export namespace chat_v1 {
sections?: Schema$Section[];
}
/**
- * A card action is the action associated with the card. For an invoice card,
- * a typical action would be: delete invoice, email invoice or open the
- * invoice in browser.
+ * A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser.
*/
export interface Schema$CardAction {
/**
@@ -243,9 +225,7 @@ export namespace chat_v1 {
*/
subtitle?: string;
/**
- * The title must be specified. The header has a fixed height: if both a
- * title and subtitle is specified, each will take up 1 line. If only the
- * title is specified, it will take up both lines.
+ * The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each will take up 1 line. If only the title is specified, it will take up both lines.
*/
title?: string;
}
@@ -254,16 +234,11 @@ export namespace chat_v1 {
*/
export interface Schema$DeprecatedEvent {
/**
- * The form action data associated with an interactive card that was
- * clicked. Only populated for CARD_CLICKED events. See the [Interactive
- * Cards guide](/hangouts/chat/how-tos/cards-onclick) for more information.
+ * The form action data associated with an interactive card that was clicked. Only populated for CARD_CLICKED events. See the [Interactive Cards guide](/hangouts/chat/how-tos/cards-onclick) for more information.
*/
action?: Schema$FormAction;
/**
- * The URL the bot should redirect the user to after they have completed an
- * authorization or configuration flow outside of Hangouts Chat. See the
- * [Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p)
- * for more information.
+ * The URL the bot should redirect the user to after they have completed an authorization or configuration flow outside of Hangouts Chat. See the [Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p) for more information.
*/
configCompleteRedirectUrl?: string;
/**
@@ -279,17 +254,11 @@ export namespace chat_v1 {
*/
space?: Schema$Space;
/**
- * The bot-defined key for the thread related to the event. See the
- * thread_key field of the `spaces.message.create` request for more
- * information.
+ * The bot-defined key for the thread related to the event. See the thread_key field of the `spaces.message.create` request for more information.
*/
threadKey?: string;
/**
- * A secret value that bots can use to verify if a request is from Google.
- * The token is randomly generated by Google, remains static, and can be
- * obtained from the Hangouts Chat API configuration page in the Cloud
- * Console. Developers can revoke/regenerate it if needed from the same
- * page.
+ * A secret value that bots can use to verify if a request is from Google. The token is randomly generated by Google, remains static, and can be obtained from the Hangouts Chat API configuration page in the Cloud Console. Developers can revoke/regenerate it if needed from the same page.
*/
token?: string;
/**
@@ -302,21 +271,15 @@ export namespace chat_v1 {
user?: Schema$User;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
- * A form action describes the behavior when the form is submitted. For
- * example, an Apps Script can be invoked to handle the form.
+ * A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form.
*/
export interface Schema$FormAction {
/**
- * Apps Script function to invoke when the containing element is
- * clicked/activated.
+ * Apps Script function to invoke when the containing element is clicked/activated.
*/
actionMethodName?: string;
/**
@@ -346,8 +309,7 @@ export namespace chat_v1 {
*/
export interface Schema$ImageButton {
/**
- * The icon specified by an enum that indices to an icon provided by Chat
- * API.
+ * The icon specified by an enum that indices to an icon provided by Chat API.
*/
icon?: string;
/**
@@ -355,8 +317,7 @@ export namespace chat_v1 {
*/
iconUrl?: string;
/**
- * The name of this image_button which will be used for accessibility.
- * Default value will be provided if developers don't specify.
+ * The name of this image_button which will be used for accessibility. Default value will be provided if developers don't specify.
*/
name?: string;
/**
@@ -365,8 +326,7 @@ export namespace chat_v1 {
onClick?: Schema$OnClick;
}
/**
- * A UI element contains a key (label) and a value (content). And this element
- * may also contain some actions such as onclick button.
+ * A UI element contains a key (label) and a value (content). And this element may also contain some actions such as onclick button.
*/
export interface Schema$KeyValue {
/**
@@ -386,8 +346,7 @@ export namespace chat_v1 {
*/
contentMultiline?: boolean;
/**
- * An enum value that will be replaced by the Chat API with the
- * corresponding icon image.
+ * An enum value that will be replaced by the Chat API with the corresponding icon image.
*/
icon?: string;
/**
@@ -395,8 +354,7 @@ export namespace chat_v1 {
*/
iconUrl?: string;
/**
- * The onclick action. Only the top label, bottom label and content region
- * are clickable.
+ * The onclick action. Only the top label, bottom label and content region are clickable.
*/
onClick?: Schema$OnClick;
/**
@@ -410,16 +368,13 @@ export namespace chat_v1 {
*/
memberships?: Schema$Membership[];
/**
- * Continuation token to retrieve the next page of results. It will be empty
- * for the last page of results.
+ * Continuation token to retrieve the next page of results. It will be empty for the last page of results.
*/
nextPageToken?: string;
}
export interface Schema$ListSpacesResponse {
/**
- * Continuation token to retrieve the next page of results. It will be empty
- * for the last page of results. Tokens expire in an hour. An error is
- * thrown if an expired token is passed.
+ * Continuation token to retrieve the next page of results. It will be empty for the last page of results. Tokens expire in an hour. An error is thrown if an expired token is passed.
*/
nextPageToken?: string;
/**
@@ -432,8 +387,7 @@ export namespace chat_v1 {
*/
export interface Schema$Membership {
/**
- * The creation time of the membership a.k.a the time at which the member
- * joined the space, if applicable.
+ * The creation time of the membership a.k.a the time at which the member joined the space, if applicable.
*/
createTime?: string;
/**
@@ -441,9 +395,7 @@ export namespace chat_v1 {
*/
member?: Schema$User;
/**
- * Resource name of the membership, in the form
- * "spaces/x/members/*". Example:
- * spaces/AAAAMpdlehY/members/105115627578887013105
+ * Resource name of the membership, in the form "spaces/x/members/*". Example: spaces/AAAAMpdlehY/members/105115627578887013105
*/
name?: string;
/**
@@ -456,8 +408,7 @@ export namespace chat_v1 {
*/
export interface Schema$Message {
/**
- * Input only. Parameters that a bot can use to configure how its response
- * is posted.
+ * Input only. Parameters that a bot can use to configure how its response is posted.
*/
actionResponse?: Schema$ActionResponse;
/**
@@ -469,30 +420,23 @@ export namespace chat_v1 {
*/
argumentText?: string;
/**
- * Rich, formatted and interactive cards that can be used to display UI
- * elements such as: formatted texts, buttons, clickable images. Cards are
- * normally displayed below the plain-text body of the message.
+ * Rich, formatted and interactive cards that can be used to display UI elements such as: formatted texts, buttons, clickable images. Cards are normally displayed below the plain-text body of the message.
*/
cards?: Schema$Card[];
/**
- * Output only. The time at which the message was created in Hangouts Chat
- * server.
+ * Output only. The time at which the message was created in Hangouts Chat server.
*/
createTime?: string;
/**
- * A plain-text description of the message's cards, used when the actual
- * cards cannot be displayed (e.g. mobile notifications).
+ * A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications).
*/
fallbackText?: string;
/**
- * Resource name, in the form "spaces/x/messages/*". Example:
- * spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ * Resource name, in the form "spaces/x/messages/*". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
*/
name?: string;
/**
- * Text for generating preview chips. This text will not be displayed to the
- * user, but any links to images, web pages, videos, etc. included here will
- * generate preview chips.
+ * Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips.
*/
previewText?: string;
/**
@@ -535,10 +479,7 @@ export namespace chat_v1 {
url?: string;
}
/**
- * A section contains a collection of widgets that are rendered (vertically)
- * in the order that they are specified. Across all platforms, cards have a
- * narrow fixed width, so there is currently no need for layout properties
- * (e.g. float).
+ * A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there is currently no need for layout properties (e.g. float).
*/
export interface Schema$Section {
/**
@@ -559,8 +500,7 @@ export namespace chat_v1 {
*/
displayName?: string;
/**
- * Resource name of the space, in the form "spaces/*". Example:
- * spaces/AAAAMpdlehYs
+ * Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehYs
*/
name?: string;
/**
@@ -592,8 +532,7 @@ export namespace chat_v1 {
*/
export interface Schema$Thread {
/**
- * Resource name, in the form "spaces/x/threads/*". Example:
- * spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
+ * Resource name, in the form "spaces/x/threads/*". Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
*/
name?: string;
}
@@ -632,8 +571,7 @@ export namespace chat_v1 {
*/
export interface Schema$WidgetMarkup {
/**
- * A list of buttons. Buttons is also oneof data and only one of these
- * fields should be set.
+ * A list of buttons. Buttons is also oneof data and only one of these fields should be set.
*/
buttons?: Schema$Button[];
/**
@@ -807,8 +745,7 @@ export namespace chat_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name of the space, in the form "spaces/x". Example:
- * spaces/AAAAMpdlehY
+ * Required. Resource name of the space, in the form "spaces/x". Example: spaces/AAAAMpdlehY
*/
name?: string;
}
@@ -819,8 +756,7 @@ export namespace chat_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Requested page size. The value is capped at 1000. Server may return fewer
- * results than requested. If unspecified, server will default to 100.
+ * Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.
*/
pageSize?: number;
/**
@@ -993,9 +929,7 @@ export namespace chat_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name of the membership to be retrieved, in the form
- * "spaces/x/members/x". Example:
- * spaces/AAAAMpdlehY/members/105115627578887013105
+ * Required. Resource name of the membership to be retrieved, in the form "spaces/x/members/x". Example: spaces/AAAAMpdlehY/members/105115627578887013105
*/
name?: string;
}
@@ -1007,8 +941,7 @@ export namespace chat_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Requested page size. The value is capped at 1000. Server may return fewer
- * results than requested. If unspecified, server will default to 100.
+ * Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.
*/
pageSize?: number;
/**
@@ -1016,8 +949,7 @@ export namespace chat_v1 {
*/
pageToken?: string;
/**
- * Required. The resource name of the space for which membership list is to
- * be fetched, in the form "spaces/x". Example: spaces/AAAAMpdlehY
+ * Required. The resource name of the space for which membership list is to be fetched, in the form "spaces/x". Example: spaces/AAAAMpdlehY
*/
parent?: string;
}
@@ -1320,18 +1252,11 @@ export namespace chat_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Space resource name, in the form "spaces/x". Example:
- * spaces/AAAAMpdlehY
+ * Required. Space resource name, in the form "spaces/x". Example: spaces/AAAAMpdlehY
*/
parent?: string;
/**
- * Opaque thread identifier string that can be specified to group messages
- * into a single thread. If this is the first message with a given thread
- * identifier, a new thread is created. Subsequent messages with the same
- * thread identifier will be posted into the same thread. This relieves bots
- * and webhooks from having to store the Hangouts Chat thread ID of a thread
- * (created earlier by them) to post further updates to it. Has no effect
- * if thread field, corresponding to an existing thread, is set in message.
+ * Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.
*/
threadKey?: string;
@@ -1348,9 +1273,7 @@ export namespace chat_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name of the message to be deleted, in the form
- * "spaces/x/messages/x" Example:
- * spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ * Required. Resource name of the message to be deleted, in the form "spaces/x/messages/x" Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
*/
name?: string;
}
@@ -1362,9 +1285,7 @@ export namespace chat_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Required. Resource name of the message to be retrieved, in the form
- * "spaces/x/messages/x". Example:
- * spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ * Required. Resource name of the message to be retrieved, in the form "spaces/x/messages/x". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
*/
name?: string;
}
@@ -1376,13 +1297,11 @@ export namespace chat_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Resource name, in the form "spaces/x/messages/x". Example:
- * spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ * Resource name, in the form "spaces/x/messages/x". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
*/
name?: string;
/**
- * Required. The field paths to be updated. Currently supported field
- * paths: "text", "cards".
+ * Required. The field paths to be updated. Currently supported field paths: "text", "cards".
*/
updateMask?: string;
diff --git a/src/apis/civicinfo/package.json b/src/apis/civicinfo/package.json
index 52ff18d9d7c..62abd617334 100644
--- a/src/apis/civicinfo/package.json
+++ b/src/apis/civicinfo/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/civicinfo/v2.ts b/src/apis/civicinfo/v2.ts
index 9c6f84f5b48..5c0ea2bab81 100644
--- a/src/apis/civicinfo/v2.ts
+++ b/src/apis/civicinfo/v2.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -51,9 +51,7 @@ export namespace civicinfo_v2 {
*/
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.
+ * 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;
/**
@@ -65,8 +63,7 @@ export namespace civicinfo_v2 {
*/
prettyPrint?: boolean;
/**
- * An opaque string that represents a user for quota purposes. Must not
- * exceed 40 characters.
+ * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
@@ -78,8 +75,7 @@ export namespace civicinfo_v2 {
/**
* Google Civic Information API
*
- * Provides polling places, early vote locations, contest data, election
- * officials, and government representatives for U.S. residential addresses.
+ * Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.
*
* @example
* const {google} = require('googleapis');
@@ -98,7 +94,10 @@ export namespace civicinfo_v2 {
representatives: Resource$Representatives;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.divisions = new Resource$Divisions(this.context);
this.elections = new Resource$Elections(this.context);
@@ -115,14 +114,11 @@ export namespace civicinfo_v2 {
*/
electionAdministrationBody?: Schema$AdministrativeBody;
/**
- * An ID for this object. IDs may change in future requests and should not
- * be cached. Access to this field requires special access that can be
- * requested from the Request more link on the Quotas page.
+ * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
*/
id?: string;
/**
- * The city or county that provides election information for this voter.
- * This object can have the same elements as state.
+ * The city or county that provides election information for this voter. This object can have the same elements as state.
*/
local_jurisdiction?: Schema$AdministrationRegion;
/**
@@ -130,25 +126,21 @@ export namespace civicinfo_v2 {
*/
name?: string;
/**
- * A list of sources for this area. If multiple sources are listed the data
- * has been aggregated from those sources.
+ * A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.
*/
sources?: Schema$Source[];
}
/**
- * Information about an election administrative body (e.g. County Board of
- * Elections).
+ * Information about an election administrative body (e.g. County Board of Elections).
*/
export interface Schema$AdministrativeBody {
/**
- * A URL provided by this administrative body for information on absentee
- * voting.
+ * A URL provided by this administrative body for information on absentee voting.
*/
absenteeVotingInfoUrl?: string;
addressLines?: string[];
/**
- * A URL provided by this administrative body to give contest information to
- * the voter.
+ * A URL provided by this administrative body to give contest information to the voter.
*/
ballotInfoUrl?: string;
/**
@@ -156,8 +148,7 @@ export namespace civicinfo_v2 {
*/
correspondenceAddress?: Schema$SimpleAddressType;
/**
- * A URL provided by this administrative body for looking up general
- * election information.
+ * A URL provided by this administrative body for looking up general election information.
*/
electionInfoUrl?: string;
/**
@@ -165,18 +156,15 @@ export namespace civicinfo_v2 {
*/
electionOfficials?: Schema$ElectionOfficial[];
/**
- * A URL provided by this administrative body for confirming that the voter
- * is registered to vote.
+ * A URL provided by this administrative body for confirming that the voter is registered to vote.
*/
electionRegistrationConfirmationUrl?: string;
/**
- * A URL provided by this administrative body for looking up how to register
- * to vote.
+ * A URL provided by this administrative body for looking up how to register to vote.
*/
electionRegistrationUrl?: string;
/**
- * A URL provided by this administrative body describing election rules to
- * the voter.
+ * A URL provided by this administrative body describing election rules to the voter.
*/
electionRulesUrl?: string;
/**
@@ -217,10 +205,7 @@ export namespace civicinfo_v2 {
*/
email?: string;
/**
- * The candidate's name. If this is a joint ticket it will indicate the
- * name of the candidate at the top of a ticket followed by a / and that
- * name of candidate at the bottom of the ticket. e.g. "Mitt Romney /
- * Paul Ryan"
+ * The candidate's name. If this is a joint ticket it will indicate the name of the candidate at the top of a ticket followed by a / and that name of candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan"
*/
name?: string;
/**
@@ -249,9 +234,7 @@ export namespace civicinfo_v2 {
*/
id?: string;
/**
- * The type of channel. The following is a list of types of channels, but is
- * not exhaustive. More channel types may be added at a later time. One of:
- * GooglePlus, YouTube, Facebook, Twitter
+ * The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
*/
type?: string;
}
@@ -260,8 +243,7 @@ export namespace civicinfo_v2 {
*/
export interface Schema$Contest {
/**
- * A number specifying the position of this contest on the voter's
- * ballot.
+ * A number specifying the position of this contest on the voter's ballot.
*/
ballotPlacement?: string;
/**
@@ -277,22 +259,15 @@ export namespace civicinfo_v2 {
*/
district?: Schema$ElectoralDistrict;
/**
- * A description of any additional eligibility requirements for voting in
- * this contest.
+ * A description of any additional eligibility requirements for voting in this contest.
*/
electorateSpecifications?: string;
/**
- * An ID for this object. IDs may change in future requests and should not
- * be cached. Access to this field requires special access that can be
- * requested from the Request more link on the Quotas page.
+ * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
*/
id?: string;
/**
- * The levels of government of the office for this contest. There may be
- * more than one in cases where a jurisdiction effectively acts at two
- * different levels of government; for example, the mayor of the District of
- * Columbia acts at "locality" level, but also effectively at both
- * "administrative-area-2" and "administrative-area-1".
+ * The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
*/
level?: string[];
/**
@@ -312,60 +287,43 @@ export namespace civicinfo_v2 {
*/
primaryParty?: string;
/**
- * The set of ballot responses for the referendum. A ballot response
- * represents a line on the ballot. Common examples might include
- * "yes" or "no" for referenda. This field is only
- * populated for contests of type 'Referendum'.
+ * The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include "yes" or "no" for referenda. This field is only populated for contests of type 'Referendum'.
*/
referendumBallotResponses?: string[];
/**
- * Specifies a short summary of the referendum that is typically on the
- * ballot below the title but above the text. This field is only populated
- * for contests of type 'Referendum'.
+ * Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'.
*/
referendumBrief?: string;
/**
- * A statement in opposition to the referendum. It does not necessarily
- * appear on the ballot. This field is only populated for contests of type
- * 'Referendum'.
+ * A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
*/
referendumConStatement?: string;
/**
- * Specifies what effect abstaining (not voting) on the proposition will
- * have (i.e. whether abstaining is considered a vote against it). This
- * field is only populated for contests of type 'Referendum'.
+ * Specifies what effect abstaining (not voting) on the proposition will have (i.e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'.
*/
referendumEffectOfAbstain?: string;
/**
- * The threshold of votes that the referendum needs in order to pass, e.g.
- * "two-thirds". This field is only populated for contests of type
- * 'Referendum'.
+ * The threshold of votes that the referendum needs in order to pass, e.g. "two-thirds". This field is only populated for contests of type 'Referendum'.
*/
referendumPassageThreshold?: string;
/**
- * A statement in favor of the referendum. It does not necessarily appear on
- * the ballot. This field is only populated for contests of type
- * 'Referendum'.
+ * A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
*/
referendumProStatement?: string;
/**
- * A brief description of the referendum. This field is only populated for
- * contests of type 'Referendum'.
+ * A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
*/
referendumSubtitle?: string;
/**
- * The full text of the referendum. This field is only populated for
- * contests of type 'Referendum'.
+ * The full text of the referendum. This field is only populated for contests of type 'Referendum'.
*/
referendumText?: string;
/**
- * The title of the referendum (e.g. 'Proposition 42'). This field
- * is only populated for contests of type 'Referendum'.
+ * The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
*/
referendumTitle?: string;
/**
- * A link to the referendum. This field is only populated for contests of
- * type 'Referendum'.
+ * A link to the referendum. This field is only populated for contests of type 'Referendum'.
*/
referendumUrl?: string;
/**
@@ -373,20 +331,15 @@ export namespace civicinfo_v2 {
*/
roles?: string[];
/**
- * A list of sources for this contest. If multiple sources are listed, the
- * data has been aggregated from those sources.
+ * A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
*/
sources?: Schema$Source[];
/**
- * "Yes" or "No" depending on whether this a contest
- * being held outside the normal election cycle.
+ * "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
*/
special?: string;
/**
- * The type of contest. Usually this will be 'General',
- * 'Primary', or 'Run-off' for contests with candidates. For
- * referenda this will be 'Referendum'. For Retention contests this
- * will typically be 'Retention'.
+ * The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'. For Retention contests this will typically be 'Retention'.
*/
type?: string;
}
@@ -410,24 +363,17 @@ export namespace civicinfo_v2 {
*/
export interface Schema$DivisionSearchResponse {
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "civicinfo#divisionSearchResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse".
*/
kind?: string;
results?: Schema$DivisionSearchResult[];
}
/**
- * Represents a political geographic division that matches the requested
- * query.
+ * Represents a political geographic division that matches the requested query.
*/
export interface Schema$DivisionSearchResult {
/**
- * Other Open Civic Data identifiers that refer to the same division -- for
- * example, those that refer to other political divisions whose boundaries
- * are defined to be coterminous with this one. For example,
- * ocd-division/country:us/state:wy will include an alias of
- * ocd-division/country:us/state:wy/cd:1, since Wyoming has only one
- * Congressional district.
+ * Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.
*/
aliases?: string[];
/**
@@ -456,11 +402,7 @@ export namespace civicinfo_v2 {
*/
name?: string;
/**
- * The political division of the election. Represented as an OCD Division
- * ID. Voters within these political jurisdictions are covered by this
- * election. This is typically a state such as
- * ocd-division/country:us/state:ca or for the midterms or general election
- * the entire US (i.e. ocd-division/country:us).
+ * The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).
*/
ocdDivisionId?: string;
}
@@ -501,8 +443,7 @@ export namespace civicinfo_v2 {
*/
elections?: Schema$Election[];
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "civicinfo#electionsQueryResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".
*/
kind?: string;
}
@@ -511,9 +452,7 @@ export namespace civicinfo_v2 {
*/
export interface Schema$ElectoralDistrict {
/**
- * An identifier for this district, relative to its scope. For example, the
- * 34th State Senate district would have id "34" and a scope of
- * stateUpper.
+ * An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper.
*/
id?: string;
kgForeignKey?: string;
@@ -522,10 +461,7 @@ export namespace civicinfo_v2 {
*/
name?: string;
/**
- * The geographic scope of this district. If unspecified the district's
- * geography is not known. One of: national, statewide, congressional,
- * stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide,
- * township, countyCouncil, cityCouncil, ward, special
+ * The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special
*/
scope?: string;
}
@@ -537,15 +473,7 @@ export namespace civicinfo_v2 {
*/
export interface Schema$GeographicDivision {
/**
- * Any other valid OCD IDs that refer to the same division. Because OCD IDs
- * are meant to be human-readable and at least somewhat predictable, there
- * are occasionally several identifiers for a single division. These
- * identifiers are defined to be equivalent to one another, and one is
- * always indicated as the primary identifier. The primary identifier will
- * be returned in ocd_id above, and any other equivalent valid identifiers
- * will be returned in this list. For example, if this division's OCD
- * ID is ocd-division/country:us/district:dc, this will contain
- * ocd-division/country:us/state:dc.
+ * Any other valid OCD IDs that refer to the same division. Because OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list. For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
*/
alsoKnownAs?: string[];
/**
@@ -553,9 +481,7 @@ export namespace civicinfo_v2 {
*/
name?: string;
/**
- * List of indices in the offices array, one for each office elected from
- * this division. Will only be present if includeOffices was true (or
- * absent) in the request.
+ * List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
*/
officeIndices?: number[];
}
@@ -600,11 +526,7 @@ export namespace civicinfo_v2 {
*/
divisionId?: string;
/**
- * The levels of government of which this office is part. There may be more
- * than one in cases where a jurisdiction effectively acts at two different
- * levels of government; for example, the mayor of the District of Columbia
- * acts at "locality" level, but also effectively at both
- * "administrative-area-2" and "administrative-area-1".
+ * The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
*/
levels?: string[];
/**
@@ -612,20 +534,15 @@ export namespace civicinfo_v2 {
*/
name?: string;
/**
- * List of indices in the officials array of people who presently hold this
- * office.
+ * List of indices in the officials array of people who presently hold this office.
*/
officialIndices?: number[];
/**
- * The roles which this office fulfills. Roles are not meant to be
- * exhaustive, or to exactly specify the entire set of responsibilities of a
- * given office, but are meant to be rough categories that are useful for
- * general selection from or sorting of a list of offices.
+ * The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.
*/
roles?: string[];
/**
- * A list of sources for this office. If multiple sources are listed, the
- * data has been aggregated from those sources.
+ * A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
*/
sources?: Schema$Source[];
}
@@ -673,9 +590,7 @@ export namespace civicinfo_v2 {
temporaryData?: Schema$MessageSet;
}
/**
- * A location where a voter can vote. This may be an early vote site, an
- * election day voting location, or a drop off location for a completed
- * ballot.
+ * A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
*/
export interface Schema$PollingLocation {
/**
@@ -683,33 +598,23 @@ export namespace civicinfo_v2 {
*/
address?: Schema$SimpleAddressType;
/**
- * The last date that this early vote site or drop off location may be used.
- * This field is not populated for polling locations.
+ * The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.
*/
endDate?: string;
/**
- * An ID for this object. IDs may change in future requests and should not
- * be cached. Access to this field requires special access that can be
- * requested from the Request more link on the Quotas page.
+ * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
*/
id?: string;
/**
- * Latitude of the location, in degrees north of the equator. Only some
- * locations -- generally, ballot drop boxes for vote-by-mail elections --
- * will have this set; for others, use a geocoding service like the Google
- * Maps API to resolve the address to a geographic point.
+ * Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
*/
latitude?: number;
/**
- * Longitude of the location, in degrees east of the Prime Meridian. Only
- * some locations -- generally, ballot drop boxes for vote-by-mail elections
- * -- will have this set; for others, use a geocoding service like the
- * Google Maps API to resolve the address to a geographic point.
+ * Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
*/
longitude?: number;
/**
- * The name of the early vote site or drop off location. This field is not
- * populated for polling locations.
+ * The name of the early vote site or drop off location. This field is not populated for polling locations.
*/
name?: string;
/**
@@ -721,18 +626,15 @@ export namespace civicinfo_v2 {
*/
pollingHours?: string;
/**
- * A list of sources for this location. If multiple sources are listed the
- * data has been aggregated from those sources.
+ * A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
*/
sources?: Schema$Source[];
/**
- * The first date that this early vote site or drop off location may be
- * used. This field is not populated for polling locations.
+ * The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.
*/
startDate?: string;
/**
- * The services provided by this early vote site or drop off location. This
- * field is not populated for polling locations.
+ * The services provided by this early vote site or drop off location. This field is not populated for polling locations.
*/
voterServices?: string;
}
@@ -776,19 +678,16 @@ export namespace civicinfo_v2 {
*/
divisions?: {[key: string]: Schema$GeographicDivision};
/**
- * Elected offices referenced by the divisions listed above. Will only be
- * present if includeOffices was true in the request.
+ * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
*/
offices?: Schema$Office[];
/**
- * Officials holding the offices listed above. Will only be present if
- * includeOffices was true in the request.
+ * Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
*/
officials?: Schema$Official[];
}
/**
- * A request for political geography and representative information for an
- * address.
+ * A request for political geography and representative information for an address.
*/
export interface Schema$RepresentativeInfoRequest {
contextParams?: Schema$ContextParams;
@@ -802,8 +701,7 @@ export namespace civicinfo_v2 {
*/
divisions?: {[key: string]: Schema$GeographicDivision};
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "civicinfo#representativeInfoResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".
*/
kind?: string;
/**
@@ -811,13 +709,11 @@ export namespace civicinfo_v2 {
*/
normalizedInput?: Schema$SimpleAddressType;
/**
- * Elected offices referenced by the divisions listed above. Will only be
- * present if includeOffices was true in the request.
+ * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
*/
offices?: Schema$Office[];
/**
- * Officials holding the offices listed above. Will only be present if
- * includeOffices was true in the request.
+ * Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
*/
officials?: Schema$Official[];
}
@@ -933,16 +829,11 @@ export namespace civicinfo_v2 {
*/
contests?: Schema$Contest[];
/**
- * Locations where a voter is eligible to drop off a completed ballot. The
- * voter must have received and completed a ballot prior to arriving at the
- * location. The location may not have ballots available on the premises.
- * These locations could be open on or before election day as indicated in
- * the pollingHours field.
+ * Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.
*/
dropOffLocations?: Schema$PollingLocation[];
/**
- * Locations where the voter is eligible to vote early, prior to election
- * day.
+ * Locations where the voter is eligible to vote early, prior to election day.
*/
earlyVoteSites?: Schema$PollingLocation[];
/**
@@ -950,13 +841,11 @@ export namespace civicinfo_v2 {
*/
election?: Schema$Election;
/**
- * Identifies what kind of resource this is. Value: the fixed string
- * "civicinfo#voterInfoResponse".
+ * Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
*/
kind?: string;
/**
- * Specifies whether voters in the precinct vote only by mailing their
- * ballots (with the possible option of dropping off their ballots as well).
+ * Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).
*/
mailOnly?: boolean;
/**
@@ -964,16 +853,7 @@ export namespace civicinfo_v2 {
*/
normalizedInput?: Schema$SimpleAddressType;
/**
- * When there are multiple elections for a voter address, the otherElections
- * field is populated in the API response and there are two
- * possibilities: 1. If the earliest election is not the intended election,
- * specify the election ID of the desired election in a second API request
- * using the electionId field. 2. If these elections occur on the same day,
- * the API doesn?t return any polling location, contest, or election
- * official information to ensure that an additional query is made. For
- * user-facing applications, we recommend displaying these elections to the
- * user to disambiguate. A second API request using the electionId field
- * should be made for the election that is relevant to the user.
+ * When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user.
*/
otherElections?: Schema$Election[];
/**
@@ -983,8 +863,7 @@ export namespace civicinfo_v2 {
precinctId?: string;
segments?: Schema$StreetSegment[];
/**
- * Local Election Information for the state that the voter votes in. For the
- * US, there will only be one element in this array.
+ * Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.
*/
state?: Schema$AdministrationRegion[];
}
@@ -1085,11 +964,7 @@ export namespace civicinfo_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The search query. Queries can cover any parts of a OCD ID or a human
- * readable division name. All words given in the query are treated as
- * required patterns. In addition to that, most query operators of the
- * Apache Lucene library are supported. See
- * http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
+ * The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
*/
query?: string;
@@ -1185,8 +1060,7 @@ export namespace civicinfo_v2 {
/**
* civicinfo.elections.voterInfoQuery
- * @desc Looks up information relevant to a voter based on the voter's
- * registered address.
+ * @desc Looks up information relevant to a voter based on the voter's registered address.
* @alias civicinfo.elections.voterInfoQuery
* @memberOf! ()
*
@@ -1289,11 +1163,7 @@ export namespace civicinfo_v2 {
*/
address?: string;
/**
- * The unique ID of the election to look up. A list of election IDs can be
- * obtained at https://www.googleapis.com/civicinfo/{version}/electionsIf no
- * election ID is specified in the query and there is more than one election
- * with data for the given voter, the additional elections are provided in
- * the otherElections response field.
+ * The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/electionsIf no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field.
*/
electionId?: string;
/**
@@ -1301,9 +1171,7 @@ export namespace civicinfo_v2 {
*/
officialOnly?: boolean;
/**
- * If set to true, the query will return the success codeand include any
- * partial information when it is unable to determine a matching address or
- * unable to determine the election for electionId=0 queries.
+ * If set to true, the query will return the success codeand include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.
*/
returnAllAvailableData?: boolean;
@@ -1321,8 +1189,7 @@ export namespace civicinfo_v2 {
/**
* civicinfo.representatives.representativeInfoByAddress
- * @desc Looks up political geography and representative information for a
- * single address.
+ * @desc Looks up political geography and representative information for a single address.
* @alias civicinfo.representatives.representativeInfoByAddress
* @memberOf! ()
*
@@ -1407,8 +1274,7 @@ export namespace civicinfo_v2 {
/**
* civicinfo.representatives.representativeInfoByDivision
- * @desc Looks up representative information for a single geographic
- * division.
+ * @desc Looks up representative information for a single geographic division.
* @alias civicinfo.representatives.representativeInfoByDivision
* @memberOf! ()
*
@@ -1497,25 +1363,19 @@ export namespace civicinfo_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The address to look up. May only be specified if the field ocdId is not
- * given in the URL.
+ * The address to look up. May only be specified if the field ocdId is not given in the URL.
*/
address?: string;
/**
- * Whether to return information about offices and officials. If false, only
- * the top-level district information will be returned.
+ * Whether to return information about offices and officials. If false, only the top-level district information will be returned.
*/
includeOffices?: boolean;
/**
- * A list of office levels to filter by. Only offices that serve at least
- * one of these levels will be returned. Divisions that don't contain a
- * matching office will not be returned.
+ * A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.
*/
levels?: string[];
/**
- * A list of office roles to filter by. Only offices fulfilling one of these
- * roles will be returned. Divisions that don't contain a matching office
- * will not be returned.
+ * A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.
*/
roles?: string[];
@@ -1532,9 +1392,7 @@ export namespace civicinfo_v2 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * A list of office levels to filter by. Only offices that serve at least
- * one of these levels will be returned. Divisions that don't contain a
- * matching office will not be returned.
+ * A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.
*/
levels?: string[];
/**
@@ -1542,16 +1400,11 @@ export namespace civicinfo_v2 {
*/
ocdId?: string;
/**
- * If true, information about all divisions contained in the division
- * requested will be included as well. For example, if querying
- * ocd-division/country:us/district:dc, this would also return all DC's
- * wards and ANCs.
+ * If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.
*/
recursive?: boolean;
/**
- * A list of office roles to filter by. Only offices fulfilling one of these
- * roles will be returned. Divisions that don't contain a matching office
- * will not be returned.
+ * A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.
*/
roles?: string[];
diff --git a/src/apis/classroom/package.json b/src/apis/classroom/package.json
index 32a43bc9942..c77f9ebbc4c 100644
--- a/src/apis/classroom/package.json
+++ b/src/apis/classroom/package.json
@@ -18,7 +18,7 @@
"url": "https://github.com/googleapis/google-api-nodejs-client.git"
},
"engines": {
- "node": ">=6.0.0"
+ "node": ">=8.0.0"
},
"scripts": {
"fix": "gts fix",
@@ -29,7 +29,7 @@
"webpack": "webpack"
},
"dependencies": {
- "googleapis-common": "^0.7.0"
+ "googleapis-common": "^2.0.0"
},
"devDependencies": {
"gts": "^1.0.0",
diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts
index 94cf0a6e73c..bfb5cac32bb 100644
--- a/src/apis/classroom/v1.ts
+++ b/src/apis/classroom/v1.ts
@@ -14,21 +14,21 @@
* limitations under the License.
*/
-import {GaxiosPromise} from 'gaxios';
import {
- Compute,
- JWT,
OAuth2Client,
+ JWT,
+ Compute,
UserRefreshClient,
} from 'google-auth-library';
import {
- APIRequestContext,
- BodyResponseCallback,
- createAPIRequest,
- GlobalOptions,
GoogleConfigurable,
+ createAPIRequest,
MethodOptions,
+ GlobalOptions,
+ BodyResponseCallback,
+ APIRequestContext,
} from 'googleapis-common';
+import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
@@ -63,9 +63,7 @@ export namespace classroom_v1 {
*/
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.
+ * 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;
/**
@@ -77,9 +75,7 @@ export namespace classroom_v1 {
*/
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.
+ * 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;
/**
@@ -115,7 +111,10 @@ export namespace classroom_v1 {
userProfiles: Resource$Userprofiles;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
- this.context = {_options: options || {}, google};
+ this.context = {
+ _options: options || {},
+ google,
+ };
this.courses = new Resource$Courses(this.context);
this.invitations = new Resource$Invitations(this.context);
@@ -129,13 +128,11 @@ export namespace classroom_v1 {
*/
export interface Schema$Announcement {
/**
- * Absolute link to this announcement in the Classroom web UI. This is only
- * populated if `state` is `PUBLISHED`. Read-only.
+ * Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
*/
alternateLink?: string;
/**
- * Assignee mode of the announcement. If unspecified, the default value is
- * `ALL_STUDENTS`.
+ * Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
*/
assigneeMode?: string;
/**
@@ -151,20 +148,15 @@ export namespace classroom_v1 {
*/
creatorUserId?: string;
/**
- * Classroom-assigned identifier of this announcement, unique per course.
- * Read-only.
+ * Classroom-assigned identifier of this announcement, unique per course. Read-only.
*/
id?: string;
/**
- * Identifiers of students with access to the announcement. This field is
- * set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the
- * `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in
- * this field will be able to see the announcement.
+ * Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be able to see the announcement.
*/
individualStudentsOptions?: Schema$IndividualStudentsOptions;
/**
- * Additional materials. Announcements must have no more than 20 material
- * items.
+ * Additional materials. Announcements must have no more than 20 material items.
*/
materials?: Schema$Material[];
/**
@@ -172,13 +164,11 @@ export namespace classroom_v1 {
*/
scheduledTime?: string;
/**
- * Status of this announcement. If unspecified, the default state is
- * `DRAFT`.
+ * Status of this announcement. If unspecified, the default state is `DRAFT`.
*/
state?: string;
/**
- * Description of this announcement. The text must be a valid UTF-8 string
- * containing no more than 30,000 characters.
+ * Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
*/
text?: string;
/**
@@ -191,8 +181,7 @@ export namespace classroom_v1 {
*/
export interface Schema$Assignment {
/**
- * Drive folder where attachments from student submissions are placed. This
- * is only populated for course teachers and administrators.
+ * Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators.
*/
studentWorkFolder?: Schema$DriveFolder;
}
@@ -201,18 +190,12 @@ export namespace classroom_v1 {
*/
export interface Schema$AssignmentSubmission {
/**
- * Attachments added by the student. Drive files that correspond to
- * materials with a share mode of STUDENT_COPY may not exist yet if the
- * student has not accessed the assignment in Classroom. Some attachment
- * metadata is only populated if the requesting user has permission to
- * access it. Identifier and alternate_link fields are always available, but
- * others (e.g. title) may not be.
+ * Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.
*/
attachments?: Schema$Attachment[];
}
/**
- * Attachment added to student assignment work. When creating attachments,
- * setting the `form` field is not supported.
+ * Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.
*/
export interface Schema$Attachment {
/**
@@ -233,15 +216,11 @@ export namespace classroom_v1 {
youTubeVideo?: Schema$YouTubeVideo;
}
/**
- * A reference to a Cloud Pub/Sub topic. To register for notifications, the
- * owner of the topic must grant
- * `classroom-notifications@system.gserviceaccount.com` the
- * `projects.topics.publish` permission.
+ * A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.
*/
export interface Schema$CloudPubsubTopic {
/**
- * The `name` field of a Cloud Pub/Sub
- * [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
+ * The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
*/
topicName?: string;
}
@@ -254,20 +233,15 @@ export namespace classroom_v1 {
*/
alternateLink?: string;
/**
- * The Calendar ID for a calendar that all course members can see, to which
- * Classroom adds events for course work and announcements in the course.
- * Read-only.
+ * The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
*/
calendarId?: string;
/**
- * The email address of a Google group containing all members of the course.
- * This group does not accept email and can only be used for permissions.
- * Read-only.
+ * The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
*/
courseGroupEmail?: string;
/**
- * Sets of materials that appear on the "about" page of this
- * course. Read-only.
+ * Sets of materials that appear on the "about" page of this course. Read-only.
*/
courseMaterialSets?: Schema$CourseMaterialSet[];
/**
@@ -275,105 +249,64 @@ export namespace classroom_v1 {
*/
courseState?: string;
/**
- * Creation time of the course. Specifying this field in a course update
- * mask results in an error. Read-only.
+ * Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
*/
creationTime?: string;
/**
- * Optional description. For example, "We'll be learning about the
- * structure of living creatures from a combination of textbooks, guest
- * lectures, and lab work. Expect to be excited!" If set, this field
- * must be a valid UTF-8 string and no longer than 30,000 characters.
+ * Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
*/
description?: string;
/**
- * Optional heading for the description. For example, "Welcome to 10th
- * Grade Biology." If set, this field must be a valid UTF-8 string and
- * no longer than 3600 characters.
+ * Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
*/
descriptionHeading?: string;
/**
- * Enrollment code to use when joining this course. Specifying this field in
- * a course update mask results in an error. Read-only.
+ * Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
*/
enrollmentCode?: string;
/**
- * Whether or not guardian notifications are enabled for this course.
- * Read-only.
+ * Whether or not guardian notifications are enabled for this course. Read-only.
*/
guardiansEnabled?: boolean;
/**
- * Identifier for this course assigned by Classroom. When creating a
- * course, you may optionally set this identifier to an alias string in the
- * request to create a corresponding alias. The `id` is still assigned by
- * Classroom and cannot be updated after the course is created. Specifying
- * this field in a course update mask results in an error.
+ * Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
*/
id?: string;
/**
- * Name of the course. For example, "10th Grade Biology". The name
- * is required. It must be between 1 and 750 characters and a valid UTF-8
- * string.
+ * Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
*/
name?: string;
/**
- * The identifier of the owner of a course. When specified as a parameter
- * of a create course request, this field is required. The identifier can be
- * one of the following: * the numeric identifier for the user * the email
- * address of the user * the string literal `"me"`, indicating the
- * requesting user This must be set in a create request. Admins can also
- * specify this field in a patch course request to transfer ownership. In
- * other contexts, it is read-only.
+ * The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
*/
ownerId?: string;
/**
- * Optional room location. For example, "301". If set, this field
- * must be a valid UTF-8 string and no longer than 650 characters.
+ * Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
*/
room?: string;
/**
- * Section of the course. For example, "Period 2". If set, this
- * field must be a valid UTF-8 string and no longer than 2800 characters.
+ * Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
*/
section?: string;
/**
- * Information about a Drive Folder that is shared with all teachers of the
- * course. This field will only be set for teachers of the course and
- * domain administrators. Read-only.
+ * Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
*/
teacherFolder?: Schema$DriveFolder;
/**
- * The email address of a Google group containing all teachers of the
- * course. This group does not accept email and can only be used for
- * permissions. Read-only.
+ * The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
*/
teacherGroupEmail?: string;
/**
- * Time of the most recent update to this course. Specifying this field in a
- * course update mask results in an error. Read-only.
+ * Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
*/
updateTime?: string;
}
/**
- * Alternative identifier for a course. An alias uniquely identifies a
- * course. It must be unique within one of the following scopes: * domain: A
- * domain-scoped alias is visible to all users within the alias creator's
- * domain and can be created only by a domain admin. A domain-scoped alias is
- * often used when a course has an identifier external to Classroom. *
- * project: A project-scoped alias is visible to any request from an
- * application using the Developer Console project ID that created the alias
- * and can be created by any project. A project-scoped alias is often used
- * when an application has alternative identifiers. A random value can also be
- * used to avoid duplicate courses in the event of transmission failures, as
- * retrying a request will return `ALREADY_EXISTS` if a previous one has
- * succeeded.
+ * Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
*/
export interface Schema$CourseAlias {
/**
- * Alias string. The format of the string indicates the desired alias
- * scoping. * `d:<name>` indicates a domain-scoped alias. Example:
- * `d:math_101` * `p:<name>` indicates a project-scoped alias.
- * Example: `p:abc123` This field has a maximum length of 256 characters.
+ * Alias string. The format of the string indicates the desired alias scoping. * `d:<name>` indicates a domain-scoped alias. Example: `d:math_101` * `p:<name>` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
*/
alias?: string;
}
@@ -399,9 +332,7 @@ export namespace classroom_v1 {
youTubeVideo?: Schema$YouTubeVideo;
}
/**
- * A set of materials that appears on the "About" page of the
- * course. These materials might include a syllabus, schedule, or other
- * background information relating to the course as a whole.
+ * A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
*/
export interface Schema$CourseMaterialSet {
/**
@@ -427,24 +358,19 @@ export namespace classroom_v1 {
*/
export interface Schema$CourseWork {
/**
- * Absolute link to this course work in the Classroom web UI. This is only
- * populated if `state` is `PUBLISHED`. Read-only.
+ * Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
*/
alternateLink?: string;
/**
- * Assignee mode of the coursework. If unspecified, the default value is
- * `ALL_STUDENTS`.
+ * Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.
*/
assigneeMode?: string;
/**
- * Assignment details. This is populated only when `work_type` is
- * `ASSIGNMENT`. Read-only.
+ * Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.
*/
assignment?: Schema$Assignment;
/**
- * Whether this course work item is associated with the Developer Console
- * project making the request. See google.classroom.Work.CreateCourseWork
- * for more details. Read-only.
+ * Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
*/
associatedWithDeveloper?: boolean;
/**
@@ -460,49 +386,35 @@ export namespace classroom_v1 {
*/
creatorUserId?: string;
/**
- * Optional description of this course work. If set, the description must be
- * a valid UTF-8 string containing no more than 30,000 characters.
+ * Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
*/
description?: string;
/**
- * Optional date, in UTC, that submissions for this course work are due.
- * This must be specified if `due_time` is specified.
+ * Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified.
*/
dueDate?: Schema$Date;
/**
- * Optional time of day, in UTC, that submissions for this course work are
- * due. This must be specified if `due_date` is specified.
+ * Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified.
*/
dueTime?: Schema$TimeOfDay;
/**
- * Classroom-assigned identifier of this course work, unique per course.
- * Read-only.
+ * Classroom-assigned identifier of this course work, unique per course. Read-only.
*/
id?: string;
/**
- * Identifiers of students with access to the coursework. This field is set
- * only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is
- * `INDIVIDUAL_STUDENTS`, then only students specified in this field will be
- * assigned the coursework.
+ * Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be assigned the coursework.
*/
individualStudentsOptions?: Schema$IndividualStudentsOptions;
/**
- * Additional materials. CourseWork must have no more than 20 material
- * items.
+ * Additional materials. CourseWork must have no more than 20 material items.
*/
materials?: Schema$Material[];
/**
- * Maximum grade for this course work. If zero or unspecified, this
- * assignment is considered ungraded. This must be a non-negative integer
- * value.
+ * Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
*/
maxPoints?: number;
/**
- * Multiple choice question details. For read operations, this field is
- * populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write
- * operations, this field must be specified when creating course work with a
- * `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set
- * otherwise.
+ * Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
*/
multipleChoiceQuestion?: Schema$MultipleChoiceQuestion;
/**
@@ -514,18 +426,15 @@ export namespace classroom_v1 {
*/
state?: string;
/**
- * Setting to determine when students are allowed to modify submissions. If
- * unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
+ * Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
*/
submissionModificationMode?: string;
/**
- * Title of this course work. The title must be a valid UTF-8 string
- * containing between 1 and 3000 characters.
+ * Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
*/
title?: string;
/**
- * Identifier for the topic that this coursework is associated with. Must
- * match an existing topic in the course.
+ * Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.
*/
topicId?: string;
/**
@@ -533,8 +442,7 @@ export namespace classroom_v1 {
*/
updateTime?: string;
/**
- * Type of this course work. The type is set when the course work is
- * created and cannot be changed.
+ * Type of this course work. The type is set when the course work is created and cannot be changed.
*/
workType?: string;
}
@@ -548,30 +456,19 @@ export namespace classroom_v1 {
courseId?: string;
}
/**
- * Represents a whole or partial calendar date, e.g. a birthday. The time of
- * day and time zone are either specified elsewhere or are not significant.
- * The date is relative to the Proleptic Gregorian Calendar. This can
- * represent: * A full date, with non-zero year, month and day values * A
- * month and day value, with a zero year, e.g. an anniversary * A year on its
- * own, with zero month and day values * A year and month value, with a zero
- * day, e.g. a credit card expiration date Related types are
- * google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
- * Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- * if specifying a year by itself or a year and month where the day is not
- * significant.
+ * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
*/
day?: number;
/**
- * Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- * month and day.
+ * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number;
/**
- * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a
- * year.
+ * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number;
}
@@ -614,26 +511,19 @@ export namespace classroom_v1 {
title?: string;
}
/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance: service Foo { rpc
- * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
- * representation for `Empty` is empty JSON object `{}`.
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
- * A class of notifications that an application can register to receive. For
- * example: "all roster changes for a domain".
+ * A class of notifications that an application can register to receive. For example: "all roster changes for a domain".
*/
export interface Schema$Feed {
/**
- * Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.
- * This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.
+ * Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.
*/
courseRosterChangesInfo?: Schema$CourseRosterChangesInfo;
/**
- * Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.
- * This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`.
+ * Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`.
*/
courseWorkChangesInfo?: Schema$CourseWorkChangesInfo;
/**
@@ -650,9 +540,7 @@ export namespace classroom_v1 {
*/
formUrl?: string;
/**
- * URL of the form responses document. Only set if respsonses have been
- * recorded and only when the requesting user is an editor of the form.
- * Read-only.
+ * URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
*/
responseUrl?: string;
/**
@@ -690,8 +578,7 @@ export namespace classroom_v1 {
*/
gradeTimestamp?: string;
/**
- * The denominator of the grade at this time in the submission grade
- * history.
+ * The denominator of the grade at this time in the submission grade history.
*/
maxPoints?: number;
/**
@@ -700,8 +587,7 @@ export namespace classroom_v1 {
pointsEarned?: number;
}
/**
- * Association between a student and a guardian of that student. The guardian
- * may receive information about the student's course work.
+ * Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
*/
export interface Schema$Guardian {
/**
@@ -713,8 +599,7 @@ export namespace classroom_v1 {
*/
guardianProfile?: Schema$UserProfile;
/**
- * The email address to which the initial guardian invitation was sent. This
- * field is only visible to domain administrators.
+ * The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
*/
invitedEmailAddress?: string;
/**
@@ -723,8 +608,7 @@ export namespace classroom_v1 {
studentId?: string;
}
/**
- * An invitation to become the guardian of a specified user, sent to a
- * specified email address.
+ * An invitation to become the guardian of a specified user, sent to a specified email address.
*/
export interface Schema$GuardianInvitation {
/**
@@ -736,8 +620,7 @@ export namespace classroom_v1 {
*/
invitationId?: string;
/**
- * Email address that the invitation was sent to. This field is only visible
- * to domain administrators.
+ * Email address that the invitation was sent to. This field is only visible to domain administrators.
*/
invitedEmailAddress?: string;
/**
@@ -750,13 +633,11 @@ export namespace classroom_v1 {
studentId?: string;
}
/**
- * Assignee details about a coursework/announcement. This field is set if and
- * only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ * Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
*/
export interface Schema$IndividualStudentsOptions {
/**
- * Identifiers for the students that have access to the
- * coursework/announcement.
+ * Identifiers for the students that have access to the coursework/announcement.
*/
studentIds?: string[];
}
@@ -777,10 +658,7 @@ export namespace classroom_v1 {
*/
role?: string;
/**
- * Identifier of the invited user. When specified as a parameter of a
- * request, this identifier can be set to one of the following: * the
- * numeric identifier for the user * the email address of the user * the
- * string literal `"me"`, indicating the requesting user
+ * Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
@@ -797,8 +675,7 @@ export namespace classroom_v1 {
*/
title?: string;
/**
- * URL to link to. This must be a valid UTF-8 string containing between 1
- * and 2024 characters.
+ * URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
*/
url?: string;
}
@@ -811,8 +688,7 @@ export namespace classroom_v1 {
*/
announcements?: Schema$Announcement[];
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
}
@@ -825,8 +701,7 @@ export namespace classroom_v1 {
*/
aliases?: Schema$CourseAlias[];
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
}
@@ -839,8 +714,7 @@ export namespace classroom_v1 {
*/
courses?: Schema$Course[];
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
}
@@ -853,8 +727,7 @@ export namespace classroom_v1 {
*/
courseWork?: Schema$CourseWork[];
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
}
@@ -867,8 +740,7 @@ export namespace classroom_v1 {
*/
guardianInvitations?: Schema$GuardianInvitation[];
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
}
@@ -877,13 +749,11 @@ export namespace classroom_v1 {
*/
export interface Schema$ListGuardiansResponse {
/**
- * Guardians on this page of results that met the criteria specified in the
- * request.
+ * Guardians on this page of results that met the criteria specified in the request.
*/
guardians?: Schema$Guardian[];
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
}
@@ -896,8 +766,7 @@ export namespace classroom_v1 {
*/
invitations?: Schema$Invitation[];
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
}
@@ -906,8 +775,7 @@ export namespace classroom_v1 {
*/
export interface Schema$ListStudentsResponse {
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
/**
@@ -920,8 +788,7 @@ export namespace classroom_v1 {
*/
export interface Schema$ListStudentSubmissionsResponse {
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
/**
@@ -934,8 +801,7 @@ export namespace classroom_v1 {
*/
export interface Schema$ListTeachersResponse {
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
/**
@@ -948,8 +814,7 @@ export namespace classroom_v1 {
*/
export interface Schema$ListTopicResponse {
/**
- * Token identifying the next page of results to return. If empty, no
- * further results are available.
+ * Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string;
/**
@@ -958,8 +823,7 @@ export namespace classroom_v1 {
topic?: Schema$Topic[];
}
/**
- * Material attached to course work. When creating attachments, setting the
- * `form` field is not supported.
+ * Material attached to course work. When creating attachments, setting the `form` field is not supported.
*/
export interface Schema$Material {
/**
@@ -971,8 +835,7 @@ export namespace classroom_v1 {
*/
form?: Schema$Form;
/**
- * Link material. On creation, will be upgraded to a more appropriate type
- * if possible, and this will be reflected in the response.
+ * Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
*/
link?: Schema$Link;
/**
@@ -985,13 +848,11 @@ export namespace classroom_v1 {
*/
export interface Schema$ModifyAnnouncementAssigneesRequest {
/**
- * Mode of the announcement describing whether it will be accessible by all
- * students or specified individual students.
+ * Mode of the announcement describing whether it will be accessible by all students or specified individual students.
*/
assigneeMode?: string;
/**
- * Set which students can view or cannot view the announcement. Must be
- * specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ * Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
*/
modifyIndividualStudentsOptions?: Schema$ModifyIndividualStudentsOptions;
}
@@ -1000,8 +861,7 @@ export namespace classroom_v1 {
*/
export interface Schema$ModifyAttachmentsRequest {
/**
- * Attachments to add. A student submission may not have more than 20
- * attachments. Form attachments are not supported.
+ * Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.
*/
addAttachments?: Schema$Attachment[];
}
@@ -1010,29 +870,24 @@ export namespace classroom_v1 {
*/
export interface Schema$ModifyCourseWorkAssigneesRequest {
/**
- * Mode of the coursework describing whether it will be assigned to all
- * students or specified individual students.
+ * Mode of the coursework describing whether it will be assigned to all students or specified individual students.
*/
assigneeMode?: string;
/**
- * Set which students are assigned or not assigned to the coursework. Must
- * be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ * Set which students are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
*/
modifyIndividualStudentsOptions?: Schema$ModifyIndividualStudentsOptions;
}
/**
- * Contains fields to add or remove students from a course work or
- * announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.
+ * Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.
*/
export interface Schema$ModifyIndividualStudentsOptions {
/**
- * Ids of students to be added as having access to this
- * coursework/announcement.
+ * Ids of students to be added as having access to this coursework/announcement.
*/
addStudentIds?: string[];
/**
- * Ids of students to be removed from having access to this
- * coursework/announcement.
+ * Ids of students to be removed from having access to this coursework/announcement.
*/
removeStudentIds?: string[];
}
@@ -1063,8 +918,7 @@ export namespace classroom_v1 {
*/
familyName?: string;
/**
- * The user's full name formed by concatenating the first and last name
- * values. Read-only.
+ * The user's full name formed by concatenating the first and last name values. Read-only.
*/
fullName?: string;
/**
@@ -1077,8 +931,7 @@ export namespace classroom_v1 {
*/
export interface Schema$ReclaimStudentSubmissionRequest {}
/**
- * An instruction to Classroom to send notifications from the `feed` to the
- * provided destination.
+ * An instruction to Classroom to send notifications from the `feed` to the provided destination.
*/
export interface Schema$Registration {
/**
@@ -1086,13 +939,11 @@ export namespace classroom_v1 {
*/
cloudPubsubTopic?: Schema$CloudPubsubTopic;
/**
- * The time until which the `Registration` is effective. This is a
- * read-only field assigned by the server.
+ * The time until which the `Registration` is effective. This is a read-only field assigned by the server.
*/
expiryTime?: string;
/**
- * Specification for the class of notifications that Classroom should
- * deliver to the destination.
+ * Specification for the class of notifications that Classroom should deliver to the destination.
*/
feed?: Schema$Feed;
/**
@@ -1156,23 +1007,16 @@ export namespace classroom_v1 {
*/
profile?: Schema$UserProfile;
/**
- * Information about a Drive Folder for this student's work in this
- * course. Only visible to the student and domain administrators. Read-only.
+ * Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
*/
studentWorkFolder?: Schema$DriveFolder;
/**
- * Identifier of the user. When specified as a parameter of a request, this
- * identifier can be one of the following: * the numeric identifier for the
- * user * the email address of the user * the string literal
- * `"me"`, indicating the requesting user
+ * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
/**
- * Student submission for course work. StudentSubmission items are generated
- * when a CourseWork item is created. StudentSubmissions that have never been
- * accessed (i.e. with `state` = NEW) may not have a creation time or update
- * time.
+ * Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
*/
export interface Schema$StudentSubmission {
/**
@@ -1180,21 +1024,15 @@ export namespace classroom_v1 {
*/
alternateLink?: string;
/**
- * Optional grade. If unset, no grade was set. This value must be
- * non-negative. Decimal (i.e. non-integer) values are allowed, but will be
- * rounded to two decimal places. This may be modified only by course
- * teachers.
+ * Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This may be modified only by course teachers.
*/
assignedGrade?: number;
/**
- * Submission content when course_work_type is ASSIGNMENT. Students can
- * modify this content using google.classroom.Work.ModifyAttachments.
+ * Submission content when course_work_type is ASSIGNMENT. Students can modify this content using google.classroom.Work.ModifyAttachments.
*/
assignmentSubmission?: Schema$AssignmentSubmission;
/**
- * Whether this student submission is associated with the Developer Console
- * project making the request. See google.classroom.Work.CreateCourseWork
- * for more details. Read-only.
+ * Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
*/
associatedWithDeveloper?: boolean;
/**
@@ -1210,20 +1048,15 @@ export namespace classroom_v1 {
*/
courseWorkType?: string;
/**
- * Creation time of this submission. This may be unset if the student has
- * not accessed this item. Read-only.
+ * Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
*/
creationTime?: string;
/**
- * Optional pending grade. If unset, no grade was set. This value must be
- * non-negative. Decimal (i.e. non-integer) values are allowed, but will be
- * rounded to two decimal places. This is only visible to and modifiable by
- * course teachers.
+ * Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This is only visible to and modifiable by course teachers.
*/
draftGrade?: number;
/**
- * Classroom-assigned Identifier for the student submission. This is unique
- * among submissions for the relevant course work. Read-only.
+ * Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
*/
id?: string;
/**
@@ -1243,13 +1076,11 @@ export namespace classroom_v1 {
*/
state?: string;
/**
- * The history of the submission (includes state and grade histories).
- * Read-only.
+ * The history of the submission (includes state and grade histories). Read-only.
*/
submissionHistory?: Schema$SubmissionHistory[];
/**
- * Last update time of this submission. This may be unset if the student has
- * not accessed this item. Read-only.
+ * Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
*/
updateTime?: string;
/**
@@ -1258,8 +1089,7 @@ export namespace classroom_v1 {
userId?: string;
}
/**
- * The history of the submission. This currently includes state and grade
- * histories.
+ * The history of the submission. This currently includes state and grade histories.
*/
export interface Schema$SubmissionHistory {
/**
@@ -1284,23 +1114,16 @@ export namespace classroom_v1 {
*/
profile?: Schema$UserProfile;
/**
- * Identifier of the user. When specified as a parameter of a request, this
- * identifier can be one of the following: * the numeric identifier for the
- * user * the email address of the user * the string literal
- * `"me"`, indicating the requesting user
+ * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
/**
- * Represents a time of day. The date and time zone are either not significant
- * or are specified elsewhere. An API may choose to allow leap seconds.
- * Related types are google.type.Date and `google.protobuf.Timestamp`.
+ * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
*/
export interface Schema$TimeOfDay {
/**
- * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
- * to allow the value "24:00:00" for scenarios like business
- * closing time.
+ * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
*/
hours?: number;
/**
@@ -1312,8 +1135,7 @@ export namespace classroom_v1 {
*/
nanos?: number;
/**
- * Seconds of minutes of the time. Must normally be from 0 to 59. An API may
- * allow the value 60 if it allows leap-seconds.
+ * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
*/
seconds?: number;
}
@@ -1326,11 +1148,7 @@ export namespace classroom_v1 {
*/
courseId?: string;
/**
- * The name of the topic, generated by the user. Leading and trailing
- * whitespaces, if any, will be trimmed. Also, multiple consecutive
- * whitespaces will be collapsed into one inside the name. The result must
- * be a non-empty string. Topic names are case sensitive, and must be no
- * longer than 100 characters.
+ * The name of the topic, generated by the user. Leading and trailing whitespaces, if any, will be trimmed. Also, multiple consecutive whitespaces will be collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters.
*/
name?: string;
/**
@@ -1371,10 +1189,7 @@ export namespace classroom_v1 {
*/
photoUrl?: string;
/**
- * Represents whether a G Suite for Education user's domain
- * administrator has explicitly verified them as being a teacher. If the
- * user is not a member of a G Suite for Education domain, than this field
- * will always be false. Read-only
+ * Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false. Read-only
*/
verifiedTeacher?: boolean;
}
@@ -1420,14 +1235,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.create
- * @desc Creates a course. The user specified in `ownerId` is the owner of
- * the created course and added as a teacher. This method returns the
- * following error codes: * `PERMISSION_DENIED` if the requesting user is
- * not permitted to create courses or for access errors. * `NOT_FOUND` if
- * the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the
- * course owner's account is disabled or for the following request errors:
- * * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was
- * specified in the `id` and already exists.
+ * @desc Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
* @alias classroom.courses.create
* @memberOf! ()
*
@@ -1495,10 +1303,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.delete
- * @desc Deletes a course. This method returns the following error codes:
- * * `PERMISSION_DENIED` if the requesting user is not permitted to delete
- * the requested course or for access errors. * `NOT_FOUND` if no course
- * exists with the requested ID.
+ * @desc Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
* @alias classroom.courses.delete
* @memberOf! ()
*
@@ -1566,10 +1371,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.get
- * @desc Returns a course. This method returns the following error codes:
- * * `PERMISSION_DENIED` if the requesting user is not permitted to access
- * the requested course or for access errors. * `NOT_FOUND` if no course
- * exists with the requested ID.
+ * @desc Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
* @alias classroom.courses.get
* @memberOf! ()
*
@@ -1637,12 +1439,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.list
- * @desc Returns a list of courses that the requesting user is permitted to
- * view, restricted to those that match the request. Returned courses are
- * ordered by creation time, with the most recently created coming first.
- * This method returns the following error codes: * `PERMISSION_DENIED` for
- * access errors. * `INVALID_ARGUMENT` if the query argument is malformed. *
- * `NOT_FOUND` if any users specified in the query arguments do not exist.
+ * @desc Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
* @alias classroom.courses.list
* @memberOf! ()
*
@@ -1716,13 +1513,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.patch
- * @desc Updates one or more fields in a course. This method returns the
- * following error codes: * `PERMISSION_DENIED` if the requesting user is
- * not permitted to modify the requested course or for access errors. *
- * `NOT_FOUND` if no course exists with the requested ID. *
- * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or
- * if no update mask is supplied. * `FAILED_PRECONDITION` for the following
- * request errors: * CourseNotModifiable
+ * @desc Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
* @alias classroom.courses.patch
* @memberOf! ()
*
@@ -1792,11 +1583,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.update
- * @desc Updates a course. This method returns the following error codes:
- * * `PERMISSION_DENIED` if the requesting user is not permitted to modify
- * the requested course or for access errors. * `NOT_FOUND` if no course
- * exists with the requested ID. * `FAILED_PRECONDITION` for the following
- * request errors: * CourseNotModifiable
+ * @desc Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
* @alias classroom.courses.update
* @memberOf! ()
*
@@ -1882,8 +1669,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course to delete. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.
*/
id?: string;
}
@@ -1894,8 +1680,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course to return. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.
*/
id?: string;
}
@@ -1906,34 +1691,23 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Restricts returned courses to those in one of the specified states The
- * default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
+ * Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
*/
courseStates?: string[];
/**
- * Maximum number of items to return. Zero or unspecified indicates that the
- * server may assign a maximum. The server may return fewer than the
- * specified number of results.
+ * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
- * Restricts returned courses to those having a student with the specified
- * identifier. The identifier can be one of the following: * the numeric
- * identifier for the user * the email address of the user * the string
- * literal `"me"`, indicating the requesting user
+ * Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
studentId?: string;
/**
- * Restricts returned courses to those having a teacher with the specified
- * identifier. The identifier can be one of the following: * the numeric
- * identifier for the user * the email address of the user * the string
- * literal `"me"`, indicating the requesting user
+ * Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
teacherId?: string;
}
@@ -1944,19 +1718,11 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course to update. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
*/
id?: string;
/**
- * Mask that identifies which fields on the course to update. This field is
- * required to do an update. The update will fail if invalid fields are
- * specified. The following fields are valid: * `name` * `section` *
- * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId`
- * Note: patches to ownerId are treated as being effective immediately, but
- * in practice it may take some time for the ownership transfer of all
- * affected resources to complete. When set in a query parameter, this
- * field should be specified as `updateMask=,,...`
+ * Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`
*/
updateMask?: string;
@@ -1972,8 +1738,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course to update. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
*/
id?: string;
@@ -1991,13 +1756,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.aliases.create
- * @desc Creates an alias for a course. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the requesting user is not
- * permitted to create the alias or for access errors. * `NOT_FOUND` if the
- * course does not exist. * `ALREADY_EXISTS` if the alias already exists. *
- * `FAILED_PRECONDITION` if the alias requested does not make sense for the
- * requesting user or course (for example, if a user not in a domain
- * attempts to access a domain-scoped alias).
+ * @desc Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
* @alias classroom.courses.aliases.create
* @memberOf! ()
*
@@ -2072,12 +1831,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.aliases.delete
- * @desc Deletes an alias of a course. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the requesting user is not
- * permitted to remove the alias or for access errors. * `NOT_FOUND` if the
- * alias does not exist. * `FAILED_PRECONDITION` if the alias requested does
- * not make sense for the requesting user or course (for example, if a
- * user not in a domain attempts to delete a domain-scoped alias).
+ * @desc Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).
* @alias classroom.courses.aliases.delete
* @memberOf! ()
*
@@ -2150,10 +1904,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.aliases.list
- * @desc Returns a list of aliases for a course. This method returns the
- * following error codes: * `PERMISSION_DENIED` if the requesting user is
- * not permitted to access the course or for access errors. * `NOT_FOUND` if
- * the course does not exist.
+ * @desc Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
* @alias classroom.courses.aliases.list
* @memberOf! ()
*
@@ -2243,8 +1994,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course to alias. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
@@ -2265,8 +2015,7 @@ export namespace classroom_v1 {
*/
alias?: string;
/**
- * Identifier of the course whose alias should be deleted. This identifier
- * can be either the Classroom-assigned identifier or an alias.
+ * Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
}
@@ -2278,20 +2027,15 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * The identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Maximum number of items to return. Zero or unspecified indicates that the
- * server may assign a maximum. The server may return fewer than the
- * specified number of results.
+ * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
@@ -2304,13 +2048,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.announcements.create
- * @desc Creates an announcement. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * access the requested course, create announcements in the requested
- * course, share a Drive attachment, or for access errors. *
- * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
- * requested course does not exist. * `FAILED_PRECONDITION` for the
- * following request error: * AttachmentNotVisible
+ * @desc Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
* @alias classroom.courses.announcements.create
* @memberOf! ()
*
@@ -2385,15 +2123,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.announcements.delete
- * @desc Deletes an announcement. This request must be made by the
- * Developer Console project of the [OAuth client
- * ID](https://support.google.com/cloud/answer/6158849) used to create the
- * corresponding announcement item. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting developer project did not
- * create the corresponding announcement, if the requesting user is not
- * permitted to delete the requested course or for access errors. *
- * `FAILED_PRECONDITION` if the requested announcement has already been
- * deleted. * `NOT_FOUND` if no course exists with the requested ID.
+ * @desc Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
* @alias classroom.courses.announcements.delete
* @memberOf! ()
*
@@ -2465,11 +2195,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.announcements.get
- * @desc Returns an announcement. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * access the requested course or announcement, or for access errors. *
- * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
- * requested course or announcement does not exist.
+ * @desc Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.
* @alias classroom.courses.announcements.get
* @memberOf! ()
*
@@ -2543,13 +2269,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.announcements.list
- * @desc Returns a list of announcements that the requester is permitted to
- * view. Course students may only view `PUBLISHED` announcements. Course
- * teachers and domain administrators may view all announcements. This
- * method returns the following error codes: * `PERMISSION_DENIED` if the
- * requesting user is not permitted to access the requested course or for
- * access errors. * `INVALID_ARGUMENT` if the request is malformed. *
- * `NOT_FOUND` if the requested course does not exist.
+ * @desc Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.announcements.list
* @memberOf! ()
*
@@ -2634,13 +2354,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.announcements.modifyAssignees
- * @desc Modifies assignee mode and options of an announcement. Only a
- * teacher of the course that contains the announcement may call this
- * method. This method returns the following error codes: *
- * `PERMISSION_DENIED` if the requesting user is not permitted to access the
- * requested course or course work or for access errors. *
- * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
- * requested course or course work does not exist.
+ * @desc Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
* @alias classroom.courses.announcements.modifyAssignees
* @memberOf! ()
*
@@ -2716,13 +2430,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.announcements.patch
- * @desc Updates one or more fields of an announcement. This method returns
- * the following error codes: * `PERMISSION_DENIED` if the requesting
- * developer project did not create the corresponding announcement or for
- * access errors. * `INVALID_ARGUMENT` if the request is malformed. *
- * `FAILED_PRECONDITION` if the requested announcement has already been
- * deleted. * `NOT_FOUND` if the requested course or announcement does not
- * exist
+ * @desc Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist
* @alias classroom.courses.announcements.patch
* @memberOf! ()
*
@@ -2805,8 +2513,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
@@ -2823,13 +2530,11 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Identifier of the announcement to delete. This identifier is a
- * Classroom-assigned identifier.
+ * Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.
*/
id?: string;
}
@@ -2841,8 +2546,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -2858,33 +2562,23 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Restriction on the `state` of announcements returned. If this argument is
- * left unspecified, the default value is `PUBLISHED`.
+ * Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.
*/
announcementStates?: string[];
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Optional sort ordering for results. A comma-separated list of fields with
- * an optional sort direction keyword. Supported field is `updateTime`.
- * Supported direction keywords are `asc` and `desc`. If not specified,
- * `updateTime desc` is the default behavior. Examples: `updateTime asc`,
- * `updateTime`
+ * Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`
*/
orderBy?: string;
/**
- * Maximum number of items to return. Zero or unspecified indicates that the
- * server may assign a maximum. The server may return fewer than the
- * specified number of results.
+ * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
@@ -2896,8 +2590,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -2918,8 +2611,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -2927,14 +2619,7 @@ export namespace classroom_v1 {
*/
id?: string;
/**
- * Mask that identifies which fields on the announcement to update. This
- * field is required to do an update. The update fails if invalid fields are
- * specified. If a field supports empty values, it can be cleared by
- * specifying it in the update mask and not in the Announcement object. If a
- * field that does not support empty values is included in the update mask
- * and not set in the Announcement object, an `INVALID_ARGUMENT` error will
- * be returned. The following fields may be specified by teachers: *
- * `text` * `state` * `scheduled_time`
+ * Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`
*/
updateMask?: string;
@@ -2956,18 +2641,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.create
- * @desc Creates course work. The resulting course work (and corresponding
- * student submissions) are associated with the Developer Console project of
- * the [OAuth client ID](https://support.google.com/cloud/answer/6158849)
- * used to make the request. Classroom API requests to modify course work
- * and student submissions must be made with an OAuth client ID from the
- * associated Developer Console project. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the requesting user is not
- * permitted to access the requested course, create course work in the
- * requested course, share a Drive attachment, or for access errors. *
- * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
- * requested course does not exist. * `FAILED_PRECONDITION` for the
- * following request error: * AttachmentNotVisible
+ * @desc Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
* @alias classroom.courses.courseWork.create
* @memberOf! ()
*
@@ -3042,15 +2716,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.delete
- * @desc Deletes a course work. This request must be made by the Developer
- * Console project of the [OAuth client
- * ID](https://support.google.com/cloud/answer/6158849) used to create the
- * corresponding course work item. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting developer project did not
- * create the corresponding course work, if the requesting user is not
- * permitted to delete the requested course or for access errors. *
- * `FAILED_PRECONDITION` if the requested course work has already been
- * deleted. * `NOT_FOUND` if no course exists with the requested ID.
+ * @desc Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
* @alias classroom.courses.courseWork.delete
* @memberOf! ()
*
@@ -3123,11 +2789,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.get
- * @desc Returns course work. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * access the requested course or course work, or for access errors. *
- * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
- * requested course or course work does not exist.
+ * @desc Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
* @alias classroom.courses.courseWork.get
* @memberOf! ()
*
@@ -3202,13 +2864,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.list
- * @desc Returns a list of course work that the requester is permitted to
- * view. Course students may only view `PUBLISHED` course work. Course
- * teachers and domain administrators may view all course work. This method
- * returns the following error codes: * `PERMISSION_DENIED` if the
- * requesting user is not permitted to access the requested course or for
- * access errors. * `INVALID_ARGUMENT` if the request is malformed. *
- * `NOT_FOUND` if the requested course does not exist.
+ * @desc Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.courseWork.list
* @memberOf! ()
*
@@ -3288,13 +2944,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.modifyAssignees
- * @desc Modifies assignee mode and options of a coursework. Only a teacher
- * of the course that contains the coursework may call this method. This
- * method returns the following error codes: * `PERMISSION_DENIED` if the
- * requesting user is not permitted to access the requested course or course
- * work or for access errors. * `INVALID_ARGUMENT` if the request is
- * malformed. * `NOT_FOUND` if the requested course or course work does not
- * exist.
+ * @desc Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
* @alias classroom.courses.courseWork.modifyAssignees
* @memberOf! ()
*
@@ -3369,26 +3019,14 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.patch
- * @desc Updates one or more fields of a course work. See
- * google.classroom.v1.CourseWork for details of which fields may be updated
- * and who may change them. This request must be made by the Developer
- * Console project of the [OAuth client
- * ID](https://support.google.com/cloud/answer/6158849) used to create the
- * corresponding course work item. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting developer project did not
- * create the corresponding course work, if the user is not permitted to
- * make the requested modification to the student submission, or for access
- * errors. * `INVALID_ARGUMENT` if the request is malformed. *
- * `FAILED_PRECONDITION` if the requested course work has already been
- * deleted. * `NOT_FOUND` if the requested course, course work, or student
- * submission does not exist.
+ * @desc Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the course work.
- * @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode`
+ * @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`
* @param {().CourseWork} 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.
@@ -3465,8 +3103,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
@@ -3483,13 +3120,11 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Identifier of the course work to delete. This identifier is a
- * Classroom-assigned identifier.
+ * Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.
*/
id?: string;
}
@@ -3501,8 +3136,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -3518,34 +3152,23 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Restriction on the work status to return. Only courseWork that matches is
- * returned. If unspecified, items with a work status of `PUBLISHED` is
- * returned.
+ * Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.
*/
courseWorkStates?: string[];
/**
- * Optional sort ordering for results. A comma-separated list of fields with
- * an optional sort direction keyword. Supported fields are `updateTime` and
- * `dueDate`. Supported direction keywords are `asc` and `desc`. If not
- * specified, `updateTime desc` is the default behavior. Examples: `dueDate
- * asc,updateTime desc`, `updateTime,dueDate desc`
+ * Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`
*/
orderBy?: string;
/**
- * Maximum number of items to return. Zero or unspecified indicates that the
- * server may assign a maximum. The server may return fewer than the
- * specified number of results.
+ * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
@@ -3557,8 +3180,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -3579,8 +3201,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -3588,15 +3209,7 @@ export namespace classroom_v1 {
*/
id?: string;
/**
- * Mask that identifies which fields on the course work to update. This
- * field is required to do an update. The update fails if invalid fields are
- * specified. If a field supports empty values, it can be cleared by
- * specifying it in the update mask and not in the CourseWork object. If a
- * field that does not support empty values is included in the update mask
- * and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be
- * returned. The following fields may be specified by teachers: * `title`
- * * `description` * `state` * `due_date` * `due_time` * `max_points` *
- * `scheduled_time` * `submission_modification_mode`
+ * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`
*/
updateMask?: string;
@@ -3614,11 +3227,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.studentSubmissions.get
- * @desc Returns a student submission. * `PERMISSION_DENIED` if the
- * requesting user is not permitted to access the requested course, course
- * work, or student submission or for access errors. * `INVALID_ARGUMENT` if
- * the request is malformed. * `NOT_FOUND` if the requested course, course
- * work, or student submission does not exist.
+ * @desc Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.get
* @memberOf! ()
*
@@ -3694,16 +3303,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.studentSubmissions.list
- * @desc Returns a list of student submissions that the requester is
- * permitted to view, factoring in the OAuth scopes of the request. `-` may
- * be specified as the `course_work_id` to include student submissions for
- * multiple course work items. Course students may only view their own
- * work. Course teachers and domain administrators may view all student
- * submissions. This method returns the following error codes: *
- * `PERMISSION_DENIED` if the requesting user is not permitted to access the
- * requested course or course work, or for access errors. *
- * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
- * requested course does not exist.
+ * @desc Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.list
* @memberOf! ()
*
@@ -3792,18 +3392,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.studentSubmissions.modifyAttachments
- * @desc Modifies attachments of student submission. Attachments may only
- * be added to student submissions belonging to course work objects with a
- * `workType` of `ASSIGNMENT`. This request must be made by the Developer
- * Console project of the [OAuth client
- * ID](https://support.google.com/cloud/answer/6158849) used to create the
- * corresponding course work item. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * access the requested course or course work, if the user is not permitted
- * to modify attachments on the requested student submission, or for access
- * errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND`
- * if the requested course, course work, or student submission does not
- * exist.
+ * @desc Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.modifyAttachments
* @memberOf! ()
*
@@ -3882,18 +3471,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.studentSubmissions.patch
- * @desc Updates one or more fields of a student submission. See
- * google.classroom.v1.StudentSubmission for details of which fields may be
- * updated and who may change them. This request must be made by the
- * Developer Console project of the [OAuth client
- * ID](https://support.google.com/cloud/answer/6158849) used to create the
- * corresponding course work item. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting developer project did not
- * create the corresponding course work, if the user is not permitted to
- * make the requested modification to the student submission, or for access
- * errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND`
- * if the requested course, course work, or student submission does not
- * exist.
+ * @desc Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.patch
* @memberOf! ()
*
@@ -3971,20 +3549,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.studentSubmissions.reclaim
- * @desc Reclaims a student submission on behalf of the student that owns
- * it. Reclaiming a student submission transfers ownership of attached
- * Drive files to the student and updates the submission state. Only the
- * student that owns the requested student submission may call this method,
- * and only for a student submission that has been turned in. This request
- * must be made by the Developer Console project of the [OAuth client
- * ID](https://support.google.com/cloud/answer/6158849) used to create the
- * corresponding course work item. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * access the requested course or course work, unsubmit the requested
- * student submission, or for access errors. * `FAILED_PRECONDITION` if the
- * student submission has not been turned in. * `INVALID_ARGUMENT` if the
- * request is malformed. * `NOT_FOUND` if the requested course, course work,
- * or student submission does not exist.
+ * @desc Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.reclaim
* @memberOf! ()
*
@@ -4059,20 +3624,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.studentSubmissions.return
- * @desc Returns a student submission. Returning a student submission
- * transfers ownership of attached Drive files to the student and may also
- * update the submission state. Unlike the Classroom application, returning
- * a student submission does not set assignedGrade to the draftGrade value.
- * Only a teacher of the course that contains the requested student
- * submission may call this method. This request must be made by the
- * Developer Console project of the [OAuth client
- * ID](https://support.google.com/cloud/answer/6158849) used to create the
- * corresponding course work item. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * access the requested course or course work, return the requested student
- * submission, or for access errors. * `INVALID_ARGUMENT` if the request is
- * malformed. * `NOT_FOUND` if the requested course, course work, or student
- * submission does not exist.
+ * @desc Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.return
* @memberOf! ()
*
@@ -4147,18 +3699,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.courseWork.studentSubmissions.turnIn
- * @desc Turns in a student submission. Turning in a student submission
- * transfers ownership of attached Drive files to the teacher and may also
- * update the submission state. This may only be called by the student that
- * owns the specified student submission. This request must be made by the
- * Developer Console project of the [OAuth client
- * ID](https://support.google.com/cloud/answer/6158849) used to create the
- * corresponding course work item. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * access the requested course or course work, turn in the requested student
- * submission, or for access errors. * `INVALID_ARGUMENT` if the request is
- * malformed. * `NOT_FOUND` if the requested course, course work, or student
- * submission does not exist.
+ * @desc Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.turnIn
* @memberOf! ()
*
@@ -4240,8 +3781,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -4261,44 +3801,31 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Identifier of the student work to request. This may be set to the string
- * literal `"-"` to request student work for all course work in the
- * specified course.
+ * Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course.
*/
courseWorkId?: string;
/**
- * Requested lateness value. If specified, returned student submissions are
- * restricted by the requested value. If unspecified, submissions are
- * returned regardless of `late` value.
+ * Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.
*/
late?: string;
/**
- * Maximum number of items to return. Zero or unspecified indicates that the
- * server may assign a maximum. The server may return fewer than the
- * specified number of results.
+ * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
- * Requested submission states. If specified, returned student submissions
- * match one of the specified submission states.
+ * Requested submission states. If specified, returned student submissions match one of the specified submission states.
*/
states?: string[];
/**
- * Optional argument to restrict returned student work to those owned by the
- * student with the specified identifier. The identifier can be one of the
- * following: * the numeric identifier for the user * the email address of
- * the user * the string literal `"me"`, indicating the requesting user
+ * Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
@@ -4310,8 +3837,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -4336,8 +3862,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -4349,10 +3874,7 @@ export namespace classroom_v1 {
*/
id?: string;
/**
- * Mask that identifies which fields on the student submission to update.
- * This field is required to do an update. The update fails if invalid
- * fields are specified. The following fields may be specified by teachers:
- * * `draft_grade` * `assigned_grade`
+ * Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`
*/
updateMask?: string;
@@ -4369,8 +3891,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -4395,8 +3916,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -4421,8 +3941,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -4448,15 +3967,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.students.create
- * @desc Adds a user as a student of a course. This method returns the
- * following error codes: * `PERMISSION_DENIED` if the requesting user is
- * not permitted to create students in this course or for access errors. *
- * `NOT_FOUND` if the requested course ID does not exist. *
- * `FAILED_PRECONDITION` if the requested user's account is disabled, for
- * the following request errors: * CourseMemberLimitReached *
- * CourseNotModifiable * UserGroupsMembershipLimitReached *
- * `ALREADY_EXISTS` if the user is already a student or teacher in the
- * course.
+ * @desc Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
* @alias classroom.courses.students.create
* @memberOf! ()
*
@@ -4530,11 +4041,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.students.delete
- * @desc Deletes a student of a course. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the requesting user is not
- * permitted to delete students of this course or for access errors. *
- * `NOT_FOUND` if no student of this course has the requested ID or if the
- * course does not exist.
+ * @desc Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
* @alias classroom.courses.students.delete
* @memberOf! ()
*
@@ -4607,11 +4114,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.students.get
- * @desc Returns a student of a course. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the requesting user is not
- * permitted to view students of this course or for access errors. *
- * `NOT_FOUND` if no student of this course has the requested ID or if the
- * course does not exist.
+ * @desc Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
* @alias classroom.courses.students.get
* @memberOf! ()
*
@@ -4684,10 +4187,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.students.list
- * @desc Returns a list of students of this course that the requester is
- * permitted to view. This method returns the following error codes: *
- * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for
- * access errors.
+ * @desc Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
* @alias classroom.courses.students.list
* @memberOf! ()
*
@@ -4772,15 +4272,11 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course to create the student in. This identifier can be
- * either the Classroom-assigned identifier or an alias.
+ * Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Enrollment code of the course to create the student in. This code is
- * required if userId corresponds to the requesting user; it may be omitted
- * if the requesting user has administrative permissions to create students
- * for any user.
+ * Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
*/
enrollmentCode?: string;
@@ -4797,14 +4293,11 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Identifier of the student to delete. The identifier can be one of the
- * following: * the numeric identifier for the user * the email address of
- * the user * the string literal `"me"`, indicating the requesting user
+ * Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
@@ -4816,14 +4309,11 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Identifier of the student to return. The identifier can be one of the
- * following: * the numeric identifier for the user * the email address of
- * the user * the string literal `"me"`, indicating the requesting user
+ * Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
@@ -4835,19 +4325,15 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Maximum number of items to return. Zero means no maximum. The server may
- * return fewer than the specified number of results.
+ * Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
@@ -4860,15 +4346,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.teachers.create
- * @desc Creates a teacher of a course. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the requesting user is not
- * permitted to create teachers in this course or for access errors. *
- * `NOT_FOUND` if the requested course ID does not exist. *
- * `FAILED_PRECONDITION` if the requested user's account is disabled, for
- * the following request errors: * CourseMemberLimitReached *
- * CourseNotModifiable * CourseTeacherLimitReached *
- * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is
- * already a teacher or student in the course.
+ * @desc Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
* @alias classroom.courses.teachers.create
* @memberOf! ()
*
@@ -4941,12 +4419,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.teachers.delete
- * @desc Deletes a teacher of a course. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the requesting user is not
- * permitted to delete teachers of this course or for access errors. *
- * `NOT_FOUND` if no teacher of this course has the requested ID or if the
- * course does not exist. * `FAILED_PRECONDITION` if the requested ID
- * belongs to the primary teacher of this course.
+ * @desc Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.
* @alias classroom.courses.teachers.delete
* @memberOf! ()
*
@@ -5019,11 +4492,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.teachers.get
- * @desc Returns a teacher of a course. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the requesting user is not
- * permitted to view teachers of this course or for access errors. *
- * `NOT_FOUND` if no teacher of this course has the requested ID or if the
- * course does not exist.
+ * @desc Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.
* @alias classroom.courses.teachers.get
* @memberOf! ()
*
@@ -5096,10 +4565,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.teachers.list
- * @desc Returns a list of teachers of this course that the requester is
- * permitted to view. This method returns the following error codes: *
- * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for
- * access errors.
+ * @desc Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
* @alias classroom.courses.teachers.list
* @memberOf! ()
*
@@ -5184,8 +4650,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
@@ -5202,14 +4667,11 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Identifier of the teacher to delete. The identifier can be one of the
- * following: * the numeric identifier for the user * the email address of
- * the user * the string literal `"me"`, indicating the requesting user
+ * Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
@@ -5221,14 +4683,11 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Identifier of the teacher to return. The identifier can be one of the
- * following: * the numeric identifier for the user * the email address of
- * the user * the string literal `"me"`, indicating the requesting user
+ * Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
@@ -5240,19 +4699,15 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Maximum number of items to return. Zero means no maximum. The server may
- * return fewer than the specified number of results.
+ * Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
@@ -5265,11 +4720,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.topics.create
- * @desc Creates a topic. This method returns the following error codes: *
- * `PERMISSION_DENIED` if the requesting user is not permitted to access the
- * requested course, create a topic in the requested course, or for access
- * errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND`
- * if the requested course does not exist.
+ * @desc Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.topics.create
* @memberOf! ()
*
@@ -5342,11 +4793,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.topics.delete
- * @desc Deletes a topic. This method returns the following error codes: *
- * `PERMISSION_DENIED` if the requesting user is not allowed to delete the
- * requested topic or for access errors. * `FAILED_PRECONDITION` if the
- * requested topic has already been deleted. * `NOT_FOUND` if no course or
- * topic exists with the requested ID.
+ * @desc Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID.
* @alias classroom.courses.topics.delete
* @memberOf! ()
*
@@ -5419,11 +4866,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.topics.get
- * @desc Returns a topic. This method returns the following error codes: *
- * `PERMISSION_DENIED` if the requesting user is not permitted to access the
- * requested course or topic, or for access errors. * `INVALID_ARGUMENT` if
- * the request is malformed. * `NOT_FOUND` if the requested course or topic
- * does not exist.
+ * @desc Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.
* @alias classroom.courses.topics.get
* @memberOf! ()
*
@@ -5496,11 +4939,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.topics.list
- * @desc Returns the list of topics that the requester is permitted to view.
- * This method returns the following error codes: * `PERMISSION_DENIED` if
- * the requesting user is not permitted to access the requested course or
- * for access errors. * `INVALID_ARGUMENT` if the request is malformed. *
- * `NOT_FOUND` if the requested course does not exist.
+ * @desc Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.topics.list
* @memberOf! ()
*
@@ -5576,11 +5015,7 @@ export namespace classroom_v1 {
/**
* classroom.courses.topics.patch
- * @desc Updates one or more fields of a topic. This method returns the
- * following error codes: * `PERMISSION_DENIED` if the requesting developer
- * project did not create the corresponding topic or for access errors. *
- * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
- * requested course or topic does not exist
+ * @desc Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist
* @alias classroom.courses.topics.patch
* @memberOf! ()
*
@@ -5662,8 +5097,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
@@ -5680,8 +5114,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -5713,20 +5146,15 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
- * Maximum number of items to return. Zero or unspecified indicates that the
- * server may assign a maximum. The server may return fewer than the
- * specified number of results.
+ * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
@@ -5738,8 +5166,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the course. This identifier can be either the
- * Classroom-assigned identifier or an alias.
+ * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
@@ -5747,13 +5174,7 @@ export namespace classroom_v1 {
*/
id?: string;
/**
- * Mask that identifies which fields on the topic to update. This field is
- * required to do an update. The update fails if invalid fields are
- * specified. If a field supports empty values, it can be cleared by
- * specifying it in the update mask and not in the Topic object. If a field
- * that does not support empty values is included in the update mask and not
- * set in the Topic object, an `INVALID_ARGUMENT` error will be returned.
- * The following fields may be specified: * `name`
+ * Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified: * `name`
*/
updateMask?: string;
@@ -5771,15 +5192,7 @@ export namespace classroom_v1 {
/**
* classroom.invitations.accept
- * @desc Accepts an invitation, removing it and adding the invited user to
- * the teachers or students (as appropriate) of the specified course. Only
- * the invited user may accept an invitation. This method returns the
- * following error codes: * `PERMISSION_DENIED` if the requesting user is
- * not permitted to accept the requested invitation or for access errors. *
- * `FAILED_PRECONDITION` for the following request errors: *
- * CourseMemberLimitReached * CourseNotModifiable *
- * CourseTeacherLimitReached * UserGroupsMembershipLimitReached *
- * `NOT_FOUND` if no invitation exists with the requested ID.
+ * @desc Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.
* @alias classroom.invitations.accept
* @memberOf! ()
*
@@ -5851,15 +5264,7 @@ export namespace classroom_v1 {
/**
* classroom.invitations.create
- * @desc Creates an invitation. Only one invitation for a user and course
- * may exist at a time. Delete and re-create an invitation to make changes.
- * This method returns the following error codes: * `PERMISSION_DENIED` if
- * the requesting user is not permitted to create invitations for this
- * course or for access errors. * `NOT_FOUND` if the course or the user does
- * not exist. * `FAILED_PRECONDITION` if the requested user's account is
- * disabled or if the user already has this role or a role with greater
- * permissions. * `ALREADY_EXISTS` if an invitation for the specified user
- * and course already exists.
+ * @desc Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.
* @alias classroom.invitations.create
* @memberOf! ()
*
@@ -5930,10 +5335,7 @@ export namespace classroom_v1 {
/**
* classroom.invitations.delete
- * @desc Deletes an invitation. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * delete the requested invitation or for access errors. * `NOT_FOUND` if no
- * invitation exists with the requested ID.
+ * @desc Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.
* @alias classroom.invitations.delete
* @memberOf! ()
*
@@ -6005,10 +5407,7 @@ export namespace classroom_v1 {
/**
* classroom.invitations.get
- * @desc Returns an invitation. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * view the requested invitation or for access errors. * `NOT_FOUND` if no
- * invitation exists with the requested ID.
+ * @desc Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.
* @alias classroom.invitations.get
* @memberOf! ()
*
@@ -6081,11 +5480,7 @@ export namespace classroom_v1 {
/**
* classroom.invitations.list
- * @desc Returns a list of invitations that the requesting user is permitted
- * to view, restricted to those that match the list request. *Note:* At
- * least one of `user_id` or `course_id` must be supplied. Both fields can
- * be supplied. This method returns the following error codes: *
- * `PERMISSION_DENIED` for access errors.
+ * @desc Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.
* @alias classroom.invitations.list
* @memberOf! ()
*
@@ -6213,26 +5608,19 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Restricts returned invitations to those for a course with the specified
- * identifier.
+ * Restricts returned invitations to those for a course with the specified identifier.
*/
courseId?: string;
/**
- * Maximum number of items to return. Zero means no maximum. The server may
- * return fewer than the specified number of results.
+ * Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
- * Restricts returned invitations to those for a specific user. The
- * identifier can be one of the following: * the numeric identifier for the
- * user * the email address of the user * the string literal `"me"`,
- * indicating the requesting user
+ * Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
@@ -6245,27 +5633,7 @@ export namespace classroom_v1 {
/**
* classroom.registrations.create
- * @desc Creates a `Registration`, causing Classroom to start sending
- * notifications from the provided `feed` to the destination provided in
- * `cloudPubSubTopic`. Returns the created `Registration`. Currently, this
- * will be the same as the argument, but with server-assigned fields such as
- * `expiry_time` and `id` filled in. Note that any value specified for the
- * `expiry_time` or `id` fields will be ignored. While Classroom may
- * validate the `cloudPubSubTopic` and return errors on a best effort basis,
- * it is the caller's responsibility to ensure that it exists and that
- * Classroom has permission to publish to it. This method may return the
- * following error codes: * `PERMISSION_DENIED` if: * the authenticated
- * user does not have permission to receive notifications from the
- * requested field; or * the credential provided does not include the
- * appropriate scope for the requested feed. * another access
- * error is encountered. * `INVALID_ARGUMENT` if: * no
- * `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is
- * not valid; or * no `feed` is specified, or the specified `feed` is
- * not valid. * `NOT_FOUND` if: * the specified `feed` cannot be
- * located, or the requesting user does not have permission to
- * determine whether or not it exists; or * the specified
- * `cloudPubsubTopic` cannot be located, or Classroom has not been
- * granted permission to publish to it.
+ * @desc Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the credential provided does not include the appropriate scope for the requested feed. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.
* @alias classroom.registrations.create
* @memberOf! ()
*
@@ -6336,8 +5704,7 @@ export namespace classroom_v1 {
/**
* classroom.registrations.delete
- * @desc Deletes a `Registration`, causing Classroom to stop sending
- * notifications for that `Registration`.
+ * @desc Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.
* @alias classroom.registrations.delete
* @memberOf! ()
*
@@ -6447,10 +5814,7 @@ export namespace classroom_v1 {
/**
* classroom.userProfiles.get
- * @desc Returns a user profile. This method returns the following error
- * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
- * access this user profile, if no profile exists with the requested ID, or
- * for access errors.
+ * @desc Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.
* @alias classroom.userProfiles.get
* @memberOf! ()
*
@@ -6529,9 +5893,7 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * Identifier of the profile to return. The identifier can be one of the
- * following: * the numeric identifier for the user * the email address of
- * the user * the string literal `"me"`, indicating the requesting user
+ * Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
@@ -6544,30 +5906,7 @@ export namespace classroom_v1 {
/**
* classroom.userProfiles.guardianInvitations.create
- * @desc Creates a guardian invitation, and sends an email to the guardian
- * asking them to confirm that they are the student's guardian. Once the
- * guardian accepts the invitation, their `state` will change to `COMPLETED`
- * and they will start receiving guardian notifications. A `Guardian`
- * resource will also be created to represent the active guardian. The
- * request object must have the `student_id` and `invited_email_address`
- * fields set. Failing to set these fields, or setting any other fields in
- * the request, will result in an error. This method returns the following
- * error codes: * `PERMISSION_DENIED` if the current user does not have
- * permission to manage guardians, if the guardian in question has already
- * rejected too many requests for that student, if guardians are not
- * enabled for the domain in question, or for other access errors. *
- * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian
- * link limit. * `INVALID_ARGUMENT` if the guardian email address is not
- * valid (for example, if it is too long), or if the format of the student
- * ID provided cannot be recognized (it is not an email address, nor a
- * `user_id` from this API). This error will also be returned if read-only
- * fields are set, or if the `state` field is set to to a value other than
- * `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student
- * ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if
- * there is already a pending guardian invitation for the student and
- * `invited_email_address` provided, or if the provided
- * `invited_email_address` matches the Google account of an existing
- * `Guardian` for this user.
+ * @desc Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.
* @alias classroom.userProfiles.guardianInvitations.create
* @memberOf! ()
*
@@ -6641,17 +5980,7 @@ export namespace classroom_v1 {
/**
* classroom.userProfiles.guardianInvitations.get
- * @desc Returns a specific guardian invitation. This method returns the
- * following error codes: * `PERMISSION_DENIED` if the requesting user is
- * not permitted to view guardian invitations for the student identified
- * by the `student_id`, if guardians are not enabled for the domain in
- * question, or for other access errors. * `INVALID_ARGUMENT` if a
- * `student_id` is specified, but its format cannot be recognized (it is
- * not an email address, nor a `student_id` from the API, nor the literal
- * string `me`). * `NOT_FOUND` if Classroom cannot find any record of the
- * given student or `invitation_id`. May also be returned if the student
- * exists, but the requesting user does not have access to see that
- * student.
+ * @desc Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.
* @alias classroom.userProfiles.guardianInvitations.get
* @memberOf! ()
*
@@ -6726,19 +6055,7 @@ export namespace classroom_v1 {
/**
* classroom.userProfiles.guardianInvitations.list
- * @desc Returns a list of guardian invitations that the requesting user is
- * permitted to view, filtered by the parameters provided. This method
- * returns the following error codes: * `PERMISSION_DENIED` if a
- * `student_id` is specified, and the requesting user is not permitted to
- * view guardian invitations for that student, if `"-"` is specified as
- * the `student_id` and the user is not a domain administrator, if
- * guardians are not enabled for the domain in question, or for other
- * access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but
- * its format cannot be recognized (it is not an email address, nor a
- * `student_id` from the API, nor the literal string `me`). May also be
- * returned if an invalid `page_token` or `state` is provided. *
- * `NOT_FOUND` if a `student_id` is specified, and its format can be
- * recognized, but Classroom has no record of that student.
+ * @desc Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.
* @alias classroom.userProfiles.guardianInvitations.list
* @memberOf! ()
*
@@ -6824,20 +6141,7 @@ export namespace classroom_v1 {
/**
* classroom.userProfiles.guardianInvitations.patch
- * @desc Modifies a guardian invitation. Currently, the only valid
- * modification is to change the `state` from `PENDING` to `COMPLETE`. This
- * has the effect of withdrawing the invitation. This method returns the
- * following error codes: * `PERMISSION_DENIED` if the current user does
- * not have permission to manage guardians, if guardians are not enabled
- * for the domain in question or for other access errors. *
- * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.
- * * `INVALID_ARGUMENT` if the format of the student ID provided cannot be
- * recognized (it is not an email address, nor a `user_id` from this API),
- * or if the passed `GuardianInvitation` has a `state` other than
- * `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if
- * the student ID provided is a valid student ID, but Classroom has no
- * record of that student, or if the `id` field does not refer to a
- * guardian invitation known to Classroom.
+ * @desc Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.
* @alias classroom.userProfiles.guardianInvitations.patch
* @memberOf! ()
*
@@ -6954,35 +6258,23 @@ export namespace classroom_v1 {
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
- * If specified, only results with the specified `invited_email_address`
- * will be returned.
+ * If specified, only results with the specified `invited_email_address` will be returned.
*/
invitedEmailAddress?: string;
/**
- * Maximum number of items to return. Zero or unspecified indicates that the
- * server may assign a maximum. The server may return fewer than the
- * specified number of results.
+ * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
- * nextPageToken value returned from a previous list call, indicating that
- * the subsequent page of results should be returned. The list request must
- * be otherwise identical to the one that resulted in this token.
+ * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
- * If specified, only results with the specified `state` values will be
- * returned. Otherwise, results with a `state` of `PENDING` will be
- * returned.
+ * If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.
*/
states?: string[];
/**
- * The ID of the student whose guardian invitations are to be returned. The
- * identifier can be one of the following: * the numeric identifier for the
- * user * the email address of the user * the string literal `"me"`,
- * indicating the requesting user * the string literal `"-"`, indicating
- * that results should be returned for all students that the requesting
- * user is permitted to view guardian invitations.
+ * The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.
*/
studentId?: string;
}
@@ -7002,11 +6294,7 @@ export namespace classroom_v1 {
*/
studentId?: string;
/**
- * Mask that identifies which fields on the course to update. This field is
- * required to do an update. The update will fail if invalid fields are
- * specified. The following fields are valid: * `state` When set in a
- * query parameter, this field should be specified as
- * `updateMask=,